Documentation menu
Connections

List Connections for an Environment

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

List metadata-only Connections owned by the given Project Environment. The response is cursor-paginated; pass pagination.nextCursor unchanged to read the next page. Credential material remains internal.

Returns 404 if the Project does not exist in the caller's organization.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to List Connections for an Environment.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to List Connections for an Environment.

query

NameTypeRequiredDescription
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List Connections for an Environment.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List Connections for an Environment.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required); pagination: 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)