[BETA] Create a release template.

POST

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

POST

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

$ curl -X POST https://app.unleash-instance.example.com/api/admin/projects/projectId/release-templates \
>      -H "Authorization: <apiKey>"

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

Enterprise feature

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

Creates and returns a release template scoped to the project.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Path parameters

projectIdstringRequired

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.

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

409

Conflict Error