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
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Update an Environment Connection. |
environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Update an Environment Connection. |
connectionId | string | required | Identifies the stored external connection. Applies to Update an Environment Connection. |
Request body
Required — Request body for: Update an Environment Connection.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
name | string | optional | |
status | "active" | "disabled" | "deleting" | optional | |
version | one of 2 types | optional | New 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. |
agentId | string | optional | |
bindingKey | string | optional |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |