curl --request POST \
--url https://api.cloudcruise.com/runs/pause \
--header 'Content-Type: application/json' \
--header 'cc-key: <api-key>' \
--data '
{
"pause_resource": "workflow",
"resource_ids": [
"11223344-5566-7788-9900-112233445566"
],
"reason": "Portal maintenance"
}
'{
"success": true,
"pausedRuns": 123,
"skippedResourceGroups": [
"<string>"
],
"errors": [
"<string>"
],
"pausedResources": {}
}Pause runs
Pauses workflows or vault credentials so their queued runs are held and new runs submitted to them wait with the status execution.paused. Requires the Owner or Member workspace role.
Queued runs are moved to the paused queue and each sends an execution.paused webhook. Runs that are already executing are not stopped. A pause stays until you lift it with POST /runs/unpause; it does not expire.
A credential ID has the form <workspace_id>:<permissioned_user_id>:<domain>.
curl --request POST \
--url https://api.cloudcruise.com/runs/pause \
--header 'Content-Type: application/json' \
--header 'cc-key: <api-key>' \
--data '
{
"pause_resource": "workflow",
"resource_ids": [
"11223344-5566-7788-9900-112233445566"
],
"reason": "Portal maintenance"
}
'{
"success": true,
"pausedRuns": 123,
"skippedResourceGroups": [
"<string>"
],
"errors": [
"<string>"
],
"pausedResources": {}
}Authorizations
API key-based authentication. Provide your CloudCruise API key in the cc-key header.
Body
What kind of resource to pause
workflow, credential Workflow IDs (UUIDs) for workflow; credential IDs for credential
Why the resource is paused. Shown in the paused resources list
Credentials only. When true, the credential's saved browser data (cookies and storage) is cleared when it is unpaused. Sending it with workflow returns 400
Response
The pause was applied
Number of queued runs held by this pause
Worker groups that were busy and could not be processed. Their queued runs are not held yet, so repeat the request.
The paused resources after this call, as returned by GET /runs/paused
Was this page helpful?