Release Templates

Get all release templates.

Enterprise feature

Returns a list of all global release templates.

get/api/admin/release-plan-templates

Response

#/components/schemas/releasePlanTemplatesSchema

idstring required

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

discriminator'template' required

A field to distinguish between release plans and release templates.

namestring required

The name of the release template.

descriptionstring nullable

A description of the release template.

projectstring nullable

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

createdByUserIdnumber required

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

createdAtstring date-time required

The date and time that the release template was created.

archivedAtstring date-time nullable

The date and time that the release template was archived.

Example response

[
  {
    "id": "01JB9GGTGQYEQ9D40R17T3YVW2",
    "discriminator": "template",
    "name": "My release plan",
    "description": "This is my release plan",
    "project": "my-project",
    "createdByUserId": 53,
    "createdAt": "2022-01-01T00:00:00Z",
    "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,
            "title": "Gradual Rollout 25-Prod",
            "name": "flexibleRollout",
            "strategyName": "flexibleRollout",
            "constraints": [
              {
                "values": [
                  "1",
                  "2"
                ],
                "inverted": false,
                "operator": "IN",
                "contextName": "appName",
                "caseInsensitive": false
              }
            ],
            "variants": [
              {
                "name": "blue_group",
                "weightType": "fix",
                "stickiness": "custom.context.field",
                "payload": {
                  "type": "json",
                  "value": "{\"color\": \"red\"}"
                }
              }
            ],
            "segments": [
              1,
              2
            ]
          }
        ]
      }
    ],
    "archivedAt": "2022-01-01T00:00:00Z"
  }
]

Changes

Changed in 2 of the 7 revisions of this API.651

  • b2c3116e633e21See the full diff
    • added the new SEMVER_GTE enum value to the /////// response property for the response status

      response-property-enum-value-added

    • added the new SEMVER_LTE enum value to the /////// response property for the response status

      response-property-enum-value-added

    • added the optional property / to the response with the status

      response-optional-property-added

  • 774670258f0463See the full diff
    • the response's body type changed from object to array for status

      response-body-type-changed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the required property from the response with the status

      response-required-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog