Add a release plan | Unleash Documentation

import requests
url = "https://app.unleash-instance.example.com/api/admin/projects/project/features/featureName/environments/environment/release-plans"
payload = { "templateId": "01JB9GGTGQYEQ9D40R17T3YVW2" }
headers = {
    "Authorization": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "01JB9GGTGQYEQ9D40R17T3YVW2",
  "discriminator": "plan",
  "name": "My release plan",
  "featureName": "my-feature",
  "environment": "production",
  "createdByUserId": 53,
  "createdAt": "2022-01-01T00:00:00Z",
  "milestones": [
    {
      "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
      "name": "My milestone",
      "sortOrder": 1,
      "releasePlanDefinitionId": "01JB9GGTGQYEQ9D40R17T3YVW2",
      "startedAt": "2024-01-01T00:00:00.000Z",
      "transitionCondition": {
        "intervalMinutes": 30
      },
      "progressionExecutedAt": "2024-01-01T00:00:00.000Z",
      "pausedAt": "2024-01-01T00:00:00.000Z",
      "strategies": [
        {
          "id": "01JB9GGTGQYEQ9D40R17T3YVW3",
          "milestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
          "sortOrder": 9999,
          "strategyName": "flexibleRollout",
          "title": "Gradual Rollout 25-Prod",
          "parameters": {
            "groupId": "some_new",
            "rollout": "25",
            "stickiness": "sessionId"
          },
          "constraints": [
            {
              "contextName": "appName",
              "operator": "IN",
              "caseInsensitive": false,
              "inverted": false,
              "values": [
                "1",
                "2"
              ]
            }
          ],
          "variants": [
            {
              "name": "blue_group",
              "weight": 1,
              "weightType": "fix",
              "stickiness": "custom.context.field",
              "payload": {
                "type": "json",
                "value": "{\"color\": \"red\"}"
              }
            }
          ],
          "segments": [
            1,
            2
          ]
        }
      ]
    }
  ],
  "releasePlanTemplateId": "01JB9GGTGQYEQ9D40R17T3YVW2",
  "description": "This is my release plan",
  "activeMilestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
  "safeguards": [
    {
      "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
      "action": {
        "type": "pauseReleasePlanProgressions",
        "id": "01JB9GGTGQYEQ9D40R17T3YVW2"
      },
      "triggerCondition": {
        "operator": ">",
        "threshold": 100
      },
      "impactMetric": {
        "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
        "metricName": "unleash_counter_feature_toggle_usage_total",
        "timeRange": "day",
        "aggregationMode": "rps",
        "labelSelectors": {
          "environment": [
            "development"
          ],
          "project": [
            "default"
          ]
        }
      }
    }
  ]
}

Enterprise feature

Adds a release plan to a specific feature flag and environment.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

projectstringRequired

featureNamestringRequired

environmentstringRequired

Request

#/components/schemas/releasePlanTemplateIdSchema

templateIdstringRequired

The release plan template's ID. Release template IDs are ulids.

Response

#/components/schemas/releasePlanSchema

idstring

The release plan/template’s ID. Release template IDs are ulids.

discriminatorenum

A field to distinguish between release plans and release templates.

Allowed values:

namestring

The name of the release template.

featureNamestring

The name of the feature that uses this release plan.

environmentstring

The environment that this release plan is for.

createdByUserIddouble

Release template: The ID of the user who created this template.

createdAtstringformat: "date-time"

The date and time that the release template was created.

milestoneslist of objects

A list of the milestones in this release template.

releasePlanTemplateIdstring

The ID of the release plan template that this release plan is based on.

descriptionstring or null

A description of the release template.

activeMilestoneIdstring or null

The ID of the currently active milestone in this release plan.

safeguardslist of objects or null

An array of safeguards configured for this release plan.

Authentication

Path parameters

Request

Response

Errors