The deployment run object

⚠️

Preview — this feature is being built; the design below is the spec.

The deployment_run object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "drn_01JC9F1H3K5M7P9R1T3V",
  "type": "deployment_run",
  "deployment_id": "dep_01JC6C8E0G2J4L6N8Q0S",
  "fired_at": "2026-11-05T07:00:00Z",
  "trigger_type": "schedule",
  "status": "canceled",
  "session_id": "sesn_01JC9F2J4L6N8Q0S2U4W",
  "input": {
    "report_date": "2026-11-04"
  },
  "skip_reason": null,
  "error": null,
  "started_at": "2026-11-05T07:00:02Z",
  "finished_at": "2026-11-05T07:03:40Z"
}

Fields

Field	Type	Description
`id`	string	Unique id of this object.
`type`	string	The object type, always `deployment_run`.
`deployment_id`	string	The deployment.
`fired_at`	string	See the endpoint pages below.
`trigger_type`	string	`schedule`, `webhook` or `manual`.
`status`	string	`queued`, `running`, `succeeded`, `failed`, `canceled` or `skipped`.
`session_id`	string or null	The session the run created. `null` for skipped runs.
`input`	object	Nested detail; see the endpoint pages below.
`skip_reason`	string or null	`overlap` (previous run still going and `overlap_policy` is `skip`), `paused` or `budget_exhausted`.
`error`	object or null	Set when `status` is `failed`.
`started_at`	string	When work began.
`finished_at`	string	When it ended, or `null`.

Returned by

deployment encryption_key

Was this page helpful?