Documentation menu
Connections

Delete a Connection

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

Deletes the Connection from the resolved Project Environment. Existing retained audit or pinned execution records are not rewritten; a Connection retained by an immutable configuration snapshot returns 409, and a foreign or unknown Connection returns 404.

Parameters

path

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

Responses

StatusDescriptionBody
204Response for status 204none — none
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)