Sign in
deployments

Update Pipeline Deployment

Changed on

Update a pipeline deployment state and publish events for the orchestrator.

patch/api/v1/deployments/{id}

Request

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

Path parameters

idstring uuid required

Request body

state'pending' | 'assigned_agents' | 'failed_to_start' | 'failure_on_agent' | 'running' | 'cancelled' 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

  • 62c6a9932370Revision 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

    • info

      added the new assigned_agents enum value to the request property

    • info

      added the new failure_on_agent enum value to the request property

  • 511dfdbfb641Revision changes
    • info

      endpoint added