v13

OpenAPI 3.0.32026-07-31359869.4 MB

rolling-release

Get the active rolling release information for a project

Return the Rolling Release for a project, regardless of whether the rollout is active, aborted, or completed. If the feature is enabled but no deployment has occurred yet, null will be returned.

get/v1/projects/{idOrName}/rolling-release

Path parameters

idOrNamestring required

Project ID or project name (URL-encoded)

Query parameters

state'ACTIVE' | 'COMPLETE' | 'ABORTED'

Filter by rolling release state

teamIdstring

Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring

Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

Example response

{
  "rollingRelease": {
    "state": "ACTIVE",
    "currentDeployment": {
      "id": "dpl_abc123",
      "name": "my-shop@main",
      "url": "my-shop.vercel.app",
      "target": "production",
      "source": "git",
      "createdAt": 1716206500000,
      "readyState": "READY",
      "readyStateAt": 1716206800000
    },
    "canaryDeployment": {
      "id": "dpl_def456",
      "name": "my-shop@9c7e2f4",
      "url": "9c7e2f4-my-shop.vercel.app",
      "target": "production",
      "source": "git",
      "createdAt": 1716210100000,
      "readyState": "READY",
      "readyStateAt": 1716210400000
    },
    "queuedDeploymentId": "dpl_ghi789",
    "advancementType": "manual-approval",
    "stages": [
      {
        "index": 0,
        "isFinalStage": false,
        "targetPercentage": 5,
        "requireApproval": true,
        "duration": null
      },
      {
        "index": 1,
        "isFinalStage": false,
        "targetPercentage": 25,
        "requireApproval": true,
        "duration": null
      },
      {
        "index": 2,
        "isFinalStage": false,
        "targetPercentage": 60,
        "requireApproval": true,
        "duration": null
      },
      {
        "index": 3,
        "isFinalStage": true,
        "targetPercentage": 100,
        "requireApproval": false,
        "duration": null
      }
    ],
    "activeStage": {
      "index": 1,
      "isFinalStage": false,
      "targetPercentage": 25,
      "requireApproval": true,
      "duration": null
    },
    "nextStage": {
      "index": 2,
      "isFinalStage": false,
      "targetPercentage": 60,
      "requireApproval": true,
      "duration": null
    },
    "startedAt": 1716210500000,
    "updatedAt": 1716210600000
  }
}