Documentation menu
Connections

Create an Environment Connection

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

Creates a metadata-only Connection in the resolved Project Environment. An optional provider credential ID and version pin an existing credential version, which must be an active, unexpired api_key credential whose provider matches settings.provider on an http Connection; the response shows the pinned id and version number, never credential material. An optional Agent binding records the exact Connection version and requires a credential pin. Unknown or foreign coordinates return 404; an unbindable pin, a binding without a pin, and malformed binding input return 422.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Create an Environment Connection.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Create an Environment Connection.

Request body

Required — Request body for: Create an Environment Connection.

application/json

NameTypeRequiredDescription
namestringrequired
kind"http" | "database" | "object_storage" | "messaging" | "custom"required
providerCredentialIdstring | nulloptional
providerCredentialVersioninteger | nulloptional
settingsobjectrequired
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)