Control Plane API: schemas
The request and response bodies of the operations in this API.
ResourceChangeDto
| Property | Type | Required | Description |
|---|
action | object | yes | |
driftFromActual | boolean | no | |
kind | object | yes | |
logicalId | string | yes | |
physicalId | string | no | |
ResourceDto
| Property | Type | Required | Description |
|---|
kind | string (24 values) | yes | |
managedKey | string or null | yes | The owning service's natural key for the resource; null when it has none. |
physicalId | string | yes | Service-native physical id. |
spec | object | no | The live read-back spec (present on get/list). |
status | object | no | Observed, read-only state the owning service reports beside the spec (for example a revision). Never part of a declaration and never compared for drift; absent for a kind that reports none. |
ResourceDtoDataArrayEnvelope
| Property | Type | Required | Description |
|---|
data | array of ResourceDto | yes | |
ResourceDtoDataEnvelope
ResourceHandleDto
| Property | Type | Required | Description |
|---|
kind | string (24 values) | yes | |
managedKey | string or null | yes | The created resource's natural key; null when it has none (a project created without a managedKey). |
physicalId | string | yes | |
ResourceHandleDtoDataEnvelope
ResourcePlanDto
| Property | Type | Required | Description |
|---|
changes | array of ResourceChangeDto | yes | |
driftDetected | boolean | yes | |
stackName | string | yes | |
ResourcePlanDtoDataEnvelope
ResourceSpecDto
| Property | Type | Required | Description |
|---|
spec | object | yes | Kind-native resource spec, forwarded verbatim to the owning service. |
StackApplyResultDto
| Property | Type | Required | Description |
|---|
created | number | yes | |
retired | number | yes | |
stackName | string | yes | |
unchanged | number | yes | |
updated | number | yes | |
StackApplyResultDtoDataEnvelope
StackExportDto
| Property | Type | Required | Description |
|---|
manifest | object | yes | |
StackExportDtoDataEnvelope
StackManifestDto
| Property | Type | Required | Description |
|---|
manifest | object | yes | A xema/v1 manifest (XemaManifest). Re-validated on receipt. |
StackSummaryDto
| Property | Type | Required | Description |
|---|
createdAt | string (date-time) | yes | |
name | string | yes | Stack name, unique within the org. |
resourceCount | number | yes | Persisted managed-resource mappings. Not a live drift check. |
schemaVersion | number | yes | Resource-contract schema version the mappings were written against. |
updatedAt | string (date-time) | yes | |
StackSummaryDtoDataArrayEnvelope