API-referens
Alla HTTP-slutpunkter i modulen lifecycle: autentisering, IAM-åtgärd, parametrar, innehåll och statuskoder.
Genererad från modulens kod när dess image byggdes — redigera inte. Sökvägarna är relativa till https://api.example.com.
Docs
GET /docs/lifecycle/manifest.json
- Autentisering: krävs
- Operationsnamn:
DocsManifest_lifecycle
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
GET /docs/lifecycle/{path}
- Autentisering: krävs
- Operationsnamn:
DocsFile_lifecycle
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
path |
sökväg | string |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token |
Lifecycle
GET /lifecycle/backups
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
POST /lifecycle/backups
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/execute— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/execute på det utvärderade omfånget |
POST /lifecycle/backups/archiving/resume
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/backupsManage— utvärderas på plattformens rot
Begärans innehåll: ArchivingClusterRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/backupsManage på det utvärderade omfånget |
POST /lifecycle/backups/archiving/suspend
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/backupsManage— utvärderas på plattformens rot
Begärans innehåll: ArchivingClusterRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/backupsManage på det utvärderade omfånget |
GET /lifecycle/backups/conditions
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
GET /lifecycle/backups/schedule
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
PUT /lifecycle/backups/schedule
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/backupsManage— utvärderas på plattformens rot
Begärans innehåll: UpdateBackupScheduleRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/backupsManage på det utvärderade omfånget |
GET /lifecycle/backups/target
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
PUT /lifecycle/backups/target
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/backupsManage— utvärderas på plattformens rot
Begärans innehåll: BackupTargetRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/backupsManage på det utvärderade omfånget |
POST /lifecycle/backups/target/test
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/backupsManage— utvärderas på plattformens rot
Begärans innehåll: BackupTargetRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/backupsManage på det utvärderade omfånget |
GET /lifecycle/components
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
POST /lifecycle/components/refresh
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
GET /lifecycle/components/{name}
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
name |
sökväg | string |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
POST /lifecycle/components/{name}/install
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/install— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
name |
sökväg | string |
Ja |
Begärans innehåll: StartInstallRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/install på det utvärderade omfånget |
GET /lifecycle/components/{name}/installspec
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
name |
sökväg | string |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
POST /lifecycle/components/{name}/repair
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/install— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
name |
sökväg | string |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/install på det utvärderade omfånget |
GET /lifecycle/dependencies
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
GET /lifecycle/drift
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
GET /lifecycle/installs
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
GET /lifecycle/installs/{installId}
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
installId |
sökväg | uuid |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
POST /lifecycle/installs/{installId}/resume
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/install— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
installId |
sökväg | uuid |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/install på det utvärderade omfånget |
GET /lifecycle/platform-drift
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
POST /lifecycle/platform-drift/adopt
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/execute— utvärderas på plattformens rot
Begärans innehåll: AdoptPlatformDriftRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/execute på det utvärderade omfånget |
POST /lifecycle/platform-drift/scan
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/plan— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/plan på det utvärderade omfånget |
GET /lifecycle/preflight
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
planId |
frågesträng | uuid |
Nej |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
POST /lifecycle/preflight/projector-ceiling/apply
- Autentisering: krävs
- IAM-åtgärd:
rbac/projector/apply— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
dryRun |
frågesträng | boolean |
Nej |
release |
frågesträng | string |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte rbac/projector/apply på det utvärderade omfånget |
GET /lifecycle/releases
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
component |
frågesträng | string |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
GET /lifecycle/rollouts/executions
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
POST /lifecycle/rollouts/executions
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/execute— utvärderas på plattformens rot
Begärans innehåll: CreateExecutionRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/execute på det utvärderade omfånget |
GET /lifecycle/rollouts/executions/{executionId}
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
executionId |
sökväg | uuid |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
POST /lifecycle/rollouts/executions/{executionId}/cancel
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/execute— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
executionId |
sökväg | uuid |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/execute på det utvärderade omfånget |
POST /lifecycle/rollouts/executions/{executionId}/resume
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/execute— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
executionId |
sökväg | uuid |
Ja |
Begärans innehåll: ResumeExecutionRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/execute på det utvärderade omfånget |
POST /lifecycle/rollouts/executions/{executionId}/revert-platform-drift
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/execute— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
executionId |
sökväg | uuid |
Ja |
Begärans innehåll: RevertPlatformDriftRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/execute på det utvärderade omfånget |
POST /lifecycle/rollouts/executions/{executionId}/rollback
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/rollback— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
executionId |
sökväg | uuid |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/rollback på det utvärderade omfånget |
GET /lifecycle/rollouts/plans
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
POST /lifecycle/rollouts/plans
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/plan— utvärderas på plattformens rot
Begärans innehåll: CreatePlanRequest
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/plan på det utvärderade omfånget |
GET /lifecycle/rollouts/plans/{planId}
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/view— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
planId |
sökväg | uuid |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/view på det utvärderade omfånget |
POST /lifecycle/rollouts/plans/{planId}/validate
- Autentisering: krävs
- IAM-åtgärd:
lifecycle/plan— utvärderas på plattformens rot
Parametrar
| Namn | Plats | Typ | Obligatorisk |
|---|---|---|---|
planId |
sökväg | uuid |
Ja |
Svar
| Status | Betydelse | Innehåll |
|---|---|---|
200 |
OK | |
401 |
Inte inloggad, eller ogiltig token | |
403 |
Anroparen har inte lifecycle/plan på det utvärderade omfånget |
Övriga slutpunkter
GET /readyz
- Autentisering: ingen — anonyma anrop accepteras
- Operationsnamn:
StackshipReadiness
Svar
| Status | Betydelse | Innehåll |
|---|
Scheman
AdoptPlatformDriftRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
acknowledge |
boolean |
Nej |
configKey |
string |
Ja |
liveValue |
any |
Ja |
scanId |
uuid |
Ja |
ArchivingClusterRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
name |
string |
Nej |
namespace |
string |
Nej |
BackupTargetRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
accessKeyId |
string |
Nej |
bucket |
string |
Nej |
caCertificate |
string |
Ja |
checksumAlgorithm |
string |
Ja |
endpoint |
string |
Ja |
provider |
string |
Ja |
region |
string |
Ja |
secretAccessKey |
string |
Nej |
CreateExecutionRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
acknowledgedFailures |
string [] |
Ja |
planId |
uuid |
Nej |
CreatePlanRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
excludeDependencies |
string [] |
Ja |
targetVersions |
map (string) |
Nej |
PlatformDriftDto
| Egenskap | Typ | Kan vara null |
|---|---|---|
component |
string |
Nej |
field |
string |
Ja |
kind |
string |
Ja |
manager |
string |
Ja |
message |
string |
Ja |
name |
string |
Ja |
namespace |
string |
Ja |
step |
string |
Ja |
ResumeExecutionRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
acknowledgedFailures |
string [] |
Ja |
RevertPlatformDriftRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
acknowledge |
boolean |
Nej |
fields |
PlatformDriftDto [] |
Ja |
StartInstallRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
secretInputs |
map (string) |
Ja |
version |
string |
Ja |
UpdateBackupScheduleRequest
| Egenskap | Typ | Kan vara null |
|---|---|---|
cron |
string |
Ja |
paused |
boolean |
Ja |
ttlHours |
integer |
Ja |