For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
13.5kProductPricingSign inStart free trialBook a demo
DocsAPIsSDKsEnterprise EdgeGuidesAcademyRelease notes
DocsAPIsSDKsEnterprise EdgeGuidesAcademyRelease notes
    • API overview
  • Client API
  • Frontend API
  • Admin API
      • GETGet all release templates
      • POSTCreate a release template
      • GETGet a release template
      • PUTUpdate a release template
      • DELDelete a release template
      • POSTArchive a release template
      • POSTAdd a milestone
      • PUTUpdate a milestone
      • DELRemove a milestone
      • POSTAdd a strategy to milestone
      • PUTUpdate milestone strategy
      • DELRemove milestone strategy
      • GETGet release plans
      • POSTAdd a release plan
      • DELRemove a release plan
      • POSTStart a milestone

Unleash reduces the risk of releasing new features, drives innovation by streamlining the software release process, and increases revenue by optimizing end-user experience. While we serve the needs of the world's largest, most security-conscious organizations, we are also rated the “Easiest Feature Management system to use” by G2.

GitHubGitHubLinkedInLinkedInX (Twitter)X (Twitter)SlackSlackStack OverflowStack OverflowYouTubeYouTube

Server SDKs

  • Node.js
  • Java
  • Go
  • Rust
  • Ruby
  • Python
  • .NET
  • PHP
  • All SDKs

Frontend SDKs

  • JavaScript
  • React
  • Next.js
  • Vue
  • iOS
  • Android
  • Flutter

Feature Flag use cases

  • Secure, scalable feature flags
  • Rollbacks
  • FedRAMP, SOC2, ISO2700 compliance
  • Progressive or gradual rollouts
  • Trunk-based development
  • Software kill switches
  • A/B testing
  • Feature management
  • Canary releases

Product

  • Quickstart
  • Unleash architecture
  • Pricing
  • Product vision
  • Open live demo
  • Open source
  • Enterprise feature management platform
  • Unleash vs LaunchDarkly

Support

  • Help center
  • Status
  • Changelog
Made in a cosy atmosphere in the Nordic countries.Copyright © 2026 Unleash
LogoLogo
13.5kProductPricingSign inStart free trialBook a demo
Admin APIRelease templates

Start a milestone

||View as Markdown|
POST
https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/release-plans/:planId/milestones/:milestoneId/start
POST
/api/admin/projects/:project/features/:featureName/environments/:environment/release-plans/:planId/milestones/:milestoneId/start
$curl -X POST https://app.unleash-instance.example.com/api/admin/projects/project/features/featureName/environments/environment/release-plans/planId/milestones/milestoneId/start \
>     -H "Authorization: <apiKey>"
1{
2  "id": "01JB9GGTGQYEQ9D40R17T3YVW2",
3  "discriminator": "plan",
4  "name": "My release plan",
5  "featureName": "my-feature",
6  "environment": "production",
7  "createdByUserId": 53,
8  "createdAt": "2022-01-01T00:00:00Z",
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  "releasePlanTemplateId": "01JB9GGTGQYEQ9D40R17T3YVW2",
68  "description": "This is my release plan",
69  "activeMilestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
70  "safeguards": [
71    {
72      "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
73      "action": {
74        "type": "pauseReleasePlanProgressions",
75        "id": "01JB9GGTGQYEQ9D40R17T3YVW2"
76      },
77      "triggerCondition": {
78        "operator": ">",
79        "threshold": 100
80      },
81      "impactMetric": {
82        "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
83        "metricName": "unleash_counter_feature_toggle_usage_total",
84        "timeRange": "day",
85        "aggregationMode": "rps",
86        "labelSelectors": {
87          "environment": [
88            "development"
89          ],
90          "project": [
91            "default"
92          ]
93        },
94        "source": "internal"
95      }
96    }
97  ]
98}

Enterprise feature

Starts a release plan milestone for a specific feature flag and environment.

Was this page helpful?
Previous

Search features

Next
Built with

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Path parameters

projectstringRequired
featureNamestringRequired
environmentstringRequired
planIdstringRequired
milestoneIdstringRequired

Response

#/components/schemas/releasePlanSchema

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.
featureNamestring
The name of the feature that uses this release plan.
environmentstring
The environment that this release plan is for.
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.
milestoneslist of objects
A list of the milestones in this release template.
releasePlanTemplateIdstring
The ID of the release plan template that this release plan is based on.
descriptionstring or null
A description of the release template.
activeMilestoneIdstring or null
The ID of the currently active milestone in this release plan.
safeguardslist of objects
An array of safeguards configured for this release plan.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error