Update the order of existing release policies

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

Update the order of existing release policies for the specified project.

POST /api/v2/projects/{projectKey}/release-policies/order

Update the order of existing release policies

cURL

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/release-policies/order \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'LD-API-Version: <ld-api-version>' \
  --data '[
  "<string>"
]'

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

Body

application/json

Array of release policy keys in the desired rank order (scoped policies only). These keys must include all of the scoped release policies for the project.

Response

200

application/json

Release policies updated successfully

_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
    }
  ]
}