Documentation menu
Projects

Activate deployment

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

Synchronously activates an eligible ready Deployment and atomically advances this Environment's active pointer and generation. The expectedGeneration field is a compare-and-set guard; non-ready or stale/conflicting requests return 409, an activation that cannot take the runtime cutover lock before running operations finish returns 409 with details.conflictReason runtime_cutover_busy and details.retryable true, while a missing or foreign Project/Environment/Deployment coordinate returns 404.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Activate deployment.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Activate deployment.

Request body

Required — Request body for: Activate deployment.

application/json

NameTypeRequiredDescription
deploymentIdstringrequired
expectedGenerationintegerrequired

Responses

StatusDescriptionBody
201Response for status 201application/json — object — activationId: string (required); deploymentId: string (required); generation: integer (required); environmentId: string (required); projectId: string (required); releaseId: string | null (required); configurationRevisionId: string (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)