Deployments

Update deployment

Changed on

Updates properties of an existing deployment. Only the fields provided in the request body are modified; omitted fields are left unchanged.

patch/deployments/{deployment_name}

Request

  • Base URL: https://api.convex.dev/v1
  • URL: https://api.convex.dev/v1/deployments/{deployment_name}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

deployment_namestring required

Deployment Name

Request body

referencestring nullable

The reference of the deployment. When provided, must match the following rules:

  • be unique across deployment references in the project
  • 3 to 100 characters (included)
  • only lowercase letters, numbers, "-"" and "/"
  • not follow the deployment name format [a-z]+-[a-z]+-[0-9]+ (e.g. "happy-capybara-123")
  • not start with "local-""
  • not be one of the following reserved keywords: "prod", "dev", "cloud", "local", "default", "name", "new", "existing", "deployment", "preview"
dashboardEditConfirmationboolean nullable

Controls whether the dashboard requires a confirmation before allowing edits during a browser session for this deployment. If set to null, the setting is reset to the default behavior (true for prod deployments, false for dev and preview deployments). If set to true or false, the setting is explicitly overridden.

expiresAtinteger nullable

Timestamp in milliseconds when this deployment will be deleted. Preview deployments have this set by default unless overridden. Must be at least 30 minutes in the future and cannot exceed the team's preview deployment retention days entitlement from now. Set to null to clear the expiration.

sendLogsToClientboolean nullable

Whether to send function logs to the client. If set to null, the setting is reset to the deployment-type default (true for dev/preview, false for prod). If set to true or false, the setting is explicitly overridden.

classstring nullable

The deployment class to move this deployment to (e.g. "s16", "s256"). Requires the deployment class selection entitlement.

isDefaultboolean nullable

For a prod deployment, whether the deployment is the default production deployment for the project (i.e. the one used by default when running npx convex deploy). For a dev deployment, whether the deployment is the default development deployment for the member that created it (i.e. the one used by default when running npx convex dev). Setting this to true will fail on preview or custom deployments, or if there is already a matching default deployment in the project.

deploymentType'dev' | 'prod' | 'preview' | 'custom'

Changes