Release Templates

Adds a strategy to a milestone.

Changed on

Enterprise feature

Finds milestone identified by its id and adds a strategy.

post/api/admin/release-plan-templates/{templateId}/milestones/{milestoneId}/strategies

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/release-plan-templates/{templateId}/milestones/{milestoneId}/strategies
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

templateIdstring required
milestoneIdstring required

Response

#/components/schemas/releasePlanMilestoneSchema

idstring required

The milestone's ID. Milestone IDs are ulids.

namestring required

The name of the milestone.

sortOrderinteger required

The order of the milestone in the release plan.

releasePlanDefinitionIdstring required

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

startedAtstring date-time nullable

The date and time when the milestone was started.

progressionExecutedAtstring date-time nullable

The date and time when the milestone progression was executed.

pausedAtstring date-time nullable

The date and time when the milestone was paused.

Example response

{
  "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,
      "title": "Gradual Rollout 25-Prod",
      "name": "flexibleRollout",
      "strategyName": "flexibleRollout",
      "constraints": [
        {
          "values": [
            "1",
            "2"
          ],
          "inverted": false,
          "operator": "IN",
          "contextName": "appName",
          "caseInsensitive": false
        }
      ],
      "variants": [
        {
          "name": "blue_group",
          "weightType": "fix",
          "stickiness": "custom.context.field",
          "payload": {
            "type": "json",
            "value": "{\"color\": \"red\"}"
          }
        }
      ],
      "segments": [
        1,
        2
      ]
    }
  ]
}

Changes

  • b2c3116e633eRevision changes
    • warning

      added the new SEMVER_GTE enum value to the //// response property for the response status

    • warning

      added the new SEMVER_LTE enum value to the //// response property for the response status

  • 774670258f04Revision changes
    • warning

      added the new REGEX enum value to the //// response property for the response status

    • info

      endpoint deprecated (stability: stable)

    • info

      added the optional property // to the response with the status

    • info

      response property strategies/items/strategyName deprecated (stability: stable)

    • info

      added the required property // to the response with the status