Skip to content
Docs

Get the active rolling release information for a project

GET/__remote/api.vercel.com/v1/projects/{idOrName}/rolling-release
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.
Request
import { Edgenivo } from "@vercel/sdk";


const vercel = new Edgenivo({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.rollingRelease.getRollingRelease({
    idOrName: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
{
  "rollingRelease": {
    "activeStage": {
      "duration": "null",
      "index": "0",
      "isFinalStage": "false",
      "linearShift": "false",
      "requireApproval": "false",
      "targetPercentage": "25"
    },
    "advancementType": "manual-approval",
    "canaryDeployment": {
      "createdAt": "1540257589405",
      "id": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ",
      "name": "my-project",
      "readyState": "READY",
      "readyStateAt": "123",
      "source": "cli",
      "target": "null",
      "url": "my-instant-deployment-3ij3cxz9qr.now.sh"
    },
    "currentCanaryPercentage": "123",
    "currentDeployment": {
      "createdAt": "1540257589405",
      "id": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ",
      "name": "my-project",
      "readyState": "READY",
      "readyStateAt": "123",
      "source": "cli",
      "target": "null",
      "url": "my-instant-deployment-3ij3cxz9qr.now.sh"
    },
    "nextStage": {
      "duration": "null",
      "index": "0",
      "isFinalStage": "false",
      "linearShift": "false",
      "requireApproval": "false",
      "targetPercentage": "25"
    },
    "queuedDeploymentId": "dpl_ghi789",
    "stages": [
      {
        "duration": "null",
        "index": "0",
        "isFinalStage": "false",
        "linearShift": "false",
        "requireApproval": "false",
        "targetPercentage": "25"
      }
    ],
    "startedAt": "1716210500000",
    "state": "ACTIVE",
    "substate": "PAUSED",
    "updatedAt": "1716210600000"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idOrNamestringRequired
Project ID or project name (URL-encoded)

Query parameters

statestringOptional
Filter by rolling release state
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
rollingReleaseobjectRequired
Rolling release information including configuration and document details, or null if no rolling release exists

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error