UNunkeyed
deployments

Start deployment

Changed on

Start a deployment that was previously stopped with stopDeployment, so it serves traffic again. The deployment keeps the configuration it had when it was stopped; nothing is rebuilt or redeployed.

The deployment must currently be stopped, and must belong to a non-production environment. Production deployments are never stopped, so they cannot be started.

Starting is asynchronous: this endpoint only enqueues the start and returns immediately. Poll getDeployment until the status reaches ready.

Required Permissions

Your root key must have write permission on the deployment:

  • unkey:v1:<workspace_id>:projects/<project_id>/apps/<app_id>/environments/<environment_id>/deployments/<deployment_id>#write
post/v2/deployments.startDeployment

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/deployments.startDeployment
  • Auth
    HTTP bearer

Request body

deploymentIdstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Example request

{
  "deploymentId": "proj_1234abcd"
}

Response

Start accepted and enqueued. The deployment transitions to ready asynchronously; poll getDeployment to observe the transition.

dataEmptyResponse required

Empty response object by design. A successful response indicates this operation was successfully executed.

Example response

{
  "meta": {
    "requestId": "req_123"
  }
}

Changes