Get deletion progress

GET

operations

{id}

curl --request GET \
  --url "https://api.bead.run/operations/$OPERATION_ID" \
  --header "X-API-Key: $BEAD_API_KEY"

{
  "operationID": "<string>",
  "status": "<string>",
  "statusURL": "<string>"
}

Check whether a machine deletion is still running or has completed.

Authentication

Send your scoped bearer token in the Authorization: Bearer <BEAD_TOKEN> header, or send your API key in X-API-Key.

Parameters

string

required

UUID of the deletion operation. Format: uuid.

curl --request GET \
  --url "https://api.bead.run/operations/$OPERATION_ID" \
  --header "X-API-Key: $BEAD_API_KEY"

Response

200

Machine deletion completed.

string

required

Deletion operation UUID.

string

required

Deletion completed. Allowed values: "deleted".

202

Machine cleanup is still running.

string

required

Deletion operation UUID.

string

required

Deletion is in progress. Allowed values: "deleting".

string

required

Relative URL to poll this operation.

Errors

Status	Meaning
400	Invalid resource UUID or request parameters.
401	Authentication credential is missing or rejected.
403	The credential lacks the required scope.
404	The requested resource does not exist or is outside your organization.
429	Request or resource admission limit exceeded (`admission_limit`). Follow limit.next_action and Retry-After when present.
503	Service or persistence is temporarily unavailable.

curl --request GET \
  --url "https://api.bead.run/operations/$OPERATION_ID" \
  --header "X-API-Key: $BEAD_API_KEY"

{
  "operationID": "<string>",
  "status": "<string>",
  "statusURL": "<string>"
}

Start here

Endpoints

Get deletion progress

Authentication

Parameters

Response

200

202

Errors

​Authentication

​Parameters

​Response

​200

​202

​Errors

Authentication

Parameters

Response

200

202

Errors