v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Release policies (beta)

Create a release policy

Create a new release policy for the specified project.

post/api/v2/projects/{projectKey}/release-policies

Path parameters

projectKeystring required

The project key

Headers

LD-API-Version'beta' required

Version of the endpoint.

Request body

releaseMethod'guarded-release' | 'progressive-release' required

The release method for this policy

namestring required

The name of the release policy

keystring required

The human-readable key of the release policy

Example request

{
  "releaseMethod": "guarded-release",
  "scope": {
    "environmentKeys": [
      "production",
      "staging"
    ],
    "flagTagKeys": [
      "frontend",
      "backend"
    ],
    "viewKeys": [
      "feature-a",
      "team-a"
    ]
  },
  "progressiveReleaseConfig": {
    "rolloutContextKindKey": "user",
    "stages": [
      {
        "allocation": 25000,
        "durationMillis": 60000
      },
      {
        "allocation": 25000,
        "durationMillis": 60000
      }
    ]
  },
  "name": "Production Release",
  "guardedReleaseConfig": {
    "metricKeys": [
      "http-errors",
      "latency"
    ],
    "rolloutContextKindKey": "user",
    "metricRegressionThreshold": 0.05,
    "metricGroupKeys": [
      "frontend-metrics",
      "backend-metrics"
    ],
    "minSampleSize": 100,
    "stages": [
      {
        "allocation": 25000,
        "durationMillis": 60000
      },
      {
        "allocation": 25000,
        "durationMillis": 60000
      }
    ],
    "rollbackOnRegression": true
  },
  "key": "production-release"
}

Response

Release policy created successfully

_idstring required

The unique identifier of the release policy

rankinteger required

The rank/priority of the release policy

releaseMethod'guarded-release' | 'progressive-release' required

The release method for this policy

namestring required

The name of the release policy

keystring required

The human-readable key of the release policy

Example response

{
  "releaseMethod": "guarded-release",
  "_access": {
    "allowed": [
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      },
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      }
    ],
    "denied": [
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      },
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      }
    ]
  },
  "scope": {
    "environmentKeys": [
      "production",
      "staging"
    ],
    "flagTagKeys": [
      "frontend",
      "backend"
    ],
    "viewKeys": [
      "feature-a",
      "team-a"
    ]
  },
  "progressiveReleaseConfig": {
    "rolloutContextKindKey": "user",
    "stages": [
      {
        "allocation": 25000,
        "durationMillis": 60000
      },
      {
        "allocation": 25000,
        "durationMillis": 60000
      }
    ]
  },
  "name": "Production Release",
  "rank": 1,
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "guardedReleaseConfig": {
    "metricKeys": [
      "http-errors",
      "latency"
    ],
    "rolloutContextKindKey": "user",
    "metricRegressionThreshold": 0.05,
    "metricGroupKeys": [
      "frontend-metrics",
      "backend-metrics"
    ],
    "minSampleSize": 100,
    "stages": [
      {
        "allocation": 25000,
        "durationMillis": 60000
      },
      {
        "allocation": 25000,
        "durationMillis": 60000
      }
    ],
    "rollbackOnRegression": true
  },
  "key": "production-release"
}