Start a milestone (deprecated) | Unleash Documentation

import requests
url = "https://app.unleash-instance.example.com/api/admin/projects/project/features/featureName/environments/environment/release_plans/planId/milestones/milestoneId/start"
headers = {"Authorization": "<apiKey>"}
response = requests.post(url, headers=headers)
print(response.json())

{
  "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
      ]
    }
  ]
}

Enterprise feature

Starts a release plan milestone for a specific feature flag and environment. Deprecated, please use /release-plans/:planId/milestones/:milestoneId/start instead.

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

planIdstringRequired

milestoneIdstringRequired

Response

#/components/schemas/releasePlanMilestoneSchema

idstring

The milestone's ID. Milestone IDs are ulids.

namestring

The name of the milestone.

sortOrderinteger

The order of the milestone in the release plan.

releasePlanDefinitionIdstring

The ID of the release plan/template that this milestone belongs to.

startedAtstring or nullformat: "date-time"

The date and time when the milestone was started.

transitionConditionobject or null

The condition configuration for the transition

progressionExecutedAtstring or nullformat: "date-time"

The date and time when the milestone progression was executed.

pausedAtstring or nullformat: "date-time"

The date and time when the milestone was paused.

strategieslist of objects or null

A list of strategies that are attached to this milestone.

Authentication

Path parameters

Response

Errors