Get a release policy by key | LaunchDarkly

curl https://app.launchdarkly.com/api/v2/projects/default/release-policies/production-release \
     -H "LD-API-Version: beta" \
     -H "Authorization: <apiKey>"

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

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

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequired

The project key

policyKeystringRequired

The release policy key

Response

Release policy found

_idstring

The unique identifier of the release policy

rankinteger

The rank/priority of the release policy

releaseMethodenum

The release method for this policy

Allowed values:

namestring<=256 characters

The name of the release policy

keystring

The human-readable key of the release policy

_accessobject

scopeobject

guardedReleaseConfigobject

Configuration for guarded releases

progressiveReleaseConfigobject

Configuration for progressive releases

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors