Create a release template.

POST 
/api/admin/release-plan-templates

Creates and returns a release template.

Responses

200

#/components/schemas/releasePlanTemplateSchema

application/json

Schema

Schema

id stringrequired
The release plan/template's ID. Release template IDs are ulids.
Example: 01JB9GGTGQYEQ9D40R17T3YVW2
discriminator stringrequired
A field to distinguish between release plans and release templates.
Possible values: [template]
Example: template
name stringrequired
The name of the release template.
Example: My release plan
description stringnullable
A description of the release template.
Example: This is my release plan
createdByUserId numberrequired
Release template: The ID of the user who created this template.
Example: 53
createdAt date-timerequired
The date and time that the release template was created.
Example: 2022-01-01T00:00:00Z

milestones

object[]

A list of the milestones in this release template.

Array [

id stringrequired

The milestone's ID. Milestone IDs are ulids.

Example: 01JB9GGTGQYEQ9D40R17T3YVW1

name stringrequired

The name of the milestone.

Example: My milestone

sortOrder integerrequired

The order of the milestone in the release plan.

Example: 1

releasePlanDefinitionId stringrequired

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

Example: 01JB9GGTGQYEQ9D40R17T3YVW2

strategies

object[]

A list of strategies that are attached to this milestone.

Array [

id stringrequired

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

Example: 01JB9GGTGQYEQ9D40R17T3YVW3

milestoneId stringrequired

The ID of the milestone that this strategy belongs to.

Example: 01JB9GGTGQYEQ9D40R17T3YVW1

sortOrder numberrequired

The order of the strategy in the list

Example: 9999

title stringnullable

A descriptive title for the strategy

Example: Gradual Rollout 25-Prod

strategyName stringrequired

The name of the strategy type

Example: flexibleRollout

parameters

object

A list of parameters for a strategy

property name* string

constraints

object[]

A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints

Array [

contextName stringrequired

The name of the context field that this constraint should apply to.

Example: appName

operator stringrequired

The operator to use when evaluating this constraint. For more information about the various operators, refer to the strategy constraint operator documentation.

Possible values: [NOT_IN, IN, STR_ENDS_WITH, STR_STARTS_WITH, STR_CONTAINS, NUM_EQ, NUM_GT, NUM_GTE, NUM_LT, NUM_LTE, DATE_AFTER, DATE_BEFORE, SEMVER_EQ, SEMVER_GT, SEMVER_LT]

Example: IN

caseInsensitive boolean

Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

Default value: false

inverted boolean

Whether the result should be negated or not. If true, will turn a true result into a false result and vice versa.

Default value: false

values string[]

The context values that should be used for constraint evaluation. Use this property instead of value for properties that accept multiple values.

Example: ["my-app","my-other-app"]

value string

The context value that should be used for constraint evaluation. Use this property instead of values for properties that only accept single values.

Example: my-app

]

variants

object[]

Strategy level variants

Array [

name stringrequired

The variant name. Must be unique for this feature flag

Example: blue_group

weight integerrequired

The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on variant weights for more information

Possible values: <= 1000

weightType stringrequired

Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the variant weight documentation.

Possible values: [variable, fix]

Example: fix

stickiness stringrequired

The stickiness to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time

Example: custom.context.field

payload

object

Extra data configured for this variant

type stringrequired

The type of the value. Commonly used types are string, number, json and csv.

Possible values: [json, csv, string, number]

value stringrequired

The actual value of payload

]

segments number[]

Ids of segments to use for this strategy

Example: [1,2]

]

]

Example (from schema)

{
  "id": "01JB9GGTGQYEQ9D40R17T3YVW2",
  "discriminator": "template",
  "name": "My release plan",
  "description": "This is my release plan",
  "createdByUserId": 53,
  "createdAt": "2022-01-01T00:00:00Z",
  "milestones": [
    {
      "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
      "name": "My milestone",
      "sortOrder": 1,
      "releasePlanDefinitionId": "01JB9GGTGQYEQ9D40R17T3YVW2",
      "strategies": [
        {
          "id": "01JB9GGTGQYEQ9D40R17T3YVW3",
          "milestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
          "sortOrder": 9999,
          "title": "Gradual Rollout 25-Prod",
          "strategyName": "flexibleRollout",
          "parameters": {
            "groupId": "some_new",
            "rollout": "25",
            "stickiness": "sessionId"
          },
          "constraints": [
            {
              "values": [
                "1",
                "2"
              ],
              "inverted": false,
              "operator": "IN",
              "contextName": "appName",
              "caseInsensitive": false
            }
          ],
          "variants": [
            {
              "name": "blue_group",
              "weight": 0,
              "weightType": "fix",
              "stickiness": "custom.context.field",
              "payload": {
                "type": "json",
                "value": "{\"color\": \"red\"}"
              }
            }
          ],
          "segments": [
            1,
            2
          ]
        }
      ]
    }
  ]
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

Loading...