Release Templates

Updates a strategy attached to a milestone

Changed on

Enterprise feature

Overwrites existing strategy configuration for the strategy referenced by the id

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

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/{strategyId}
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

templateIdstring required
milestoneIdstring required
strategyIdstring required

Response

#/components/schemas/releasePlanMilestoneStrategySchema

idstring required

The milestone strategy's ID. Milestone strategy IDs are ulids.

milestoneIdstring required

The ID of the milestone that this strategy belongs to.

sortOrdernumber required

The order of the strategy in the list

titlestring nullable

A descriptive title for the strategy

namestring required

The name of the strategy type

strategyNamestring required

The name of the strategy type

parametersParametersSchema

A list of parameters for a strategy

segmentsnumber[]

Ids of segments to use for this strategy

disabledboolean nullable

A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs

Example response

{
  "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 strategyName deprecated (stability: stable)

    • info

      added the required property to the response with the status