Temporal

endpoints from Temporal

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

endpoints from Temporal

Endpoints 228

OperatorService

  • GETListSearchAttributes/api/v1/namespaces/:namespace/search-attributesListSearchAttributes returns comprehensive information about search attributes.
  • GETListNexusEndpoints/api/v1/nexus/endpoints?pageSize=0&nextPageToken=string&name=stringList all Nexus endpoints for the cluster, sorted by ID in ascending order. Set page_token in the request to the next_page_token field of the previous response…
  • POSTCreateNexusEndpoint/api/v1/nexus/endpointsCreate a Nexus endpoint. This will fail if an endpoint with the same name is already registered with a status of ALREADY_EXISTS. Returns the created endpoint…
  • GETGetNexusEndpoint/api/v1/nexus/endpoints/:idGet a registered Nexus endpoint by ID. The returned version can be used for optimistic updates.
  • DELETEDeleteNexusEndpoint/api/v1/nexus/endpoints/:id?version=stringDelete an incoming Nexus service by ID.
  • POSTUpdateNexusEndpoint/api/v1/nexus/endpoints/:id/updateOptimistically update a Nexus endpoint based on provided version as obtained via the GetNexusEndpoint or ListNexusEndpointResponse APIs. This will fail with a…
  • GETListSearchAttributes/cluster/namespaces/:namespace/search-attributesListSearchAttributes returns comprehensive information about search attributes.
  • GETListNexusEndpoints/cluster/nexus/endpoints?pageSize=0&nextPageToken=string&name=stringList all Nexus endpoints for the cluster, sorted by ID in ascending order. Set page_token in the request to the next_page_token field of the previous response…
  • POSTCreateNexusEndpoint/cluster/nexus/endpointsCreate a Nexus endpoint. This will fail if an endpoint with the same name is already registered with a status of ALREADY_EXISTS. Returns the created endpoint…
  • GETGetNexusEndpoint/cluster/nexus/endpoints/:idGet a registered Nexus endpoint by ID. The returned version can be used for optimistic updates.
  • DELETEDeleteNexusEndpoint/cluster/nexus/endpoints/:id?version=stringDelete an incoming Nexus service by ID.
  • POSTUpdateNexusEndpoint/cluster/nexus/endpoints/:id/updateOptimistically update a Nexus endpoint based on provided version as obtained via the GetNexusEndpoint or ListNexusEndpointResponse APIs. This will fail with a…

WorkflowService

  • GETGetClusterInfo/api/v1/cluster-infoGetClusterInfo returns information about temporal cluster
  • GETListNamespaces/api/v1/namespaces?pageSize=0&nextPageToken=string&namespaceFilter.includeDeleted=trueListNamespaces returns the information and configuration for all namespaces.
  • POSTRegisterNamespace/api/v1/namespacesRegisterNamespace creates a new namespace which can be used as a container for all resources. A Namespace is a top level entity within Temporal, and is used…
  • GETDescribeNamespace/api/v1/namespaces/:namespace?id=string&weakConsistency=trueDescribeNamespace returns the information and configuration for a registered namespace.
  • GETListActivityExecutions/api/v1/namespaces/:namespace/activities?pageSize=0&nextPageToken=string&query=stringListActivityExecutions is a visibility API to list activity executions in a specific namespace.
  • POSTPauseActivity/api/v1/namespaces/:namespace/activities-deprecated/pausePauseActivity pauses the execution of an activity specified by its ID or type. If there are multiple pending activities of the provided type - all of them…
  • POSTResetActivity/api/v1/namespaces/:namespace/activities-deprecated/resetResetActivity resets the execution of an activity specified by its ID or type. If there are multiple pending activities of the provided type - all of them…
  • POSTUnpauseActivity/api/v1/namespaces/:namespace/activities-deprecated/unpauseUnpauseActivity unpauses the execution of an activity specified by its ID or type. If there are multiple pending activities of the provided type - all of them…
  • POSTUpdateActivityOptions/api/v1/namespaces/:namespace/activities-deprecated/update-optionsUpdateActivityOptions is called by the client to update the options of an activity by its ID or type. If there are multiple pending activities of the provided…
  • GETDescribeActivityExecution/api/v1/namespaces/:namespace/activities/:activityId?runId=string&includeInput=true&includeOutcome=true&longPollToken=string&includeHeartbeatDetails=true&includeLastFailure=trueDescribeActivityExecution returns information about an activity execution. It can be used to: Get current activity info without waiting Long-poll for next…
  • POSTStartActivityExecution/api/v1/namespaces/:namespace/activities/:activityIdStartActivityExecution starts a new activity execution. Returns an ActivityExecutionAlreadyStarted error if an instance already exists with same activity ID…
  • POSTRequestCancelActivityExecution/api/v1/namespaces/:namespace/activities/:activityId/cancelRequestCancelActivityExecution requests cancellation of an activity execution. Cancellation is cooperative: this call records the request, but the activity…
  • POSTRespondActivityTaskCompletedById/api/v1/namespaces/:namespace/activities/:activityId/completeSee RespondActivityTaskCompleted. This version allows clients to record completions by namespace/workflow id/activity id instead of task token. (--…
  • POSTRespondActivityTaskFailedById/api/v1/namespaces/:namespace/activities/:activityId/failSee RecordActivityTaskFailed. This version allows clients to record failures by namespace/workflow id/activity id instead of task token. (-- api-linter:…
  • POSTRecordActivityTaskHeartbeatById/api/v1/namespaces/:namespace/activities/:activityId/heartbeatSee RecordActivityTaskHeartbeat. This version allows clients to record heartbeats by namespace/workflow id/activity id instead of task token. (-- api-linter:…
  • GETPollActivityExecution/api/v1/namespaces/:namespace/activities/:activityId/outcome?runId=stringPollActivityExecution long-polls for an activity execution to complete and returns the outcome (result or failure).
  • POSTPauseActivityExecution/api/v1/namespaces/:namespace/activities/:activityId/pausePauseActivityExecution pauses the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity…
  • POSTResetActivityExecution/api/v1/namespaces/:namespace/activities/:activityId/resetResetActivityExecution resets the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity.…
  • POSTRespondActivityTaskCanceledById/api/v1/namespaces/:namespace/activities/:activityId/resolve-as-canceledSee RespondActivityTaskCanceled. This version allows clients to record failures by namespace/workflow id/activity id instead of task token. (-- api-linter:…
  • POSTTerminateActivityExecution/api/v1/namespaces/:namespace/activities/:activityId/terminateTerminateActivityExecution terminates an existing activity execution immediately. Termination does not reach the worker and the activity code cannot react to…
  • POSTUnpauseActivityExecution/api/v1/namespaces/:namespace/activities/:activityId/unpauseUnpauseActivityExecution unpauses the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone…
  • POSTUpdateActivityExecutionOptions/api/v1/namespaces/:namespace/activities/:activityId/update-optionsUpdateActivityExecutionOptions is called by the client to update the options of an activity by its ID. This API can be used to target a workflow activity or a…
  • POSTRespondActivityTaskCompleted/api/v1/namespaces/:namespace/activity-completeRespondActivityTaskCompleted is called by workers when they successfully complete an activity task. For workflow activities, this results in a new…
  • GETCountActivityExecutions/api/v1/namespaces/:namespace/activity-count?query=stringCountActivityExecutions is a visibility API to count activity executions in a specific namespace.
  • POSTRespondActivityTaskFailed/api/v1/namespaces/:namespace/activity-failRespondActivityTaskFailed is called by workers when processing an activity task fails. This results in a new ACTIVITY_TASK_FAILED event being written to the…
  • POSTRecordActivityTaskHeartbeat/api/v1/namespaces/:namespace/activity-heartbeatRecordActivityTaskHeartbeat is optionally called by workers while they execute activities. If a worker fails to heartbeat within the heartbeat_timeout…
  • POSTRespondActivityTaskCanceled/api/v1/namespaces/:namespace/activity-resolve-as-canceledRespondActivityTaskFailed is called by workers when processing an activity task fails. For workflow activities, this results in a new ACTIVITY_TASK_CANCELED…
  • GETListArchivedWorkflowExecutions/api/v1/namespaces/:namespace/archived-workflows?pageSize=0&nextPageToken=string&query=stringListArchivedWorkflowExecutions is a visibility API to list archived workflow executions in a specific namespace.
  • GETListBatchOperations/api/v1/namespaces/:namespace/batch-operations?pageSize=0&nextPageToken=stringListBatchOperations returns a list of batch operations
  • GETDescribeBatchOperation/api/v1/namespaces/:namespace/batch-operations/:jobIdDescribeBatchOperation returns the information about a batch operation
  • POSTStartBatchOperation/api/v1/namespaces/:namespace/batch-operations/:jobIdStartBatchOperation starts a new batch operation
  • POSTStopBatchOperation/api/v1/namespaces/:namespace/batch-operations/:jobId/stopStopBatchOperation stops a batch operation
  • POSTSetCurrentDeployment/api/v1/namespaces/:namespace/current-deployment/:deployment.series_nameSets a deployment as the current deployment for its deployment series. Can optionally update the metadata of the deployment as well. Deprecated. Replaced by…
  • GETGetCurrentDeployment/api/v1/namespaces/:namespace/current-deployment/:seriesNameReturns the current deployment (and its info) for a given deployment series. Deprecated. Replaced by current_version returned by DescribeWorkerDeployment.
  • GETListDeployments/api/v1/namespaces/:namespace/deployments?pageSize=0&nextPageToken=string&seriesName=stringLists worker deployments in the namespace. Optionally can filter based on deployment series name. Deprecated. Replaced with ListWorkerDeployments.
  • GETDescribeDeployment/api/v1/namespaces/:namespace/deployments/:deployment.series_name/:deployment.build_id?deployment.seriesName=string&deployment.buildId=stringDescribes a worker deployment. Deprecated. Replaced with DescribeWorkerDeploymentVersion.
  • GETGetDeploymentReachability/api/v1/namespaces/:namespace/deployments/:deployment.series_name/:deployment.build_id/reachability?deployment.seriesName=string&deployment.buildId=stringReturns the reachability level of a worker deployment to help users decide when it is time to decommission a deployment. Reachability level is calculated…
  • GETCountNexusOperationExecutions/api/v1/namespaces/:namespace/nexus-operation-count?query=stringCountNexusOperationExecutions is a visibility API to count Nexus operations in a specific namespace.
  • GETListNexusOperationExecutions/api/v1/namespaces/:namespace/nexus-operations?pageSize=0&nextPageToken=string&query=stringListNexusOperationExecutions is a visibility API to list Nexus operations in a specific namespace.
  • GETDescribeNexusOperationExecution/api/v1/namespaces/:namespace/nexus-operations/:operationId?runId=string&includeInput=true&includeOutcome=true&longPollToken=stringDescribeNexusOperationExecution returns information about a Nexus operation. Supported use cases include: Get current operation info without waiting Long-poll…
  • POSTStartNexusOperationExecution/api/v1/namespaces/:namespace/nexus-operations/:operationIdStartNexusOperationExecution starts a new Nexus operation. Returns a NexusOperationExecutionAlreadyStarted error if an instance already exists with same…
  • POSTRequestCancelNexusOperationExecution/api/v1/namespaces/:namespace/nexus-operations/:operationId/cancelRequestCancelNexusOperationExecution requests cancellation of a Nexus operation. Requesting to cancel an operation does not automatically transition the…
  • GETPollNexusOperationExecution/api/v1/namespaces/:namespace/nexus-operations/:operationId/poll?runId=string&waitStage=NEXUS_OPERATION_WAIT_STAGE_UNSPECIFIEDPollNexusOperationExecution long-polls for a Nexus operation for a given wait stage to complete and returns the outcome (result or failure).
  • POSTTerminateNexusOperationExecution/api/v1/namespaces/:namespace/nexus-operations/:operationId/terminateTerminateNexusOperationExecution terminates an existing Nexus operation immediately. Termination happens immediately and the operation handler cannot react to…
  • GETCountSchedules/api/v1/namespaces/:namespace/schedule-count?query=stringCountSchedules is a visibility API to count schedules in a specific namespace.
  • GETListSchedules/api/v1/namespaces/:namespace/schedules?maximumPageSize=0&nextPageToken=string&query=stringList all schedules in a namespace.
  • GETDescribeSchedule/api/v1/namespaces/:namespace/schedules/:scheduleIdReturns the schedule description and current state of an existing schedule.
  • POSTCreateSchedule/api/v1/namespaces/:namespace/schedules/:scheduleIdCreates a new schedule.
  • DELETEDeleteSchedule/api/v1/namespaces/:namespace/schedules/:scheduleId?identity=stringDeletes a schedule, removing it from the system.
  • GETListScheduleMatchingTimes/api/v1/namespaces/:namespace/schedules/:scheduleId/matching-times?startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZLists matching times within a range.
  • POSTPatchSchedule/api/v1/namespaces/:namespace/schedules/:scheduleId/patchMakes a specific change to a schedule or triggers an immediate action.
  • POSTUpdateSchedule/api/v1/namespaces/:namespace/schedules/:scheduleId/updateChanges the configuration or state of an existing schedule.
  • POSTUpdateTaskQueueConfig/api/v1/namespaces/:namespace/task-queues/:taskQueue/update-configUpdates task queue configuration. For the overall queue rate limit: the rate limit set by this api overrides the worker-set rate limit, which uncouples the…
  • GETGetWorkerBuildIdCompatibility/api/v1/namespaces/:namespace/task-queues/:taskQueue/worker-build-id-compatibility?maxSets=0Deprecated. Use GetWorkerVersioningRules. Will be removed in server version v1.32.0. Fetches the worker build id versioning sets for a task queue.
  • GETGetWorkerVersioningRules/api/v1/namespaces/:namespace/task-queues/:taskQueue/worker-versioning-rulesFetches the Build ID assignment and redirect rules for a Task Queue. Will be removed in server version v1.32.0.
  • GETDescribeTaskQueue/api/v1/namespaces/:namespace/task-queues/:task_queue.name?taskQueue.name=string&taskQueue.kind=TASK_QUEUE_KIND_UNSPECIFIED&taskQueue.normalName=string&taskQueueType=TASK_QUEUE_TYPE_UNSPECIFIED&reportStats=true&reportConfig=true&includeTaskQueueStatus=true&apiMode=DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED&versions.buildIds=string&versions.unversioned=true&versions.allActive=true&taskQueueTypes=TASK_QUEUE_TYPE_UNSPECIFIED&reportPollers=true&reportTaskReachability=trueDescribeTaskQueue returns the following information about the target task queue, broken down by Build ID: List of pollers Workflow Reachability status Backlog…
  • POSTUpdateNamespace/api/v1/namespaces/:namespace/updateUpdateNamespace is used to update the information and configuration of a registered namespace.
  • GETCountWorkers/api/v1/namespaces/:namespace/worker-count?query=string&includeSystemWorkers=trueCountWorkers counts the number of workers in a specific namespace.
  • POSTCreateWorkerDeploymentVersion/api/v1/namespaces/:namespace/worker-deployment-versions/:deployment_version.deployment_nameCreates a new Worker Deployment Version. Experimental. This API might significantly change or be removed in a future release.
  • GETDescribeWorkerDeploymentVersion/api/v1/namespaces/:namespace/worker-deployment-versions/:deployment_version.deployment_name/:deployment_version.build_id?version=string&deploymentVersion.buildId=string&deploymentVersion.deploymentName=string&reportTaskQueueStats=trueDescribes a worker deployment version.
  • DELETEDeleteWorkerDeploymentVersion/api/v1/namespaces/:namespace/worker-deployment-versions/:deployment_version.deployment_name/:deployment_version.build_id?version=string&deploymentVersion.buildId=string&deploymentVersion.deploymentName=string&skipDrainage=true&identity=stringUsed for manual deletion of Versions. User can delete a Version only when all the following conditions are met: It is not the Current or Ramping Version of…
  • POSTUpdateWorkerDeploymentVersionComputeConfig/api/v1/namespaces/:namespace/worker-deployment-versions/:deployment_version.deployment_name/:deployment_version.build_id/update-compute-configUpdates the compute config attached to a Worker Deployment Version. Experimental. This API might significantly change or be removed in a future release.
  • POSTUpdateWorkerDeploymentVersionMetadata/api/v1/namespaces/:namespace/worker-deployment-versions/:deployment_version.deployment_name/:deployment_version.build_id/update-metadataUpdates the user-given metadata attached to a Worker Deployment Version.
  • POSTValidateWorkerDeploymentVersionComputeConfig/api/v1/namespaces/:namespace/worker-deployment-versions/:deployment_version.deployment_name/:deployment_version.build_id/validate-compute-configValidates the compute config without attaching it to a Worker Deployment Version. Experimental. This API might significantly change or be removed in a future…
  • GETListWorkerDeployments/api/v1/namespaces/:namespace/worker-deployments?pageSize=0&nextPageToken=stringLists all Worker Deployments that are tracked in the Namespace.
  • GETDescribeWorkerDeployment/api/v1/namespaces/:namespace/worker-deployments/:deploymentNameDescribes a Worker Deployment.
  • POSTCreateWorkerDeployment/api/v1/namespaces/:namespace/worker-deployments/:deploymentNameCreates a new Worker Deployment. Experimental. This API might significantly change or be removed in a future release.
  • DELETEDeleteWorkerDeployment/api/v1/namespaces/:namespace/worker-deployments/:deploymentName?identity=stringDeletes records of (an old) Deployment. A deployment can only be deleted if it has no Version in it.
  • POSTSetWorkerDeploymentCurrentVersion/api/v1/namespaces/:namespace/worker-deployments/:deploymentName/set-current-versionSet/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping Version if it is the Version being set as Current.
  • POSTSetWorkerDeploymentManager/api/v1/namespaces/:namespace/worker-deployments/:deploymentName/set-managerSet/unset the ManagerIdentity of a Worker Deployment. Experimental. This API might significantly change or be removed in a future release.
  • POSTSetWorkerDeploymentRampingVersion/api/v1/namespaces/:namespace/worker-deployments/:deploymentName/set-ramping-versionSet/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for gradual ramp to unversioned workers too.
  • GETGetWorkerTaskReachability/api/v1/namespaces/:namespace/worker-task-reachability?buildIds=string&taskQueues=string&reachability=TASK_REACHABILITY_UNSPECIFIEDDeprecated. Use DescribeTaskQueue. Will be removed in server version v1.32.0. Fetches task reachability to determine whether a worker may be retired. The…
  • GETListWorkers/api/v1/namespaces/:namespace/workers?pageSize=0&nextPageToken=string&query=string&includeSystemWorkers=trueListWorkers is a visibility API to list worker status information in a specific namespace.
  • GETDescribeWorker/api/v1/namespaces/:namespace/workers/describe/:workerInstanceKeyDescribeWorker returns information about the specified worker.
  • POSTFetchWorkerConfig/api/v1/namespaces/:namespace/workers/fetch-configFetchWorkerConfig returns the worker configuration for a specific worker.
  • POSTRecordWorkerHeartbeat/api/v1/namespaces/:namespace/workers/heartbeatWorkerHeartbeat receive heartbeat request from the worker.
  • POSTUpdateWorkerConfig/api/v1/namespaces/:namespace/workers/update-configUpdateWorkerConfig updates the worker configuration of one or more workers. Can be used to partially update the worker configuration. Can be used to update…
  • GETCountWorkflowExecutions/api/v1/namespaces/:namespace/workflow-count?query=stringCountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.
  • GETListWorkflowRules/api/v1/namespaces/:namespace/workflow-rules?nextPageToken=stringReturn all namespace workflow rules
  • POSTCreateWorkflowRule/api/v1/namespaces/:namespace/workflow-rulesCreate a new workflow rule. The rules are used to control the workflow execution. The rule will be applied to all running and new workflows in the namespace.…
  • GETDescribeWorkflowRule/api/v1/namespaces/:namespace/workflow-rules/:ruleIdDescribeWorkflowRule return the rule specification for existing rule id. If there is no rule with such id - NOT FOUND error will be returned.
  • DELETEDeleteWorkflowRule/api/v1/namespaces/:namespace/workflow-rules/:ruleIdDelete rule by rule id
  • GETListWorkflowExecutions/api/v1/namespaces/:namespace/workflows?pageSize=0&nextPageToken=string&query=stringListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.
  • GETDescribeWorkflowExecution/api/v1/namespaces/:namespace/workflows/:execution.workflow_id?execution.workflowId=string&execution.runId=stringDescribeWorkflowExecution returns information about the specified workflow execution.
  • GETGetWorkflowExecutionHistory/api/v1/namespaces/:namespace/workflows/:execution.workflow_id/history?execution.workflowId=string&execution.runId=string&maximumPageSize=0&nextPageToken=string&waitNewEvent=true&historyEventFilterType=HISTORY_EVENT_FILTER_TYPE_UNSPECIFIED&skipArchival=trueGetWorkflowExecutionHistory returns the history of specified workflow execution. Fails with NotFound if the specified workflow execution is unknown to the…
  • GETGetWorkflowExecutionHistoryReverse/api/v1/namespaces/:namespace/workflows/:execution.workflow_id/history-reverse?execution.workflowId=string&execution.runId=string&maximumPageSize=0&nextPageToken=stringGetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse order (starting from last event). Fails withNotFound if the…
  • POSTQueryWorkflow/api/v1/namespaces/:namespace/workflows/:execution.workflow_id/query/:query.query_typeQueryWorkflow requests a query be executed for a specified workflow execution.
  • POSTTriggerWorkflowRule/api/v1/namespaces/:namespace/workflows/:execution.workflow_id/trigger-ruleTriggerWorkflowRule allows to: * trigger existing rule for a specific workflow execution; * trigger rule for a specific workflow execution without creating a…
  • POSTStartWorkflowExecution/api/v1/namespaces/:namespace/workflows/:workflowIdStartWorkflowExecution starts a new workflow execution. It will create the execution with a WORKFLOW_EXECUTION_STARTED event in its history and also schedule…
  • POSTRespondActivityTaskCompletedById/api/v1/namespaces/:namespace/workflows/:workflowId/activities/:activityId/completeSee RespondActivityTaskCompleted. This version allows clients to record completions by namespace/workflow id/activity id instead of task token. (--…
  • POSTRespondActivityTaskFailedById/api/v1/namespaces/:namespace/workflows/:workflowId/activities/:activityId/failSee RecordActivityTaskFailed. This version allows clients to record failures by namespace/workflow id/activity id instead of task token. (-- api-linter:…
  • POSTRecordActivityTaskHeartbeatById/api/v1/namespaces/:namespace/workflows/:workflowId/activities/:activityId/heartbeatSee RecordActivityTaskHeartbeat. This version allows clients to record heartbeats by namespace/workflow id/activity id instead of task token. (-- api-linter:…
  • POSTPauseActivityExecution/api/v1/namespaces/:namespace/workflows/:workflowId/activities/:activityId/pausePauseActivityExecution pauses the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity…
  • POSTResetActivityExecution/api/v1/namespaces/:namespace/workflows/:workflowId/activities/:activityId/resetResetActivityExecution resets the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity.…
  • POSTRespondActivityTaskCanceledById/api/v1/namespaces/:namespace/workflows/:workflowId/activities/:activityId/resolve-as-canceledSee RespondActivityTaskCanceled. This version allows clients to record failures by namespace/workflow id/activity id instead of task token. (-- api-linter:…
  • POSTUnpauseActivityExecution/api/v1/namespaces/:namespace/workflows/:workflowId/activities/:activityId/unpauseUnpauseActivityExecution unpauses the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone…
  • POSTUpdateActivityExecutionOptions/api/v1/namespaces/:namespace/workflows/:workflowId/activities/:activityId/update-optionsUpdateActivityExecutionOptions is called by the client to update the options of an activity by its ID. This API can be used to target a workflow activity or a…
  • POSTPauseWorkflowExecution/api/v1/namespaces/:namespace/workflows/:workflowId/pauseNote: This is an experimental API and the behavior may change in a future release. PauseWorkflowExecution pauses the workflow execution specified in the…
  • POSTSignalWithStartWorkflowExecution/api/v1/namespaces/:namespace/workflows/:workflowId/signal-with-start/:signalNameSignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if it isn't yet started. If the workflow is running, a…
  • POSTUnpauseWorkflowExecution/api/v1/namespaces/:namespace/workflows/:workflowId/unpauseNote: This is an experimental API and the behavior may change in a future release. UnpauseWorkflowExecution unpauses a previously paused workflow execution…
  • POSTRequestCancelWorkflowExecution/api/v1/namespaces/:namespace/workflows/:workflow_execution.workflow_id/cancelRequestCancelWorkflowExecution is called by workers when they want to request cancellation of a workflow execution. This results in a new…
  • POSTResetWorkflowExecution/api/v1/namespaces/:namespace/workflows/:workflow_execution.workflow_id/resetResetWorkflowExecution will reset an existing workflow execution to a specified WORKFLOW_TASK_COMPLETED event (exclusive). It will immediately terminate the…
  • POSTSignalWorkflowExecution/api/v1/namespaces/:namespace/workflows/:workflow_execution.workflow_id/signal/:signalNameSignalWorkflowExecution is used to send a signal to a running workflow execution. This results in a WORKFLOW_EXECUTION_SIGNALED event recorded in the history…
  • POSTTerminateWorkflowExecution/api/v1/namespaces/:namespace/workflows/:workflow_execution.workflow_id/terminateTerminateWorkflowExecution terminates an existing workflow execution by recording a WORKFLOW_EXECUTION_TERMINATED event in the history and immediately…
  • GETPollWorkflowExecutionTimeSkipping/api/v1/namespaces/:namespace/workflows/:workflow_execution.workflow_id/time-skipping/poll?workflowExecution.workflowId=string&workflowExecution.runId=string&fastForwardId=stringPollWorkflowExecutionTimeSkipping waits for a fast-forward outcome for a workflow execution. Experimental. Might change in the future.
  • POSTUpdateWorkflowExecutionOptions/api/v1/namespaces/:namespace/workflows/:workflow_execution.workflow_id/update-optionsUpdateWorkflowExecutionOptions partially updates the WorkflowExecutionOptions of an existing workflow execution.
  • POSTUpdateWorkflowExecution/api/v1/namespaces/:namespace/workflows/:workflow_execution.workflow_id/update/:request.input.nameInvokes the specified Update function on user Workflow code.
  • GETGetSystemInfo/api/v1/system-infoGetSystemInfo returns information about the system.
  • GETGetClusterInfo/clusterGetClusterInfo returns information about temporal cluster
  • GETListNamespaces/cluster/namespaces?pageSize=0&nextPageToken=string&namespaceFilter.includeDeleted=trueListNamespaces returns the information and configuration for all namespaces.
  • POSTRegisterNamespace/cluster/namespacesRegisterNamespace creates a new namespace which can be used as a container for all resources. A Namespace is a top level entity within Temporal, and is used…
  • GETDescribeNamespace/cluster/namespaces/:namespace?id=string&weakConsistency=trueDescribeNamespace returns the information and configuration for a registered namespace.
  • POSTUpdateNamespace/cluster/namespaces/:namespace/updateUpdateNamespace is used to update the information and configuration of a registered namespace.
  • GETListActivityExecutions/namespaces/:namespace/activities?pageSize=0&nextPageToken=string&query=stringListActivityExecutions is a visibility API to list activity executions in a specific namespace.
  • POSTPauseActivity/namespaces/:namespace/activities-deprecated/pausePauseActivity pauses the execution of an activity specified by its ID or type. If there are multiple pending activities of the provided type - all of them…
  • POSTResetActivity/namespaces/:namespace/activities-deprecated/resetResetActivity resets the execution of an activity specified by its ID or type. If there are multiple pending activities of the provided type - all of them…
  • POSTUnpauseActivity/namespaces/:namespace/activities-deprecated/unpauseUnpauseActivity unpauses the execution of an activity specified by its ID or type. If there are multiple pending activities of the provided type - all of them…
  • POSTUpdateActivityOptions/namespaces/:namespace/activities-deprecated/update-optionsUpdateActivityOptions is called by the client to update the options of an activity by its ID or type. If there are multiple pending activities of the provided…
  • GETDescribeActivityExecution/namespaces/:namespace/activities/:activityId?runId=string&includeInput=true&includeOutcome=true&longPollToken=string&includeHeartbeatDetails=true&includeLastFailure=trueDescribeActivityExecution returns information about an activity execution. It can be used to: Get current activity info without waiting Long-poll for next…
  • POSTStartActivityExecution/namespaces/:namespace/activities/:activityIdStartActivityExecution starts a new activity execution. Returns an ActivityExecutionAlreadyStarted error if an instance already exists with same activity ID…
  • POSTRequestCancelActivityExecution/namespaces/:namespace/activities/:activityId/cancelRequestCancelActivityExecution requests cancellation of an activity execution. Cancellation is cooperative: this call records the request, but the activity…
  • POSTRespondActivityTaskCompletedById/namespaces/:namespace/activities/:activityId/completeSee RespondActivityTaskCompleted. This version allows clients to record completions by namespace/workflow id/activity id instead of task token. (--…
  • POSTRespondActivityTaskFailedById/namespaces/:namespace/activities/:activityId/failSee RecordActivityTaskFailed. This version allows clients to record failures by namespace/workflow id/activity id instead of task token. (-- api-linter:…
  • POSTRecordActivityTaskHeartbeatById/namespaces/:namespace/activities/:activityId/heartbeatSee RecordActivityTaskHeartbeat. This version allows clients to record heartbeats by namespace/workflow id/activity id instead of task token. (-- api-linter:…
  • GETPollActivityExecution/namespaces/:namespace/activities/:activityId/outcome?runId=stringPollActivityExecution long-polls for an activity execution to complete and returns the outcome (result or failure).
  • POSTPauseActivityExecution/namespaces/:namespace/activities/:activityId/pausePauseActivityExecution pauses the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity…
  • POSTResetActivityExecution/namespaces/:namespace/activities/:activityId/resetResetActivityExecution resets the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity.…
  • POSTRespondActivityTaskCanceledById/namespaces/:namespace/activities/:activityId/resolve-as-canceledSee RespondActivityTaskCanceled. This version allows clients to record failures by namespace/workflow id/activity id instead of task token. (-- api-linter:…
  • POSTTerminateActivityExecution/namespaces/:namespace/activities/:activityId/terminateTerminateActivityExecution terminates an existing activity execution immediately. Termination does not reach the worker and the activity code cannot react to…
  • POSTUnpauseActivityExecution/namespaces/:namespace/activities/:activityId/unpauseUnpauseActivityExecution unpauses the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone…
  • POSTUpdateActivityExecutionOptions/namespaces/:namespace/activities/:activityId/update-optionsUpdateActivityExecutionOptions is called by the client to update the options of an activity by its ID. This API can be used to target a workflow activity or a…
  • POSTRespondActivityTaskCompleted/namespaces/:namespace/activity-completeRespondActivityTaskCompleted is called by workers when they successfully complete an activity task. For workflow activities, this results in a new…
  • GETCountActivityExecutions/namespaces/:namespace/activity-count?query=stringCountActivityExecutions is a visibility API to count activity executions in a specific namespace.
  • POSTRespondActivityTaskFailed/namespaces/:namespace/activity-failRespondActivityTaskFailed is called by workers when processing an activity task fails. This results in a new ACTIVITY_TASK_FAILED event being written to the…
  • POSTRecordActivityTaskHeartbeat/namespaces/:namespace/activity-heartbeatRecordActivityTaskHeartbeat is optionally called by workers while they execute activities. If a worker fails to heartbeat within the heartbeat_timeout…
  • POSTRespondActivityTaskCanceled/namespaces/:namespace/activity-resolve-as-canceledRespondActivityTaskFailed is called by workers when processing an activity task fails. For workflow activities, this results in a new ACTIVITY_TASK_CANCELED…
  • GETListArchivedWorkflowExecutions/namespaces/:namespace/archived-workflows?pageSize=0&nextPageToken=string&query=stringListArchivedWorkflowExecutions is a visibility API to list archived workflow executions in a specific namespace.
  • GETListBatchOperations/namespaces/:namespace/batch-operations?pageSize=0&nextPageToken=stringListBatchOperations returns a list of batch operations
  • GETDescribeBatchOperation/namespaces/:namespace/batch-operations/:jobIdDescribeBatchOperation returns the information about a batch operation
  • POSTStartBatchOperation/namespaces/:namespace/batch-operations/:jobIdStartBatchOperation starts a new batch operation
  • POSTStopBatchOperation/namespaces/:namespace/batch-operations/:jobId/stopStopBatchOperation stops a batch operation
  • POSTSetCurrentDeployment/namespaces/:namespace/current-deployment/:deployment.series_nameSets a deployment as the current deployment for its deployment series. Can optionally update the metadata of the deployment as well. Deprecated. Replaced by…
  • GETGetCurrentDeployment/namespaces/:namespace/current-deployment/:seriesNameReturns the current deployment (and its info) for a given deployment series. Deprecated. Replaced by current_version returned by DescribeWorkerDeployment.
  • GETListDeployments/namespaces/:namespace/deployments?pageSize=0&nextPageToken=string&seriesName=stringLists worker deployments in the namespace. Optionally can filter based on deployment series name. Deprecated. Replaced with ListWorkerDeployments.
  • GETDescribeDeployment/namespaces/:namespace/deployments/:deployment.series_name/:deployment.build_id?deployment.seriesName=string&deployment.buildId=stringDescribes a worker deployment. Deprecated. Replaced with DescribeWorkerDeploymentVersion.
  • GETGetDeploymentReachability/namespaces/:namespace/deployments/:deployment.series_name/:deployment.build_id/reachability?deployment.seriesName=string&deployment.buildId=stringReturns the reachability level of a worker deployment to help users decide when it is time to decommission a deployment. Reachability level is calculated…
  • GETCountNexusOperationExecutions/namespaces/:namespace/nexus-operation-count?query=stringCountNexusOperationExecutions is a visibility API to count Nexus operations in a specific namespace.
  • GETListNexusOperationExecutions/namespaces/:namespace/nexus-operations?pageSize=0&nextPageToken=string&query=stringListNexusOperationExecutions is a visibility API to list Nexus operations in a specific namespace.
  • GETDescribeNexusOperationExecution/namespaces/:namespace/nexus-operations/:operationId?runId=string&includeInput=true&includeOutcome=true&longPollToken=stringDescribeNexusOperationExecution returns information about a Nexus operation. Supported use cases include: Get current operation info without waiting Long-poll…
  • POSTStartNexusOperationExecution/namespaces/:namespace/nexus-operations/:operationIdStartNexusOperationExecution starts a new Nexus operation. Returns a NexusOperationExecutionAlreadyStarted error if an instance already exists with same…
  • POSTRequestCancelNexusOperationExecution/namespaces/:namespace/nexus-operations/:operationId/cancelRequestCancelNexusOperationExecution requests cancellation of a Nexus operation. Requesting to cancel an operation does not automatically transition the…
  • GETPollNexusOperationExecution/namespaces/:namespace/nexus-operations/:operationId/poll?runId=string&waitStage=NEXUS_OPERATION_WAIT_STAGE_UNSPECIFIEDPollNexusOperationExecution long-polls for a Nexus operation for a given wait stage to complete and returns the outcome (result or failure).
  • POSTTerminateNexusOperationExecution/namespaces/:namespace/nexus-operations/:operationId/terminateTerminateNexusOperationExecution terminates an existing Nexus operation immediately. Termination happens immediately and the operation handler cannot react to…
  • GETCountSchedules/namespaces/:namespace/schedule-count?query=stringCountSchedules is a visibility API to count schedules in a specific namespace.
  • GETListSchedules/namespaces/:namespace/schedules?maximumPageSize=0&nextPageToken=string&query=stringList all schedules in a namespace.
  • GETDescribeSchedule/namespaces/:namespace/schedules/:scheduleIdReturns the schedule description and current state of an existing schedule.
  • POSTCreateSchedule/namespaces/:namespace/schedules/:scheduleIdCreates a new schedule.
  • DELETEDeleteSchedule/namespaces/:namespace/schedules/:scheduleId?identity=stringDeletes a schedule, removing it from the system.
  • GETListScheduleMatchingTimes/namespaces/:namespace/schedules/:scheduleId/matching-times?startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T00:00:00ZLists matching times within a range.
  • POSTPatchSchedule/namespaces/:namespace/schedules/:scheduleId/patchMakes a specific change to a schedule or triggers an immediate action.
  • POSTUpdateSchedule/namespaces/:namespace/schedules/:scheduleId/updateChanges the configuration or state of an existing schedule.
  • POSTUpdateTaskQueueConfig/namespaces/:namespace/task-queues/:taskQueue/update-configUpdates task queue configuration. For the overall queue rate limit: the rate limit set by this api overrides the worker-set rate limit, which uncouples the…
  • GETGetWorkerBuildIdCompatibility/namespaces/:namespace/task-queues/:taskQueue/worker-build-id-compatibility?maxSets=0Deprecated. Use GetWorkerVersioningRules. Will be removed in server version v1.32.0. Fetches the worker build id versioning sets for a task queue.
  • GETGetWorkerVersioningRules/namespaces/:namespace/task-queues/:taskQueue/worker-versioning-rulesFetches the Build ID assignment and redirect rules for a Task Queue. Will be removed in server version v1.32.0.
  • GETDescribeTaskQueue/namespaces/:namespace/task-queues/:task_queue.name?taskQueue.name=string&taskQueue.kind=TASK_QUEUE_KIND_UNSPECIFIED&taskQueue.normalName=string&taskQueueType=TASK_QUEUE_TYPE_UNSPECIFIED&reportStats=true&reportConfig=true&includeTaskQueueStatus=true&apiMode=DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED&versions.buildIds=string&versions.unversioned=true&versions.allActive=true&taskQueueTypes=TASK_QUEUE_TYPE_UNSPECIFIED&reportPollers=true&reportTaskReachability=trueDescribeTaskQueue returns the following information about the target task queue, broken down by Build ID: List of pollers Workflow Reachability status Backlog…
  • GETCountWorkers/namespaces/:namespace/worker-count?query=string&includeSystemWorkers=trueCountWorkers counts the number of workers in a specific namespace.
  • POSTCreateWorkerDeploymentVersion/namespaces/:namespace/worker-deployment-versions/:deployment_version.deployment_nameCreates a new Worker Deployment Version. Experimental. This API might significantly change or be removed in a future release.
  • GETDescribeWorkerDeploymentVersion/namespaces/:namespace/worker-deployment-versions/:deployment_version.deployment_name/:deployment_version.build_id?version=string&deploymentVersion.buildId=string&deploymentVersion.deploymentName=string&reportTaskQueueStats=trueDescribes a worker deployment version.
  • DELETEDeleteWorkerDeploymentVersion/namespaces/:namespace/worker-deployment-versions/:deployment_version.deployment_name/:deployment_version.build_id?version=string&deploymentVersion.buildId=string&deploymentVersion.deploymentName=string&skipDrainage=true&identity=stringUsed for manual deletion of Versions. User can delete a Version only when all the following conditions are met: It is not the Current or Ramping Version of…
  • POSTUpdateWorkerDeploymentVersionComputeConfig/namespaces/:namespace/worker-deployment-versions/:deployment_version.deployment_name/:deployment_version.build_id/update-compute-configUpdates the compute config attached to a Worker Deployment Version. Experimental. This API might significantly change or be removed in a future release.
  • POSTUpdateWorkerDeploymentVersionMetadata/namespaces/:namespace/worker-deployment-versions/:deployment_version.deployment_name/:deployment_version.build_id/update-metadataUpdates the user-given metadata attached to a Worker Deployment Version.
  • POSTValidateWorkerDeploymentVersionComputeConfig/namespaces/:namespace/worker-deployment-versions/:deployment_version.deployment_name/:deployment_version.build_id/validate-compute-configValidates the compute config without attaching it to a Worker Deployment Version. Experimental. This API might significantly change or be removed in a future…
  • GETListWorkerDeployments/namespaces/:namespace/worker-deployments?pageSize=0&nextPageToken=stringLists all Worker Deployments that are tracked in the Namespace.
  • GETDescribeWorkerDeployment/namespaces/:namespace/worker-deployments/:deploymentNameDescribes a Worker Deployment.
  • POSTCreateWorkerDeployment/namespaces/:namespace/worker-deployments/:deploymentNameCreates a new Worker Deployment. Experimental. This API might significantly change or be removed in a future release.
  • DELETEDeleteWorkerDeployment/namespaces/:namespace/worker-deployments/:deploymentName?identity=stringDeletes records of (an old) Deployment. A deployment can only be deleted if it has no Version in it.
  • POSTSetWorkerDeploymentCurrentVersion/namespaces/:namespace/worker-deployments/:deploymentName/set-current-versionSet/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping Version if it is the Version being set as Current.
  • POSTSetWorkerDeploymentManager/namespaces/:namespace/worker-deployments/:deploymentName/set-managerSet/unset the ManagerIdentity of a Worker Deployment. Experimental. This API might significantly change or be removed in a future release.
  • POSTSetWorkerDeploymentRampingVersion/namespaces/:namespace/worker-deployments/:deploymentName/set-ramping-versionSet/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for gradual ramp to unversioned workers too.
  • GETGetWorkerTaskReachability/namespaces/:namespace/worker-task-reachability?buildIds=string&taskQueues=string&reachability=TASK_REACHABILITY_UNSPECIFIEDDeprecated. Use DescribeTaskQueue. Will be removed in server version v1.32.0. Fetches task reachability to determine whether a worker may be retired. The…
  • GETListWorkers/namespaces/:namespace/workers?pageSize=0&nextPageToken=string&query=string&includeSystemWorkers=trueListWorkers is a visibility API to list worker status information in a specific namespace.
  • GETDescribeWorker/namespaces/:namespace/workers/describe/:workerInstanceKeyDescribeWorker returns information about the specified worker.
  • POSTFetchWorkerConfig/namespaces/:namespace/workers/fetch-configFetchWorkerConfig returns the worker configuration for a specific worker.
  • POSTRecordWorkerHeartbeat/namespaces/:namespace/workers/heartbeatWorkerHeartbeat receive heartbeat request from the worker.
  • POSTUpdateWorkerConfig/namespaces/:namespace/workers/update-configUpdateWorkerConfig updates the worker configuration of one or more workers. Can be used to partially update the worker configuration. Can be used to update…
  • GETCountWorkflowExecutions/namespaces/:namespace/workflow-count?query=stringCountWorkflowExecutions is a visibility API to count of workflow executions in a specific namespace.
  • GETListWorkflowRules/namespaces/:namespace/workflow-rules?nextPageToken=stringReturn all namespace workflow rules
  • POSTCreateWorkflowRule/namespaces/:namespace/workflow-rulesCreate a new workflow rule. The rules are used to control the workflow execution. The rule will be applied to all running and new workflows in the namespace.…
  • GETDescribeWorkflowRule/namespaces/:namespace/workflow-rules/:ruleIdDescribeWorkflowRule return the rule specification for existing rule id. If there is no rule with such id - NOT FOUND error will be returned.
  • DELETEDeleteWorkflowRule/namespaces/:namespace/workflow-rules/:ruleIdDelete rule by rule id
  • GETListWorkflowExecutions/namespaces/:namespace/workflows?pageSize=0&nextPageToken=string&query=stringListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.
  • GETDescribeWorkflowExecution/namespaces/:namespace/workflows/:execution.workflow_id?execution.workflowId=string&execution.runId=stringDescribeWorkflowExecution returns information about the specified workflow execution.
  • GETGetWorkflowExecutionHistory/namespaces/:namespace/workflows/:execution.workflow_id/history?execution.workflowId=string&execution.runId=string&maximumPageSize=0&nextPageToken=string&waitNewEvent=true&historyEventFilterType=HISTORY_EVENT_FILTER_TYPE_UNSPECIFIED&skipArchival=trueGetWorkflowExecutionHistory returns the history of specified workflow execution. Fails with NotFound if the specified workflow execution is unknown to the…
  • GETGetWorkflowExecutionHistoryReverse/namespaces/:namespace/workflows/:execution.workflow_id/history-reverse?execution.workflowId=string&execution.runId=string&maximumPageSize=0&nextPageToken=stringGetWorkflowExecutionHistoryReverse returns the history of specified workflow execution in reverse order (starting from last event). Fails withNotFound if the…
  • POSTQueryWorkflow/namespaces/:namespace/workflows/:execution.workflow_id/query/:query.query_typeQueryWorkflow requests a query be executed for a specified workflow execution.
  • POSTTriggerWorkflowRule/namespaces/:namespace/workflows/:execution.workflow_id/trigger-ruleTriggerWorkflowRule allows to: * trigger existing rule for a specific workflow execution; * trigger rule for a specific workflow execution without creating a…
  • POSTStartWorkflowExecution/namespaces/:namespace/workflows/:workflowIdStartWorkflowExecution starts a new workflow execution. It will create the execution with a WORKFLOW_EXECUTION_STARTED event in its history and also schedule…
  • POSTRespondActivityTaskCompletedById/namespaces/:namespace/workflows/:workflowId/activities/:activityId/completeSee RespondActivityTaskCompleted. This version allows clients to record completions by namespace/workflow id/activity id instead of task token. (--…
  • POSTRespondActivityTaskFailedById/namespaces/:namespace/workflows/:workflowId/activities/:activityId/failSee RecordActivityTaskFailed. This version allows clients to record failures by namespace/workflow id/activity id instead of task token. (-- api-linter:…
  • POSTRecordActivityTaskHeartbeatById/namespaces/:namespace/workflows/:workflowId/activities/:activityId/heartbeatSee RecordActivityTaskHeartbeat. This version allows clients to record heartbeats by namespace/workflow id/activity id instead of task token. (-- api-linter:…
  • POSTPauseActivityExecution/namespaces/:namespace/workflows/:workflowId/activities/:activityId/pausePauseActivityExecution pauses the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity…
  • POSTResetActivityExecution/namespaces/:namespace/workflows/:workflowId/activities/:activityId/resetResetActivityExecution resets the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone activity.…
  • POSTRespondActivityTaskCanceledById/namespaces/:namespace/workflows/:workflowId/activities/:activityId/resolve-as-canceledSee RespondActivityTaskCanceled. This version allows clients to record failures by namespace/workflow id/activity id instead of task token. (-- api-linter:…
  • POSTUnpauseActivityExecution/namespaces/:namespace/workflows/:workflowId/activities/:activityId/unpauseUnpauseActivityExecution unpauses the execution of an activity specified by its ID. This API can be used to target a workflow activity or a standalone…
  • POSTUpdateActivityExecutionOptions/namespaces/:namespace/workflows/:workflowId/activities/:activityId/update-optionsUpdateActivityExecutionOptions is called by the client to update the options of an activity by its ID. This API can be used to target a workflow activity or a…
  • POSTPauseWorkflowExecution/namespaces/:namespace/workflows/:workflowId/pauseNote: This is an experimental API and the behavior may change in a future release. PauseWorkflowExecution pauses the workflow execution specified in the…
  • POSTSignalWithStartWorkflowExecution/namespaces/:namespace/workflows/:workflowId/signal-with-start/:signalNameSignalWithStartWorkflowExecution is used to ensure a signal is sent to a workflow, even if it isn't yet started. If the workflow is running, a…
  • POSTUnpauseWorkflowExecution/namespaces/:namespace/workflows/:workflowId/unpauseNote: This is an experimental API and the behavior may change in a future release. UnpauseWorkflowExecution unpauses a previously paused workflow execution…
  • POSTRequestCancelWorkflowExecution/namespaces/:namespace/workflows/:workflow_execution.workflow_id/cancelRequestCancelWorkflowExecution is called by workers when they want to request cancellation of a workflow execution. This results in a new…
  • POSTResetWorkflowExecution/namespaces/:namespace/workflows/:workflow_execution.workflow_id/resetResetWorkflowExecution will reset an existing workflow execution to a specified WORKFLOW_TASK_COMPLETED event (exclusive). It will immediately terminate the…
  • POSTSignalWorkflowExecution/namespaces/:namespace/workflows/:workflow_execution.workflow_id/signal/:signalNameSignalWorkflowExecution is used to send a signal to a running workflow execution. This results in a WORKFLOW_EXECUTION_SIGNALED event recorded in the history…
  • POSTTerminateWorkflowExecution/namespaces/:namespace/workflows/:workflow_execution.workflow_id/terminateTerminateWorkflowExecution terminates an existing workflow execution by recording a WORKFLOW_EXECUTION_TERMINATED event in the history and immediately…
  • GETPollWorkflowExecutionTimeSkipping/namespaces/:namespace/workflows/:workflow_execution.workflow_id/time-skipping/poll?workflowExecution.workflowId=string&workflowExecution.runId=string&fastForwardId=stringPollWorkflowExecutionTimeSkipping waits for a fast-forward outcome for a workflow execution. Experimental. Might change in the future.
  • POSTUpdateWorkflowExecutionOptions/namespaces/:namespace/workflows/:workflow_execution.workflow_id/update-optionsUpdateWorkflowExecutionOptions partially updates the WorkflowExecutionOptions of an existing workflow execution.
  • POSTUpdateWorkflowExecution/namespaces/:namespace/workflows/:workflow_execution.workflow_id/update/:request.input.nameInvokes the specified Update function on user Workflow code.
  • GETGetSystemInfo/system-infoGetSystemInfo returns information about the system.

API details

Authentication
None declared in the description
Operations
228 operations on 202 pathsPOST 130GET 88DELETE 10
Main resources
WorkflowService 216OperatorService 12
Response formats
application/json
Description format
OpenAPI 3.0.3, API version 0.0.1

How to test the in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “ListSearchAttributes” (GET /api/v1/namespaces/:namespace/search-attributes), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the ?

endpoints from Temporal It is listed under Developer tools and has 228 endpoints.

Who publishes the ?

It is listed from Temporal's public API description (an OpenAPI document), not published by Temporal on Swastik Codes. Anyone who controls temporal.io can claim the profile by adding a DNS TXT record.

How do I authenticate with the ?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the have?

228 operations on 202 paths (130 POST, 88 GET, 10 DELETE). The largest groups are WorkflowService, OperatorService.

Is forking the free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.