Rolling Releases
Control how a new deployment receives production traffic for your project. You can start and advance a rolling release, update its settings, or roll back to a previous production deployment.
Update the active rolling release to the next stage for a project.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | Project ID or project name (URL-encoded) |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Complete the rolling release for the project.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | Project ID or project name (URL-encoded) |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Get the active rolling release information for a project.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | Project ID or project name (URL-encoded) |
state | string | No | Filter by rolling release state Allowed values: "ACTIVE", "COMPLETE", "ABORTED". |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Get rolling release billing status.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | Project ID or project name (URL-encoded) |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Get rolling release configuration.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | Project ID or project name (URL-encoded) |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Gets a list of aliases with status for the current promote.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project ID. |
limit | number | No | Maximum number of aliases to list from a request (max 100). |
since | number | No | Get aliases created after this epoch timestamp. |
until | number | No | Get aliases created before this epoch timestamp. |
failedOnly | boolean | No | Filter results down to aliases that failed to map to the requested deployment |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Point production traffic to a given deployment.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project ID. |
deploymentId | string | Yes | The deployment ID. |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | unknown | No | Request body for this tool. |
Point production traffic to a previous production deployment by ID.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project ID. |
deploymentId | string | Yes | The ID of the deployment to rollback to |
description | string | No | The reason for the rollback |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | unknown | No | Request body for this tool. |
Start a rolling release for the project.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | Project ID or project name (URL-encoded) |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Update the rolling release settings for the project.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idOrName | string | Yes | Project ID or project name (URL-encoded) |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | unknown | No | Request body for this tool. |
Was this helpful?