Your AI team, working in Temporal

Cloud-native workflow orchestration platform for building reliable distributed applications

Start your company

What your team can do in Temporal

185 tools to work with, connected with an API key.

Add User Group Member

Add user to group. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Batch Cancel Workflows

Request cancellation of selected Temporal Workflows. Cancellation is cooperative: Workflow code can perform cleanup and external side effects before closing. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.

Batch Delete Workflows

WARNING: Permanently delete selected Temporal Workflow Executions and their Event Histories. This cannot be undone. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.

Batch Reset Workflows

WARNING: Irreversibly reset selected Temporal Workflows. Each successful reset terminates the current run and creates a new run; replay and reapplied events can repeat application code and external side effects. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.

Batch Signal Workflows

Send a named Signal to selected Temporal Workflows. Signal handlers run application code and can cause arbitrary, non-idempotent external side effects. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.

Batch Terminate Workflows

WARNING: Irreversibly terminate selected Temporal Workflows immediately; Workflow cleanup code does not run. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.

Batch Update Workflow Options

Update typed execution options on selected Temporal Workflows. Worker routing, task priority, and virtual-time changes can cause application and external side effects. Preview the exact Visibility query with COUNT_WORKFLOWS and obtain approval for the observed scope; its approximate count is not a hard upper bound because matches can change. Use explicit target_executions when a fixed cardinality bound is required. A stable job_id identifies this operation but does not make retries idempotently successful. After an ambiguous timeout, a retry may return 409 because Temporal rejects duplicate job IDs. Call DESCRIBE_BATCH_OPERATION with the same namespace_id and job_id to reconcile before creating any other batch operation. Requires Namespace Write access.

Cancel Activity Execution

Request cooperative cancellation of a standalone Temporal Activity Execution. The Activity must detect and acknowledge the request to reach CANCELED status. The cancellation signal is delivered through the heartbeat response and surfaced by the SDK. Omit run_id to target the latest run. Requires Namespace Write access.

Cancel Workflow

Irreversibly request cooperative cancellation of a running Temporal Workflow Execution. Temporal records a cancellation-requested event and schedules a Workflow Task, but the Workflow may delay or ignore cancellation depending on its code. A request for an already-closed Workflow succeeds. Requires Namespace Write access.

Count Activity ExecutionsReads only

Return an approximate count of Activity Executions matching an optional Temporal Visibility query in a Cloud Namespace, including supported grouped counts. Group results may be incomplete. Requires Namespace Read access.

Count Nexus Operation ExecutionsReads only

Return an approximate count of Nexus operation executions matching an optional Visibility query in a Temporal Cloud Namespace. GROUP BY returns approximate counts for a potentially incomplete list of groups. Requires the provider RBAC permission for this operation.

Count SchedulesReads only

Return an approximate count of Temporal Schedules matching a Schedule Visibility query, including grouped counts when requested. Requires Namespace Read access.

Count WorkersReads only

Count workers in a namespace. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Count WorkflowsReads only

Return an approximate count of Workflow Executions matching a Temporal Visibility query, including supported grouped counts. Requires Namespace Read access.

Create Account Audit Log Sink

Create audit log sink. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Create and Apply Workflow Rule

Create a Namespace-wide Temporal Workflow Rule and immediately start a batch job applying it to matching currently running Workflows. This may pause Activities across many executions and cause irreversible operational effects. Use request_id for idempotent retries. Requires Namespace Write access.

Create Billing Report

Create a billing report. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Create Cloud Nexus Endpoint

Create a Nexus endpoint. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Create Connectivity Rule

Create connectivity rule. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Create Custom Role

Create a custom role. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Create Export Sink

Create a persistent Temporal Cloud Workflow History export sink asynchronously. Requires Namespace Admin access. Warning: an enabled sink writes closed Workflow Histories to external storage on an ongoing schedule and may incur storage costs. Validate the destination first, use a disposable sink for testing, and arrange teardown.

Create Project

Create a project. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Create Schedule

Create a Temporal Schedule that starts a configured Workflow on cron, interval, calendar, or structured-calendar times. The Workflow may perform arbitrary application side effects. Use request_id for idempotent retries. Requires Namespace Write access.

Create Server Nexus Endpoint

Create a server Nexus endpoint. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Create Service Account

Create a service account. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Create User

Create a user. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Create User Group

Create a user group. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Create Worker Deployment

Experimental provider API; its contract may change. Creates a new Worker Deployment. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Create Worker Deployment Version

Experimental provider API; its contract may change. Creates a new Worker Deployment Version. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Create Workflow Rule

Create a Namespace-wide Temporal Workflow Rule that can pause matching Activities when its trigger occurs. This does not scan currently running Workflows; use Create and Apply Workflow Rule for that separate intent. Use request_id for idempotent retries. Requires Namespace Write access.

Delete Account Audit Log Sink

Delete audit log sink. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Delete Cloud Nexus Endpoint

Delete a Nexus endpoint. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Delete Connectivity Rule

Delete connectivity rule. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Delete Custom Role

Delete a custom role. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Delete Export Sink

Delete a Temporal Cloud Workflow History export sink asynchronously. Requires Namespace Admin access. WARNING: this irreversibly stops future exports from the sink. Files already exported to external storage remain there and must be managed separately. Confirm the Namespace, sink name, and current resource version before calling.

Delete Namespace

Permanently and irreversibly delete a Temporal Cloud Namespace and all of its Workflow data asynchronously. WARNING: there is no recovery or undo. Use only for a verified disposable Namespace after confirming its full ID, contents, latest resource version, and that deletion protection is disabled.

Delete Project

Delete a project. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Delete Schedule

Permanently delete one Temporal Schedule from a Namespace. WARNING: schedule deletion cannot be undone, but it does not terminate or otherwise affect Workflow Executions the Schedule already started. Confirm the Namespace and Schedule ID before calling. Requires Namespace Write access.

Delete Server Nexus Endpoint

Delete a server Nexus endpoint. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Delete Service Account

Delete a service account. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Delete User

Delete a user. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Delete User Group

Delete a user group. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Delete Worker Deployment

Delete an empty worker deployment. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Delete Worker Deployment Version

Delete an eligible worker deployment version. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Delete Workflow Rule

Permanently delete one configured Temporal Workflow Rule from a Namespace. WARNING: deletion cannot be undone; after deletion the rule no longer applies to new triggering events. Confirm the Namespace and rule ID before calling. Requires Namespace Write access.

Describe Activity ExecutionReads only

Describe a standalone Activity Execution in a Temporal Cloud Namespace. Returns status, timing, retry and worker details, and optionally input, outcome, heartbeats, and last failure. Omit long_poll_token for an immediate read, or pass a previous token with run_id to wait for a state change. This describes standalone Activities, not pending Activities inside Workflows. Requires Namespace Read access.

Describe Batch OperationReads only

Return progress, state, selection query, type, and failure counts for one batch operation in an authorized Temporal Cloud Namespace. Requires Namespace Read access.

Describe NamespaceReads only

Return one Temporal Cloud Namespace's configuration, resource version, routing endpoints, state, limits, and capacity. Requires Namespace Read access.

Describe Nexus Operation ExecutionReads only

Describe a standalone Nexus Operation Execution in a Temporal Cloud Namespace. Returns operation status, timing, retries, cancellation, and completion callbacks, and optionally input and terminal result or failure. Omit long_poll_token for an immediate read, or pass a previous token with run_id to wait for a state change. This describes standalone operations, not pending Nexus operations inside Workflows. Requires Namespace Read access.

Describe ScheduleReads only

Return the complete current definition, state, execution information, Memo, Search Attributes, and conflict token for one Temporal Schedule. Use this before a full replacement update to preserve intended fields and guard against concurrent changes. Requires Namespace Read access.

Describe Server NamespaceReads only

Describe server namespace configuration. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Describe Task QueueReads only

Describe task queue pollers, backlog and workflow reachability. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Describe WorkerReads only

Describe one worker instance. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Describe Worker DeploymentReads only

Describe a worker deployment. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Describe Worker Deployment VersionReads only

Describe a worker deployment version. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Describe WorkflowReads only

Return configuration, status, pending work, callbacks, and child state for one Workflow Execution in an authorized Temporal Cloud Namespace. Omit run_id to describe the current run. Requires Namespace Read access.

Describe Workflow RuleReads only

Return one configured Temporal Workflow Rule, including its trigger, Visibility query, actions, expiration, creation metadata, and description. Requires Namespace Read access.

Fail Over Namespace Region

Switch a multi-region Temporal Cloud Namespace's active region asynchronously. WARNING: This operation disrupts current Namespace routing while failover completes. Require explicit approval and a documented rollback or failback plan before calling it.

Fetch Worker Config

Fetch worker configuration. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Get AccountReads only

Get the Temporal Cloud account associated with the connected API key. Returns its ID, resource version, state, metrics endpoint, and account settings when populated. Takes no parameters; requires account read access.

Get Account Audit Log SinkReads only

Get audit log sink details. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Get Account Audit Log SinksReads only

List audit log sinks. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

Get Activity Execution OutcomeReads only

Get the outcome of a standalone Activity Execution in a Temporal Cloud Namespace. Long-polls until the activity completes and returns its serialized result or failure with retry state. Omit run_id to target the latest run. Payload bytes remain base64 encoded. For an immediate status read, use Describe Activity Execution instead. This targets standalone Activities, not pending Activities inside Workflows. Requires Namespace Read access.

Get Api KeyReads only

Get API key details. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Get Async OperationReads only

Return the current state and failure details of a Temporal Cloud asynchronous operation.

Get Audit LogsReads only

Get audit logs. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

Get Billing ReportReads only

Get a billing report. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Get Cloud Nexus EndpointReads only

Get Nexus endpoint details. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Get Cloud RegionReads only

Return details for one Temporal Cloud region, including its cloud provider, provider-specific identifier, and human-readable location.

Get Cluster InfoReads only

Return Temporal cluster information. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Get Connectivity RuleReads only

Get connectivity rule details. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Get Current IdentityReads only

Get the currently authenticated Temporal Cloud user or service account and its principal API-key metadata. Returns the principal's identity, resource version, state, and access assignments, plus the API key's owner, expiry, and disabled status. Takes no parameters.

Get Custom RoleReads only

Get custom role by ID. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Get Export SinkReads only

Return one Temporal Cloud Workflow History export sink, including its resource version, destination configuration, state, and health. Requires Namespace Read access.

Get Namespace CapacityReads only

Return a Temporal Cloud Namespace's capacity mode, available limits, and seven-day actions-per-second statistics. Requires Namespace Read access.

Get ProjectReads only

Get a project. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Get Server Nexus EndpointReads only

Get a server Nexus endpoint. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Get Service AccountReads only

Get service account details. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Get System InfoReads only

Get server system information. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Get UserReads only

Get user by ID. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Get User GroupReads only

Get user group details. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Get User Group MembersReads only

List users in a group. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

Get Workflow HistoryReads only

Return one page of a Temporal Workflow Execution's Event History in forward or reverse order. Requires Namespace Read access.

List Activity ExecutionsReads only

List one page of standalone Activity Executions in an authorized Temporal Cloud Namespace, optionally filtered by a Visibility query. Returns Activity IDs, run IDs, types, status, timing, and a continuation cursor. This lists standalone Activities, not pending Activities inside Workflow Executions. Requires Namespace Read access.

List Api KeysReads only

List all API keys. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

List Archived WorkflowsReads only

Return one page of archived Workflow Executions matching an exact Temporal Visibility query. Requires Namespace Read access and a Namespace deployment with archival visibility configured and available; the probed Namespace returned HTTP 403 even with inherited Namespace Admin access.

List Batch OperationsReads only

Return one page of batch operations in an authorized Temporal Cloud Namespace. Requires Namespace Read access.

List Cloud Nexus EndpointsReads only

List all Nexus endpoints. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

List Cloud RegionsReads only

List currently available Temporal Cloud regions for Namespace placement.

List Connectivity RulesReads only

List all connectivity rules. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

List Custom RolesReads only

List custom roles. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

List Export SinksReads only

Return one page of Workflow History export sinks configured on a Temporal Cloud Namespace. Requires Namespace Read access.

List Namespace AssignmentsReads only

Return one page of users, User Groups, or Service Accounts assigned to a Temporal Cloud Namespace. Requires Namespace Read access.

List NamespacesReads only

Return one page of Temporal Cloud Namespaces visible to the API-key identity, optionally filtered by name or Project.

List Nexus Operation ExecutionsReads only

List Nexus operation executions. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation. Returns one page; pass the returned next-page token unchanged to continue.

List Project Scoped Service AccountsReads only

List project-scoped service accounts. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

List ProjectsReads only

List all projects. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

List Schedule Matching TimesReads only

List times within a required start-to-end range that match one Temporal Schedule's timing specification. Requires Namespace Read access.

List SchedulesReads only

Return one filtered page of Temporal Schedules in an authorized Temporal Cloud Namespace. Requires Namespace Read access.

List Search AttributesReads only

List available search attributes. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

List Server NamespacesReads only

List server namespaces and configuration. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation. Returns one page; pass the returned next-page token unchanged to continue.

List Server Nexus EndpointsReads only

List server Nexus endpoints. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation. Returns one page; pass the returned next-page token unchanged to continue.

List Service Account Project AssignmentsReads only

List service accounts with access to a project. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

List Service AccountsReads only

List all service accounts. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

List User Group Project AssignmentsReads only

List user groups with access to a project. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

List User GroupsReads only

List all user groups. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

List User Project AssignmentsReads only

List users with access to a project. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

List UsersReads only

List all users. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission. Returns one page; pass the returned next-page token unchanged to continue.

List Worker DeploymentsReads only

List namespace worker deployments. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation. Returns one page; pass the returned next-page token unchanged to continue.

List WorkersReads only

List worker status information. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation. Returns one page; pass the returned next-page token unchanged to continue.

List Workflow RulesReads only

Return one page of Workflow Rules configured for an authorized Temporal Cloud Namespace. Requires Namespace Read access.

List WorkflowsReads only

Search one page of Workflow Executions in an authorized Temporal Cloud Namespace using Temporal Visibility query syntax. Requires Namespace Read access.

Move Namespace To Project

Move a Temporal Cloud Namespace to another Project asynchronously. WARNING: this disruptive operation can change inherited access and connectivity. Verify the source and destination Projects, preserve required connectivity rules, and obtain explicit approval before calling it.

Patch Schedule

Apply targeted changes to a Temporal Schedule without replacing its definition: pause or unpause it, trigger one immediate action, or backfill historical times. Immediate and backfill operations start application Workflows and may cause arbitrary external side effects. Use request_id for idempotent retries. Requires Namespace Write access.

Pause Activity

Pause pending activities selected by ID or type; docs announce future deprecation, not current retirement. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Pause Activity Execution

Pause a pending standalone or workflow Activity in a Temporal Cloud Namespace. Supply workflow_id to select a workflow Activity; omit it for a standalone Activity. Omit run_id to target the latest run. Pausing prevents rescheduling retries until unpaused; a running attempt can still complete successfully or finish with no retries left. Paused long-running Activities receive cancellation with activity_paused=true through heartbeat responses. Already-paused Activities are unchanged. Returns NotFound when no pending Activity matches. Requires Namespace Write access.

Pause Workflow

Pause one Temporal Workflow Execution. Temporal changes its status to PAUSED, records a WORKFLOW_EXECUTION_PAUSED event, stops dispatching new Workflow and Activity Tasks, pauses executing Activities, and rejects Queries and Updates; an executing Workflow Task may still complete and server-side events continue. This operational side effect can halt business processing. Always call UNPAUSE_WORKFLOW during teardown, even if a later step fails. Requires Namespace Write access. This Temporal API is experimental.

Poll Nexus Operation ExecutionReads only

Poll a Nexus operation for the requested completion stage. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Poll Workflow Execution Time SkippingReads only

Poll workflow execution time-skipping state. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Query WorkflowReads only

Run a synchronous, read-only Query handler against one Temporal Workflow Execution. The handler runs in Workflow context but cannot mutate Workflow state. Requires Namespace Read access.

Record Activity Task Heartbeat

Record worker activity task heartbeat by task token. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Record Activity Task Heartbeat By Id

Record an activity heartbeat by activity ID. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Record Worker Heartbeat

Record a worker heartbeat. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Register Namespace

Create a billable, persistent Temporal Cloud Namespace asynchronously, returning its full Namespace ID and operation information when provided. The name is immutable and custom Search Attributes cannot be deleted; use a unique disposable name for testing and arrange teardown only after creation completes.

Register Server Namespace

Register a server namespace. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Remove Namespace Access

Remove one user's, user group's, or service account's direct permission on a Temporal Cloud Namespace by setting PERMISSION_UNSPECIFIED. Requires Namespace Admin. WARNING: this can immediately remove access or lock out the selected identity; verify inherited access and never remove the caller's or sole administrator's access.

Remove User Group Member

Remove user from group. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Rename Custom Search Attribute

Rename one custom Search Attribute in a Temporal Cloud Namespace asynchronously. This is a potentially breaking schema mutation: Temporal does not rewrite application Visibility queries or dashboards that reference the old name. Verify all consumers and use the latest Namespace resource version before starting the rename.

Replace Workflow

Replace a running Workflow Execution with a new execution using the same Workflow ID. WARNING: if that ID is running, Temporal irreversibly terminates the existing execution before starting the replacement. This may interrupt in-flight work, and the new Workflow may cause arbitrary external side effects. Use only when termination is explicitly intended, and use request_id for idempotent retries. Requires Namespace Write access.

Request Cancel Nexus Operation Execution

Request cancellation of a Nexus operation. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Reset Activity

Reset pending activities selected by ID or type. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Reset Activity Execution

Reset a pending standalone or workflow Activity in a Temporal Cloud Namespace. Supply workflow_id for a workflow Activity; omit it for a standalone Activity. Omit run_id to target the latest run. Resets the attempt counter to zero and Activity timeouts. Activities waiting for retry can be scheduled immediately or with jitter; keep_paused preserves a paused Activity's pause. Optionally restore original options or discard persisted heartbeat details. Returns NotFound if no pending Activity matches. Requires Namespace Write access.

Reset Workflow

WARNING: Irreversibly reset a Temporal Workflow to a selected Workflow Task event. Temporal terminates the current run and creates a new run; replay and reapplied events can repeat application code and external side effects. Verify the source run, event ID, and reapply policy before calling.

Respond Activity Task Canceled

Record worker activity task cancellation by task token. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Respond Activity Task Canceled By Id

Record activity cancellation by activity ID. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Respond Activity Task Completed

Record worker activity task completion by task token. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Respond Activity Task Completed By Id

Complete an activity by activity ID. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Respond Activity Task Failed

Record worker activity task failure by task token. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Respond Activity Task Failed By Id

Record an activity failure by activity ID. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Set Namespace Access

Set one user's, user group's, or service account's direct ADMIN, WRITE, or READ permission on a Temporal Cloud Namespace. The new permission replaces that principal's current direct access; setting a lower permission may lock out the caller or the Namespace's sole admin. Requires Namespace Admin.

Set Service Account Project Access

Set service account project access. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Set User Group Project Access

Set user group project access. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Set User Project Access

Set user project access. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Set Worker Deployment Current Version

Set or unset the current worker deployment version. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Set Worker Deployment Manager

Experimental provider API; its contract may change. Set/unset the ManagerIdentity of a Worker Deployment. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Set Worker Deployment Ramping Version

Set a ramping worker version and traffic percentage. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Signal With Start Workflow

Atomically signal a running Temporal Workflow or start and signal it when absent. This may run application code and trigger external side effects; use a stable request_id when retrying the same intent. The TERMINATE_EXISTING conflict policy and deprecated TERMINATE_IF_RUNNING reuse policy can terminate a running execution before starting and signaling its replacement.

Signal Workflow

Send an asynchronous Signal to one running Temporal Workflow Execution. This records a history event, schedules Workflow code, and may trigger arbitrary external business side effects. Temporal's successful response only confirms acceptance, not handler completion. Use request_id to make retries idempotent. Requires Namespace Write access.

Start Activity Execution

Start a standalone Activity Execution in a Temporal Cloud Namespace. Requires Namespace Write access and a worker registered for the activity type on the specified task queue to execute it. Dispatches application code that may cause external side effects. Returns the run ID and whether a new execution was started; USE_EXISTING can return an already-running execution. Use request_id for idempotent retries. Nested inputs use documented protobuf JSON field names.

Start Nexus Operation Execution

Start a standalone Nexus operation in a Temporal Cloud Namespace. Requires Namespace Write access, a registered Nexus Endpoint, and a handler for the named service and operation. Dispatches handler code that may cause external side effects. Returns runId and started, not the operation result; USE_EXISTING may return an already-running operation. Reuse request_id for retries. Nested inputs use documented protobuf JSON field names.

Start or Get Workflow

Start a Workflow Execution, or return the already-running execution when the Workflow ID conflicts. This action never replaces the running execution. The response has started=false when it returns the existing execution. Starting a Workflow dispatches application code and may cause arbitrary external side effects. Use request_id for idempotent retries. Requires Namespace Write access.

Start Workflow

Start a new Workflow Execution in an authorized Temporal Cloud Namespace. The request fails if the Workflow ID is already running; use Start or Get Workflow or Replace Workflow only when those different conflict semantics are intended. This dispatches application code and may cause arbitrary external side effects. Use request_id for idempotent retries. Requires Namespace Write access.

Stop Batch Operation

Request that Temporal stop an in-progress batch operation. This does not roll back Workflows already processed by the batch: their cancellations, terminations, signals, deletions, resets, or option changes remain in effect. Requires Namespace Write access.

Terminate Activity Execution

Immediately and irreversibly terminate an existing standalone Temporal Activity Execution. Termination does not reach the worker and Activity code cannot react to it; a terminated Activity may still have a running attempt. Use cooperative cancellation when the worker should react. Omit run_id to target the latest run. Requires Namespace Write access. Returns an empty object on success.

Terminate Nexus Operation Execution

Terminate a Nexus operation execution. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Terminate Workflow

Immediately and irreversibly terminate one Temporal Workflow Execution. WARNING: termination bypasses cooperative cancellation and Workflow cleanup logic, so finally blocks, compensation, and pending work may not run. Use cancellation instead when the Workflow can clean up safely. Requires Namespace Write access.

Trigger Workflow Rule

Trigger an existing configured Temporal Workflow Rule against one Workflow Execution. This irreversible request evaluates the rule and, when its conditions match, may run configured actions with destructive or arbitrary external side effects. Verify the Workflow and rule before calling; do not test against production or an unknown rule. A successful request can return applied=false when the rule conditions do not match. Requires Namespace Write access.

Unpause Activity

Resume pending activities selected by ID or type. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Unpause Activity Execution

Unpause a pending Temporal workflow or standalone Activity by ID. Supply workflow_id for a workflow Activity; omit it for a standalone Activity. This is the same operation as the workflow-scoped unpause route. An already unpaused Activity is unchanged. An Activity paused while awaiting retry is scheduled immediately, or within jitter when supplied. All timeout timers are regenerated. Omit run_id to target the latest run. Returns an empty object on success and NotFound if no pending Activity matches. Requires Namespace Write access.

Unpause Workflow

Resume a paused Temporal Workflow Execution. Unpausing changes its status to running, records an unpaused history event, and resumes application code in Workflow and Activity Tasks, which may produce external side effects. Use request_id for idempotent retries. This Temporal API is experimental and requires Namespace Write access.

Update Account

Update account details. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Update Account Audit Log Sink

Update audit log sink. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Update Activity Execution Options

Update options of one standalone or workflow Activity Execution by Activity ID in a Temporal Cloud Namespace. Supply workflow_id to target a workflow Activity; omit it for a standalone Activity. Omit run_id for the latest run. Use activity_options with a protobuf JSON update_mask for partial updates, or restore_original=true alone to restore the options from the first schedule event. Returns the options after the update. Requires Namespace Write access. This targets one Activity, not the deprecated bulk UpdateActivityOptions operation.

Update Activity Options

Update pending activity options by ID or type. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Update Cloud Nexus Endpoint

Update a Nexus endpoint. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Update Custom Role

Update a custom role. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Update Export Sink

Update an existing Temporal Cloud Workflow History export sink asynchronously using optimistic concurrency. WARNING: this replaces the sink's destination configuration or enabled state for future exports and may redirect or stop Workflow History delivery; already exported files are not moved or undone. Confirm the complete current specification, destination, and resourceVersion before calling.

Update Namespace

Update a Temporal Cloud Namespace specification asynchronously using the latest resource version for optimistic concurrency. WARNING: this full-spec replacement can change retention, regions, capacity, authentication, deletion protection, and high-availability behavior; newly added custom Search Attributes cannot be deleted. Preserve every unchanged field and verify API-key access and deletion protection before calling. Requires Namespace Admin access.

Update Namespace Tags

Upsert or permanently remove tags on a Temporal Cloud Namespace asynchronously; removed tags no longer exist on the Namespace. At least one of tags_to_upsert or tags_to_remove must be non-empty, and the same key cannot appear in both. The API-key owner must be a Global Admin or Account Owner; Namespace Admin access alone is insufficient.

Update Project

Update a project. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Update Schedule

Fully replace an existing Temporal Schedule's spec, Workflow-start action, policies, and state. Omitted values in those structures are not preserved; supply the complete desired replacement configuration. The replacement can change when application Workflows run and may cause irreversible external side effects. Supply conflict_token to reject a stale update. Requires Namespace Write access.

Update Server Namespace

Update server namespace configuration. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Update Server Nexus Endpoint

Update a server Nexus endpoint optimistically. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Update Service Account

Update a service account. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Update Task Queue Config

Update task queue configuration. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Update User

Update a user. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Update User Group

Update a user group. Manages Temporal Cloud account resources; requires the corresponding account or resource RBAC permission.

Update Worker Config

Update worker configuration. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Update Worker Deployment Version Compute Config

Experimental provider API; its contract may change. Updates the compute config attached to a Worker Deployment Version. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Update Worker Deployment Version Metadata

Update worker deployment version metadata. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

Update Workflow

Send a durable Update to one Temporal Workflow Execution and wait for the requested lifecycle stage. The Workflow handler may mutate state and cause arbitrary external business side effects. Reuse update_id only when retrying the same intended Update. An admitted or accepted response can omit outcome; the returned update_ref identifies the still-running Update. Requires Namespace Write access.

Update Workflow Options

Update selected options on one Temporal Workflow Execution using an exact protobuf FieldMask. This mutation can reroute Workflow Tasks to different Workers, change task priority, or alter virtual-time behavior and thereby cause application side effects. Use only on an intended execution, capture the prior options, and restore them when testing. Requires Namespace Write access.

Validate Account Audit Log Sink

Validate an owned Kinesis or GCP Pub/Sub audit-log destination by delivering a test record. Requires the destination and its Temporal cross-account access policy to be configured; this does not create an audit sink.

Validate Export SinkReads only

Validate a Temporal Cloud Workflow History export sink configuration. WARNING: this is not read-only; Temporal writes an empty test object to the configured external bucket or container. Use only an owner-approved disposable bucket or container.

Validate Worker Deployment Version Compute ConfigReads only

Experimental provider API; its contract may change. Validates the compute config without attaching it to a Worker Deployment Version. Targets the selected Temporal Cloud Namespace; requires the provider RBAC permission for this operation.

More in Developer tools

See them all β†’

Your company, run by an AI team

Start your company

BRAINER

Continue to B.R.A.I.N.E.R.

Continue with Google or your email.

or