This feature is in beta
To use this feature, pass in a header including the
LD-API-Version
key with value set tobeta
. Use this header with each call. To learn more, read Beta resources.Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible.
Release pipelines track the progression of a feature flag across a series of phases, where each phase consists of one or more environments. When you add a flag to a release pipeline, you create a "release" to track that flag's progress through the pipeline.
You can use release pipelines to ensure that you correctly roll out the flag in each environment before moving on to the next. You can also use them to view the status of ongoing releases across all flags within a project, enforcing a standardized process and ensuring they are following best practices. To learn more, read Release pipelines.
With the release pipelines API, you can view, create, and delete release pipelines.
With the related releases API, you can view and update the active releases for a given flag.
Get all release pipelines for a project
Release pipeline collection
Invalid resource identifier
{- "items": [
- {
- "createdAt": "1684262711507",
- "description": "Standard pipeline to roll out to production",
- "key": "standard-pipeline",
- "name": "Standard Pipeline",
- "phases": [
- {
- "id": "1234a56b7c89d012345e678f",
- "audiences": [
- {
- "environment": {
- "key": null,
- "name": null,
- "color": null
}, - "name": "Phase 1 - Testing"
}
], - "name": "Phase 1 - Testing"
}
], - "tags": [
- "example-tag"
], - "_version": 1
}
], - "totalCount": 1
}
Creates a new release pipeline
Release pipeline response
Invalid request
Forbidden
Invalid resource identifier
Status conflict
{- "description": "Standard pipeline to roll out to production",
- "key": "standard-pipeline",
- "name": "Standard Pipeline",
- "phases": [
- {
- "audiences": [
- {
- "environmentKey": "string",
- "name": "string"
}
], - "name": "Phase 1 - Testing"
}
], - "tags": [
- "example-tag"
]
}
{- "createdAt": "1684262711507",
- "description": "Standard pipeline to roll out to production",
- "key": "standard-pipeline",
- "name": "Standard Pipeline",
- "phases": [
- {
- "id": "1234a56b7c89d012345e678f",
- "audiences": [
- {
- "environment": {
- "key": "environment-key-123abc",
- "name": "My Environment",
- "color": "F5A623"
}, - "name": "Phase 1 - Testing"
}
], - "name": "Phase 1 - Testing"
}
], - "tags": [
- "example-tag"
], - "_version": 1
}
Get a release pipeline by key
Release pipeline response
Invalid resource identifier
{- "createdAt": "1684262711507",
- "description": "Standard pipeline to roll out to production",
- "key": "standard-pipeline",
- "name": "Standard Pipeline",
- "phases": [
- {
- "id": "1234a56b7c89d012345e678f",
- "audiences": [
- {
- "environment": {
- "key": "environment-key-123abc",
- "name": "My Environment",
- "color": "F5A623"
}, - "name": "Phase 1 - Testing"
}
], - "name": "Phase 1 - Testing"
}
], - "tags": [
- "example-tag"
], - "_version": 1
}
Delete a release pipeline
Action succeeded
Forbidden
Invalid resource identifier
{- "code": "forbidden",
- "message": "Forbidden. Access to the requested resource was denied."
}