[BETA] Get all release templates.

GET

https://app.unleash-instance.example.com/api/admin/projects/:projectId/release-templates

GET

/api/admin/projects/:projectId/release-templates

curl https://app.unleash-instance.example.com/api/admin/projects/projectId/release-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",
    "project": "my-project",
    "milestones": [
      {
        "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
        "name": "My milestone",
        "sortOrder": 1,
        "releasePlanDefinitionId": "01JB9GGTGQYEQ9D40R17T3YVW2",
        "startedAt": "2024-01-01T00:00:00.000Z",
        "transitionCondition": {},
        "progressionExecutedAt": "2024-01-01T00:00:00.000Z",
        "pausedAt": "2024-01-01T00:00:00.000Z",
        "strategies": [
          {
            "id": "01JB9GGTGQYEQ9D40R17T3YVW3",
            "milestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
            "sortOrder": 9999,
            "name": "flexibleRollout",
            "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
            ],
            "disabled": false
          }
        ]
      }
    ],
    "archivedAt": "2022-01-01T00:00:00Z"
  }
]

Enterprise feature

[BETA] This API is in beta state, which means it may change or be removed in the future.

Returns a list of release templates scoped to the project. Use include=root to also include global release templates.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Path parameters

projectIdstringRequired

Query parameters

includestringOptional

Whether the response should include global release templates in addition to the release templates scoped to the project. Use include=root to include global release templates in the response. Without it, only release templates scoped to the project are returned.

Response

#/components/schemas/releasePlanTemplatesSchema

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 nullOptional

A description of the release template.

projectstring or nullOptional

The project this release template belongs to. null for global release templates available in all projects.

milestoneslist of objectsOptional

A list of the milestones in this release template.

archivedAtstring or nullOptionalformat: "date-time"

The date and time that the release template was archived.

Errors

401

Unauthorized Error