[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>"

1 [
2   {
3     "id": "01JB9GGTGQYEQ9D40R17T3YVW2",
4     "discriminator": "template",
5     "name": "My release plan",
6     "createdByUserId": 53,
7     "createdAt": "2022-01-01T00:00:00Z",
8     "description": "This is my release plan",
9     "project": "my-project",
10     "milestones": [
11       {
12         "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
13         "name": "My milestone",
14         "sortOrder": 1,
15         "releasePlanDefinitionId": "01JB9GGTGQYEQ9D40R17T3YVW2",
16         "startedAt": "2024-01-01T00:00:00.000Z",
17         "transitionCondition": {
18           "intervalMinutes": 30
19         },
20         "progressionExecutedAt": "2024-01-01T00:00:00.000Z",
21         "pausedAt": "2024-01-01T00:00:00.000Z",
22         "strategies": [
23           {
24             "id": "01JB9GGTGQYEQ9D40R17T3YVW3",
25             "milestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
26             "sortOrder": 9999,
27             "name": "flexibleRollout",
28             "strategyName": "flexibleRollout",
29             "title": "Gradual Rollout 25-Prod",
30             "parameters": {
31               "groupId": "some_new",
32               "rollout": "25",
33               "stickiness": "sessionId"
34             },
35             "constraints": [
36               {
37                 "contextName": "appName",
38                 "operator": "IN",
39                 "caseInsensitive": false,
40                 "inverted": false,
41                 "values": [
42                   "1",
43                   "2"
44                 ]
45               }
46             ],
47             "variants": [
48               {
49                 "name": "blue_group",
50                 "weight": 1,
51                 "weightType": "fix",
52                 "stickiness": "custom.context.field",
53                 "payload": {
54                   "type": "json",
55                   "value": "{\"color\": \"red\"}"
56                 }
57               }
58             ],
59             "segments": [
60               1,
61               2
62             ],
63             "disabled": false
64           }
65         ]
66       }
67     ],
68     "archivedAt": "2022-01-01T00:00:00Z"
69   }
70 ]

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

Errors

401

Unauthorized Error