Sign in
Deployments

Execute a deployment operation (deploy, mark_complete, take_screenshot)

Changed on
post/projects/{project_id}/deployments/{deployment_id}/operations

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/deployments/{deployment_id}/operations
  • Auth: HTTP bearer

Path parameters

project_idinteger required
deployment_idstring required

Request body

operationstring required

Response

Operation accepted. take_screenshot returns status: pending with success: null; poll the operation status for completed (with screenshot_location) or failed (with the reason)

executed_atstring date-time required
messagestring required
operationstring required
status'pending' | 'completed' | 'failed' required

Where an operation is in its lifecycle.

An operation that does its work in the background (a screenshot capture) is recorded as Pending when it starts and replaced by a Completed or Failed record when it ends, so a caller can poll for the outcome instead of being told it succeeded before anything ran.

Published as DeploymentOperationStatus: temps-projects already owns the OperationStatus schema name, and two schemas with one name silently replace each other in the merged OpenAPI document.

successboolean nullable

The outcome, final only once status is terminal: null while the operation is pending, true when it completed, false when it failed. Read status first; a null here is not a failure.

Example response

{
  "data": {
    "screenshot": {
      "captured_at": "2026-10-10T01:25:34.793514Z"
    }
  },
  "executed_at": "2025-10-12T12:15:47.609192Z"
}

Changes

  • 1bfd419deb2fRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

  • e75811e4d169Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      the response property became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property to the response with the status