Get dispatch continuation

http
GET /runs/{run_id}/pause-checkpoint

Return the dispatch continuation.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "projectRunStopAuth": []
  }
]
json
{
  "projectRunStopAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "Project Run Stop JWT",
    "description": "A project-run stop capability bound to one run, project, and executor attempt."
  }
}

Parameters

NameLocationRequiredDescription
run_idpathYes
boundaryqueryNo

Parameter contracts

json
[
  {
    "schema": {
      "type": "string",
      "minLength": 1
    },
    "required": true,
    "name": "run_id",
    "in": "path"
  },
  {
    "schema": {
      "type": "string",
      "enum": [
        "true"
      ]
    },
    "required": false,
    "name": "boundary",
    "in": "query"
  }
]

Responses

200

Private continuation for the current dispatch

json
{
  "description": "Private continuation for the current dispatch",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "stop": {
            "type": "boolean",
            "description": "True for a superseded dispatch, which also receives no checkpoint."
          },
          "pauseRequested": {
            "type": "boolean"
          },
          "checkpoint": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": {}
          }
        },
        "required": [
          "stop",
          "checkpoint"
        ],
        "additionalProperties": false
      }
    }
  }
}

400

Bad request

json
{
  "description": "Bad request",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

500

Server error

json
{
  "description": "Server error",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

Referenced contracts

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

Operation contract

json
{
  "operationId": "getRunPauseCheckpoint",
  "tags": [
    "execution/Runs/Runtime"
  ],
  "security": [
    {
      "projectRunStopAuth": []
    }
  ],
  "summary": "Get dispatch continuation",
  "description": "Return the dispatch continuation.",
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1
      },
      "required": true,
      "name": "run_id",
      "in": "path"
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "true"
        ]
      },
      "required": false,
      "name": "boundary",
      "in": "query"
    }
  ],
  "responses": {
    "200": {
      "description": "Private continuation for the current dispatch",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "stop": {
                "type": "boolean",
                "description": "True for a superseded dispatch, which also receives no checkpoint."
              },
              "pauseRequested": {
                "type": "boolean"
              },
              "checkpoint": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": {}
              }
            },
            "required": [
              "stop",
              "checkpoint"
            ],
            "additionalProperties": false
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Runtime",
  "x-canonical-documentation": {
    "domain": "execution",
    "resource": "Runs",
    "subgroup": "Runtime",
    "name": "Get dispatch continuation",
    "description": "Return the dispatch continuation.",
    "operationId": "getRunPauseCheckpoint"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/execution-runs-runtime/get-dispatch-continuation"
  }
}