Get all release templates | Unleash Documentation

curl https://app.unleash-instance.example.com/api/admin/release-plan-templates \
     -H "Authorization: <apiKey>"

{
  "id": "01JB9GGTGQYEQ9D40R17T3YVW2",
  "discriminator": "template",
  "name": "My release plan",
  "createdByUserId": 53,
  "createdAt": "2022-01-01T00:00:00Z",
  "description": "This is my release plan",
  "milestones": [
    {
      "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
          ]
        }
      ]
    }
  ],
  "archivedAt": "2022-01-01T00:00:00Z"
}

Enterprise feature

Returns a list of all release templates.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Response

#/components/schemas/releasePlanTemplateSchema

idstring

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

discriminatorenum

A field to distinguish between release plans and release templates.

Allowed values:

namestring

The name of the release template.

createdByUserIddouble

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

createdAtstringformat: "date-time"

The date and time that the release template was created.

descriptionstring or null

A description of the release template.

milestoneslist of objects or null

A list of the milestones in this release template.

archivedAtstring or nullformat: "date-time"

The date and time that the release template was archived.

Authentication

Response

Errors