Skip to main content

Create a release template.

POST 

<your-unleash-url>/api/admin/release-plan-templates

Creates and returns a release template.

Responses

#/components/schemas/releasePlanTemplateSchema

Schema
    idstringrequired

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

    Example: 01JB9GGTGQYEQ9D40R17T3YVW2
    discriminatorstringrequired

    A field to distinguish between release plans and release templates.

    Possible values: [template]

    Example: template
    namestringrequired

    The name of the release template.

    Example: My release plan
    descriptionstringnullable

    A description of the release template.

    Example: This is my release plan
    createdByUserIdnumberrequired

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

    Example: 53
    createdAtdate-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 [
  • idstringrequired

    The milestone's ID. Milestone IDs are ulids.

    Example: 01JB9GGTGQYEQ9D40R17T3YVW1
    namestringrequired

    The name of the milestone.

    Example: My milestone
    sortOrderintegerrequired

    The order of the milestone in the release plan.

    Example: 1
    releasePlanDefinitionIdstringrequired

    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 [
  • idstringrequired

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

    Example: 01JB9GGTGQYEQ9D40R17T3YVW3
    milestoneIdstringrequired

    The ID of the milestone that this strategy belongs to.

    Example: 01JB9GGTGQYEQ9D40R17T3YVW1
    sortOrdernumberrequired

    The order of the strategy in the list

    Example: 9999
    titlestringnullable

    A descriptive title for the strategy

    Example: Gradual Rollout 25-Prod
    strategyNamestringrequired

    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/activation-strategies#constraints

  • Array [
  • contextNamestringrequired

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

    Example: appName
    operatorstringrequired

    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
    caseInsensitiveboolean

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

    Default value: false
    invertedboolean

    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
    valuesstring[]

    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"]
    valuestring

    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 [
  • namestringrequired

    The variant name. Must be unique for this feature flag

    Example: blue_group
    weightintegerrequired

    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

    weightTypestringrequired

    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
    stickinessstringrequired

    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

    typestringrequired

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

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

    valuestringrequired

    The actual value of payload

  • ]
  • segmentsnumber[]

    Ids of segments to use for this strategy

    Example: [1,2]
  • ]
  • ]

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
curl -L -X POST '<your-unleash-url>/api/admin/release-plan-templates' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'
Request Collapse all
Base URL
<your-unleash-url>
Auth
ResponseClear

Click the Send API Request button above and see the response here!