API reference
Every HTTP endpoint of the lifecycle module: authentication, IAM action, parameters, bodies and status codes.
Generated from the module's code when its image was built — do not edit. Paths are relative to https://api.example.com.
Docs
GET /docs/lifecycle/manifest.json
- Authentication: required
- Operation name:
DocsManifest_lifecycle
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
GET /docs/lifecycle/{path}
- Authentication: required
- Operation name:
DocsFile_lifecycle
Parameters
| Name | In | Type | Required |
|---|---|---|---|
path |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
Lifecycle
GET /lifecycle/backups
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
POST /lifecycle/backups
- Authentication: required
- IAM action:
lifecycle/execute— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/execute at the evaluated scope |
POST /lifecycle/backups/archiving/resume
- Authentication: required
- IAM action:
lifecycle/backupsManage— evaluated at the platform root
Request body: ArchivingClusterRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/backupsManage at the evaluated scope |
POST /lifecycle/backups/archiving/suspend
- Authentication: required
- IAM action:
lifecycle/backupsManage— evaluated at the platform root
Request body: ArchivingClusterRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/backupsManage at the evaluated scope |
GET /lifecycle/backups/conditions
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
GET /lifecycle/backups/schedule
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
PUT /lifecycle/backups/schedule
- Authentication: required
- IAM action:
lifecycle/backupsManage— evaluated at the platform root
Request body: UpdateBackupScheduleRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/backupsManage at the evaluated scope |
GET /lifecycle/backups/target
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
PUT /lifecycle/backups/target
- Authentication: required
- IAM action:
lifecycle/backupsManage— evaluated at the platform root
Request body: BackupTargetRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/backupsManage at the evaluated scope |
POST /lifecycle/backups/target/test
- Authentication: required
- IAM action:
lifecycle/backupsManage— evaluated at the platform root
Request body: BackupTargetRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/backupsManage at the evaluated scope |
GET /lifecycle/components
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
POST /lifecycle/components/refresh
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
GET /lifecycle/components/{name}
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
POST /lifecycle/components/{name}/install
- Authentication: required
- IAM action:
lifecycle/install— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
name |
path | string |
Yes |
Request body: StartInstallRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/install at the evaluated scope |
GET /lifecycle/components/{name}/installspec
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
POST /lifecycle/components/{name}/repair
- Authentication: required
- IAM action:
lifecycle/install— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/install at the evaluated scope |
GET /lifecycle/dependencies
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
GET /lifecycle/drift
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
GET /lifecycle/installs
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
GET /lifecycle/installs/{installId}
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
installId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
POST /lifecycle/installs/{installId}/resume
- Authentication: required
- IAM action:
lifecycle/install— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
installId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/install at the evaluated scope |
GET /lifecycle/platform-drift
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
POST /lifecycle/platform-drift/adopt
- Authentication: required
- IAM action:
lifecycle/execute— evaluated at the platform root
Request body: AdoptPlatformDriftRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/execute at the evaluated scope |
POST /lifecycle/platform-drift/scan
- Authentication: required
- IAM action:
lifecycle/plan— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/plan at the evaluated scope |
GET /lifecycle/preflight
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
planId |
query | uuid |
No |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
POST /lifecycle/preflight/projector-ceiling/apply
- Authentication: required
- IAM action:
rbac/projector/apply— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
dryRun |
query | boolean |
No |
release |
query | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold rbac/projector/apply at the evaluated scope |
GET /lifecycle/releases
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
component |
query | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
GET /lifecycle/rollouts/executions
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
POST /lifecycle/rollouts/executions
- Authentication: required
- IAM action:
lifecycle/execute— evaluated at the platform root
Request body: CreateExecutionRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/execute at the evaluated scope |
GET /lifecycle/rollouts/executions/{executionId}
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
executionId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
POST /lifecycle/rollouts/executions/{executionId}/cancel
- Authentication: required
- IAM action:
lifecycle/execute— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
executionId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/execute at the evaluated scope |
POST /lifecycle/rollouts/executions/{executionId}/resume
- Authentication: required
- IAM action:
lifecycle/execute— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
executionId |
path | uuid |
Yes |
Request body: ResumeExecutionRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/execute at the evaluated scope |
POST /lifecycle/rollouts/executions/{executionId}/revert-platform-drift
- Authentication: required
- IAM action:
lifecycle/execute— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
executionId |
path | uuid |
Yes |
Request body: RevertPlatformDriftRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/execute at the evaluated scope |
POST /lifecycle/rollouts/executions/{executionId}/rollback
- Authentication: required
- IAM action:
lifecycle/rollback— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
executionId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/rollback at the evaluated scope |
GET /lifecycle/rollouts/plans
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
POST /lifecycle/rollouts/plans
- Authentication: required
- IAM action:
lifecycle/plan— evaluated at the platform root
Request body: CreatePlanRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/plan at the evaluated scope |
GET /lifecycle/rollouts/plans/{planId}
- Authentication: required
- IAM action:
lifecycle/view— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
planId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/view at the evaluated scope |
POST /lifecycle/rollouts/plans/{planId}/validate
- Authentication: required
- IAM action:
lifecycle/plan— evaluated at the platform root
Parameters
| Name | In | Type | Required |
|---|---|---|---|
planId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold lifecycle/plan at the evaluated scope |
Other endpoints
GET /readyz
- Authentication: none — anonymous callers are accepted
- Operation name:
StackshipReadiness
Responses
| Status | Meaning | Body |
|---|
Schemas
AdoptPlatformDriftRequest
| Property | Type | Nullable |
|---|---|---|
acknowledge |
boolean |
No |
configKey |
string |
Yes |
liveValue |
any |
Yes |
scanId |
uuid |
Yes |
ArchivingClusterRequest
| Property | Type | Nullable |
|---|---|---|
name |
string |
No |
namespace |
string |
No |
BackupTargetRequest
| Property | Type | Nullable |
|---|---|---|
accessKeyId |
string |
No |
bucket |
string |
No |
caCertificate |
string |
Yes |
checksumAlgorithm |
string |
Yes |
endpoint |
string |
Yes |
provider |
string |
Yes |
region |
string |
Yes |
secretAccessKey |
string |
No |
CreateExecutionRequest
| Property | Type | Nullable |
|---|---|---|
acknowledgedFailures |
string [] |
Yes |
planId |
uuid |
No |
CreatePlanRequest
| Property | Type | Nullable |
|---|---|---|
excludeDependencies |
string [] |
Yes |
targetVersions |
map (string) |
No |
PlatformDriftDto
| Property | Type | Nullable |
|---|---|---|
component |
string |
No |
field |
string |
Yes |
kind |
string |
Yes |
manager |
string |
Yes |
message |
string |
Yes |
name |
string |
Yes |
namespace |
string |
Yes |
step |
string |
Yes |
ResumeExecutionRequest
| Property | Type | Nullable |
|---|---|---|
acknowledgedFailures |
string [] |
Yes |
RevertPlatformDriftRequest
| Property | Type | Nullable |
|---|---|---|
acknowledge |
boolean |
No |
fields |
PlatformDriftDto [] |
Yes |
StartInstallRequest
| Property | Type | Nullable |
|---|---|---|
secretInputs |
map (string) |
Yes |
version |
string |
Yes |
UpdateBackupScheduleRequest
| Property | Type | Nullable |
|---|---|---|
cron |
string |
Yes |
paused |
boolean |
Yes |
ttlHours |
integer |
Yes |