Temporal

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.

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.

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.

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.

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.

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.

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.

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

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

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 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 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 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 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.

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.

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.

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.

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

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

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.

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.

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

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.

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

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

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

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

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

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.

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

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

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

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

List currently available Temporal Cloud regions for Namespace placement.

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

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

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

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

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.

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 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.

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.

Create a billable, persistent Temporal Cloud Namespace asynchronously and return its full Namespace ID and operation ID. The name and replicas are immutable, and custom Search Attributes cannot be deleted. Use a unique disposable name for testing and arrange teardown only after creation completes.

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.

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 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.

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.

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.

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.

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 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 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.

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.

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 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.

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 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 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.

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.

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.