Documentation menu
Connections

Update an Environment Connection

PATCH /api/v1/projects/{projectId}/environments/{environmentId}/connections/{connectionId}

Updates safe Connection metadata or creates a new immutable Connection version. A version with settings alone carries the exact provider credential version the current version pins, so after a credential rotation it keeps the old version until a caller pins the new one; a version with providerCredentialId and providerCredentialVersion pins that version. Every carried or explicit pin must name an active, unexpired api_key credential whose provider matches settings.provider on an http Connection; otherwise, or when the current version has no pin to carry, the request returns 422. A binding requires a credential-bearing Connection version. The response shows the pinned credential id and version number; credential material is never returned.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Update an Environment Connection.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Update an Environment Connection.
connectionIdstringrequiredIdentifies the stored external connection. Applies to Update an Environment Connection.

Request body

Required — Request body for: Update an Environment Connection.

application/json

NameTypeRequiredDescription
namestringoptional
status"active" | "disabled" | "deleting"optional
versionone of 2 typesoptionalNew immutable version. Settings alone carry the exact provider credential version the current version pins, even after the credential rotated; settings with providerCredentialId and providerCredentialVersion pin that version instead.
agentIdstringoptional
bindingKeystringoptional

Responses

StatusDescriptionBody
200Response for status 200application/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)