Playbooks

Pause a case

Stops the case starting anything: no node is queued and no queued execution starts until it is resumed. Executions already running settle. Input writes are still accepted. Pausing a paused case keeps the first pause.

post/v1/projects/{project_id}/playbook-cases/{case_id}/pause

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/playbook-cases/{case_id}/pause
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Path parameters

case_idstring required
Example:pbk_case_V1StGXR8Z5jdHi6B

The case ID

Response

The paused case

idstring
project_idstring
playbook_idstring
playbook_versioninteger

The version the case was created on and is evaluated against

subjectstring
revisioninteger

The case's revision counter; every entry takes the next value

automation_status'idle' | 'running' | 'waiting' | 'paused'

paused while a pause of the case or of its project stands, else running while an execution is queued or runs its executor, else waiting while every execution in flight waits on a workflow task or orchestration run it started, else idle

pause_requested_atstring date-time nullable

When the case was paused; null while it runs

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "pbk_case_V1StGXR8Z5jdHi6B",
  "project_id": "proj_V1StGXR8Z5jdHi6B",
  "playbook_id": "pbk_V1StGXR8Z5jdHi6B",
  "playbook_version": 1,
  "nodes": [
    {
      "id": "regime",
      "run": {
        "id": "task_V1StGXR8Z5jdHi6B"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.