Sign in
deployments

Create Pipeline Deployment

Changed on

Create a new pipeline deployment and publish initialization event. State transitions are managed by the orchestrator.

post/api/v1/deployments/

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/login/access-token)

Request body

pipeline_idstring uuid required
revision_idinteger required

Response

Successful Response

idstring uuid required
pipeline_idstring uuid required
revision_idinteger required
state'pending' | 'assigned_agents' | 'failed_to_start' | 'failure_on_agent' | 'running' | 'cancelled' required
created_atstring date-time required
updated_atstring date-time required

Changes

  • 0bdecd6eb5fdRevision changes
    • warning

      added the new assigned_agents enum value to the response property for the response status

    • warning

      added the new failure_on_agent enum value to the response property for the response status

  • 511dfdbfb641Revision changes
    • info

      endpoint added