Skip to main content
PUT
Map a production connection to the connection it …

Authorizations

apiKey
string
query
required

apiKey MUST be supplied within the request body instead of query

Path Parameters

projectId
string<uuid>
required

The project the environments belong to.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
environment
string
required

The environment's slug, e.g. staging.

sourceConnectionId
string
required

The production connection to map: one a workspace in this project targets.

Body

application/json

PUT /v2/api/projects/:projectId/environments/:environment/connections/:sourceConnectionId Request body

connectionId
string
required

The connection the source means in this environment. Must be in this project and of the same type as the source.

apiKey
string

Upsolve API key, generated under Account → Developer settings in the Upsolve Hub. Keys are user-scoped: pass organizationId alongside the key to select which org to act on.

Minimum string length: 1
Example:

"up_embed_************"

organizationId
string<uuid>

Your Upsolve organization's UUID — the org that owns the API key and project. This is NOT a project organization: do not pass a value registered via /projects/register-organization, and do not pass an externalId (only projectOrganizationId accepts those). Omit it when using an org-bound API key — the org is read from the key and any value sent here is ignored. Required only for user-scoped API keys (created under Account → Developer settings) and for the Supabase JWT path, where the org is ambiguous and membership is verified against it.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

PUT /v2/api/projects/:projectId/environments/:environment/connections/:sourceConnectionId Positive response

status
string
required
Allowed value: "success"
data
object
required