Control Plane
Operations of the Control Plane API. Paths are relative to your deployment's API host.
GET /api/control-plane-api/control-plane/resources/{kind}
List managed resources of a kind for the org.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
kind | path | string | yes | XemaResourceKind wire value. |
managedKey | query | string | no | Only for kind project: return only the project whose managedKey (<namespace>:<id>) equals this value, or an empty list. Any other kind, or a malformed key, is refused with 400. |
| Status | Description | Body |
|---|---|---|
| 200 | application/json ResourceDtoDataArrayEnvelope |
POST /api/control-plane-api/control-plane/resources/{kind}
Create a managed resource of a kind.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
kind | path | string | yes |
Request body: application/json ResourceSpecDto
| Status | Description | Body |
|---|---|---|
| 201 | application/json ResourceHandleDtoDataEnvelope |
GET /api/control-plane-api/control-plane/resources/{kind}/{id}
Get a single managed resource by physical id.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | |
kind | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json ResourceDtoDataEnvelope |
PUT /api/control-plane-api/control-plane/resources/{kind}/{id}
Update a managed resource by physical id.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | |
kind | path | string | yes |
Request body: application/json ResourceSpecDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json ResourceDtoDataEnvelope |
DELETE /api/control-plane-api/control-plane/resources/{kind}/{id}
Delete a managed resource by physical id.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | |
kind | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 204 |
GET /api/control-plane-api/control-plane/stacks
List the org's stacks with their persisted resource counts.
Authentication: bearer token (Authorization: Bearer <token>)
| Status | Description | Body |
|---|---|---|
| 200 | application/json StackSummaryDtoDataArrayEnvelope |
POST /api/control-plane-api/control-plane/stacks/{name}/apply
Apply a manifest to a stack, persisting mappings + hashes.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes |
Request body: application/json StackManifestDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json StackApplyResultDtoDataEnvelope |
GET /api/control-plane-api/control-plane/stacks/{name}/export
Render the stack's managed resources as a XemaManifest.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json StackExportDtoDataEnvelope |
POST /api/control-plane-api/control-plane/stacks/{name}/import
Adopt existing live resources into the stack (no mutation).
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes |
Request body: application/json StackManifestDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json object |
POST /api/control-plane-api/control-plane/stacks/{name}/plan
Compute a side-effect-free plan for a manifest against a stack.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes |
Request body: application/json StackManifestDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json ResourcePlanDtoDataEnvelope |