Skip to main content
POST
Make a published version the production one

Authorizations

apiKey
string
query
required

apiKey MUST be supplied within the request body instead of query

Path Parameters

projectId
string<uuid>
required

POST /v2/api/projects/:projectId/workspaces/:workspaceId/versions/:version/promote Parameter

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})$
workspaceId
string<uuid>
required

POST /v2/api/projects/:projectId/workspaces/:workspaceId/versions/:version/promote Parameter

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})$
version
integer
required

POST /v2/api/projects/:projectId/workspaces/:workspaceId/versions/:version/promote Parameter

Required range: 1 <= x <= 9007199254740991

Body

application/json

POST /v2/api/projects/:projectId/workspaces/:workspaceId/versions/:version/promote Request body

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"

bypassChecks
boolean

Only with environments, where production can require tests: move production WITHOUT running them. Owner or admin only, and recorded in the deployment history. Refused when production requires no tests. Ask the person before setting this; deploying (POST …/environments/production/deployments) runs the tests instead.

rlsConfirmation
string

Only after a 409 with code RLS_DESTRUCTIVE_CHANGE_UNCONFIRMED or RLS_PRODUCTION_CHANGE_UNCONFIRMED: that response's details.confirmation, sent back to go ahead with the row-level security changes it listed. Owner or admin only. Show the person the list and ask before sending it.

Required string length: 1 - 64

Response

POST /v2/api/projects/:projectId/workspaces/:workspaceId/versions/:version/promote Positive response

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