Get a release policy by key

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Retrieve a single release policy by its key for the specified project.

GET /api/v2/projects/{projectKey}/release-policies/{policyKey}

Get a release policy by key

cURL

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/release-policies/{policyKey} \
  --header 'Authorization: <api-key>' \
  --header 'LD-API-Version: <ld-api-version>'

200

{
  "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",
    "metricGroupKeys": [
      "frontend-metrics",
      "backend-metrics"
    ],
    "minSampleSize": 100,
    "stages": [
      {
        "allocation": 25000,
        "durationMillis": 60000
      },
      {
        "allocation": 25000,
        "durationMillis": 60000
      }
    ],
    "rollbackOnRegression": true
  },
  "key": "production-release"
}

Authorizations

Authorization · string · header · required

Headers

LD-API-Version · enum<string> · required

Version of the endpoint.

Available options: beta

Path Parameters

projectKey · string · required

The project key

policyKey · string · required

The release policy key

Response

200

application/json

Release policy found

_id · string · required

The unique identifier of the release policy

Example:

"550e8400-e29b-41d4-a716-446655440000"

rank · integer · required

The rank/priority of the release policy

Example:

1

releaseMethod · enum<string> · required

The release method for this policy

Available options: guarded-release, progressive-release

name · string · required

The name of the release policy

Maximum string length: 256

Example:

"Production Release"

key · string · required

The human-readable key of the release policy

Example:

"production-release"

_access · object

Show child attributes

Example:

{
  "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 · object

Show child attributes

Example:

{
  "environmentKeys": ["production", "staging"],
  "flagTagKeys": ["frontend", "backend"],
  "viewKeys": ["feature-a", "team-a"]
}

guardedReleaseConfig · object

Configuration for guarded releases

Show child attributes

Example:

{
  "metricKeys": ["http-errors", "latency"],
  "rolloutContextKindKey": "user",
  "metricGroupKeys": ["frontend-metrics", "backend-metrics"],
  "minSampleSize": 100,
  "stages": [
    {
      "allocation": 25000,
      "durationMillis": 60000
    },
    {
      "allocation": 25000,
      "durationMillis": 60000
    }
  ],
  "rollbackOnRegression": true
}

progressiveReleaseConfig · object

Configuration for progressive releases

Show child attributes

Example:

{
  "rolloutContextKindKey": "user",
  "stages": [
    {
      "allocation": 25000,
      "durationMillis": 60000
    },
    {
      "allocation": 25000,
      "durationMillis": 60000
    }
  ]
}