Skip to content
logiccloud Orchestrate

List deployments awaiting removal confirmation

GET
/api/v1/deployments/awaiting-removal
curl --request GET \
  --url http://localhost:3000/api/v1/deployments/awaiting-removal \
  --header 'X-API-Key: <X-API-Key>'

Lists deployments that were deleted but that at least one device has not yet confirmed removing. A deployment leaves this list only when every device has reported removed; a device that reported failed keeps it here, because the workload may still be running.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
x-organization-id
string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

Section titled “Responses”

200

Section titled “200”

Deployments awaiting removal retrieved successfully

Media typeapplication/json
Array<object>
object
id
required

Deployment UUID

string
name
required

Deployment name

string
applicationName
required

Name of the application being removed (null if unavailable)

string
nullable
applicationVersion
required

Version of the application being removed (null if unavailable)

string
nullable
partial
required

FM-1301: true when the deployment is still live and was removed from some of its devices only. The counts below then cover only those devices.

boolean
removalRequestedAt
required

When removal was requested

string
nullable
total
required

Number of device instances the removal covers

number
confirmed
required

Devices that reported removed

number
awaiting
required

Devices asked to remove that have not reported a terminal state

number
failed
required

Devices that reported failed. The workload may still be running on these devices.

number
Examplegenerated
[
  {
    "id": "example",
    "name": "example",
    "applicationName": "example",
    "applicationVersion": "example",
    "partial": true,
    "removalRequestedAt": "example",
    "total": 1,
    "confirmed": 1,
    "awaiting": 1,
    "failed": 1
  }
]

403

Section titled “403”

Forbidden — caller lacks required permission