Documentation menu
Workflows

Start a Workflow

POST /api/v1/projects/{projectId}/environments/{environmentId}/workflows

Admit a pinned operation Workflow and return its durable run.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Start a Workflow.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Start a Workflow.

Request body

Required — Request body for: Start a Workflow.

application/json

NameTypeRequiredDescription
agentIdstringrequired
definitionIdOrNameone of 2 typesrequired
paramsobjectoptional
requestKeystringoptional
actorUserIdstringoptional

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
202Response for status 202application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)