Skip to main content
POST
Create a release plan

Authorizations

Authorization
string
header
required

Scopes

read
write

Headers

LD-API-Version
enum<string>
required

Version of the endpoint.

Available options:
beta

Path Parameters

projectKey
string
required

The project key

environmentKey
string
required

The environment key

Body

application/json

Release plan to create

name
string
required

Human-readable name for this release plan

Maximum string length: 256
Example:

"Checkout flow rollout"

key
string
required

Unique key identifying this release plan within the project. Immutable once created. Unique only among active (non-deleted) plans — a soft-deleted plan's key can be reused by a new plan.

Required string length: 1 - 256
Pattern: ^[a-zA-Z0-9][._\-a-zA-Z0-9]*$
Example:

"checkout-flow-rollout"

progressiveRelease
object
required
Example:
description
string

Human-readable description of this release plan's purpose

Example:

"Standard rollout for checkout changes"

releaseMethod
enum<string>
default:progressive_release

Discriminates which nested config object is required

Available options:
progressive_release

Response

Release plan created successfully

_id
string<uuid>
required

The release plan's unique identifier

key
string
required

Unique key identifying this release plan within the project

Required string length: 1 - 256
Pattern: ^[a-zA-Z0-9][._\-a-zA-Z0-9]*$
name
string
required

Human-readable name for this release plan

Maximum string length: 256
environmentKey
string
required

The environment this release plan is scoped to

releaseMethod
enum<string>
required

Discriminates which nested config object is present

Available options:
progressive_release
version
integer<int64>
required

The release plan's version, starting at 1 and incremented on every update

progressiveRelease
object
required
Example:
description
string

Human-readable description of this release plan's purpose

createdAt
integer<int64>
updatedAt
integer<int64>
default
boolean
read-only

Whether this plan is the default for its environment. At most one active plan per environment is the default. Managed via the environment's default-release-plan sub-resource, not this request body.