Sign in
Run Internals

Get Run State

Returns the internal event-sourced run projection. This is not a stable public contract.

get/api/v1/runs/{id}/state

Path parameters

idstring required

Unique run identifier (ULID).

Response

Current run projection

titlestring

Resolved run title from the event log.

parent_idstring nullable

Current orchestration parent run ID, if linked.

web_urlstring nullable

Absolute web UI URL for this run when server web settings are configured.

archived_atstring date-time nullable
status_updated_atstring date-time required
last_event_atstring date-time required
pending_control'cancel' | 'pause' | 'unpause'

Run control action requested by the API.

superseded_bystring nullable
retried_fromstring nullable

Source run ID when this run was created by manual retry.

pending_interviewsobject required
stagesobject required

Map from StageId (node_id@visit) to stage projection data.

Changes

Changed in 69 of the 134 revisions of this API.4135121

  • 13262755c97f1See the full diff
    • ○

      added the optional property spec/target/oneOf[RunTarget]/oneOf[GitRunTarget]/tag to the response with the 200 status

      response-optional-property-added

  • e7fd6d85320411See the full diff
    • ▲

      added FolderRunTarget to the spec/target/oneOf[RunTarget]/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added folder discriminator mapping keys to the spec/target/oneOf[RunTarget]/ response property for the response status 200

      response-property-discriminator-mapping-added

  • 9abd94e6cfbe11See the full diff
    • ▲

      added NoneRunTarget to the spec/target/oneOf[RunTarget]/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added none discriminator mapping keys to the spec/target/oneOf[RunTarget]/ response property for the response status 200

      response-property-discriminator-mapping-added

  • 5290add6d36f2See the full diff
    • ○

      removed none discriminator mapping keys from the spec/target/oneOf[RunTarget]/ response property for the response status 200

      response-property-discriminator-mapping-deleted

    • ○

      removed NoneRunTarget from the spec/target/oneOf[RunTarget]/ response property oneOf list for the response status 200

      response-property-one-of-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cfd12cf45afb11See the full diff
    • ▲

      added NoneRunTarget to the spec/target/oneOf[RunTarget]/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added none discriminator mapping keys to the spec/target/oneOf[RunTarget]/ response property for the response status 200

      response-property-discriminator-mapping-added

  • 6ed5f1557b9b1See the full diff
    • ○

      added the optional property spec/target to the response with the 200 status

      response-optional-property-added

  • 1493908ec53f1See the full diff
    • ○

      added the optional property spec/settings/run/integrations/github/additional_repositories to the response with the 200 status

      response-optional-property-added

  • 4b6d69f0b05a11See the full diff
    • ▲

      the spec/settings/run/clone/depth response property's min was decreased from 1.00 to 0.00 for the response status 200

      response-property-min-decreased

    • ○

      the depth response's property default value 100 was added for the status 200

      response-property-default-value-added

  • 45581b16fce211See the full diff
    • ●

      removed the optional property spec/settings/run/integrations/github/additional_repositories from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property spec/settings/run/clone/depth to the response with the 200 status

      response-optional-property-added

  • 7c8b8c58f6ca2See the full diff
    • ○

      added the optional property spec/settings/run/integrations/github/additional_repositories to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property spec/workflow_version_id to the response with the 200 status

      response-optional-property-added