v18

latestOpenAPI 3.0.32026-08-07378889.6 MB

rolling-release

Get rolling release configuration

Get the Rolling Releases configuration for a project. The project-level config is simply a template that will be used for any future rolling release, and not the configuration for any active rolling release.

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

Path parameters

idOrNamestring required

Project ID or project name (URL-encoded)

Query parameters

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": {
    "target": "production",
    "stages": [
      {
        "targetPercentage": 25,
        "duration": 600
      }
    ],
    "gate": {
      "checks": [
        {
          "minSampleSize": 100,
          "excludeStatusCodes": [
            503
          ],
          "excludePaths": [
            "/api/health"
          ],
          "ingestWatermarkSeconds": 30
        }
      ],
      "failureThreshold": 3,
      "windowSize": 5
    }
  }
}