servers.deleteCheck

GET

/servers/{serverId}/delete-check

const url = 'https://example.com/api/servers/example/delete-check';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/servers/example/delete-check

Previews whether a deployment target can be safely deleted. Public docs: /docs/servers/register-connect/#server-deployment-target

Parameters

Path Parameters

serverId

required

string

>= 1 characters

Responses

200

application/json

object

schemaVersion

required

string

Allowed value: servers.delete-check/v1

serverId

required

string

lifecycleStatus

required

string

Allowed values: active inactive

eligible

required

boolean

blockers

required

Array<object>

object

kind

required

string

Allowed values: active-server deployment-history active-deployment resource-placement domain-binding certificate credential source-link server-applied-route default-access-policy terminal-session runtime-task runtime-log-retention audit-retention

relatedEntityId

string

relatedEntityType

string

count

number

checkedAt

required

string

Example

{
  "schemaVersion": "servers.delete-check/v1",
  "lifecycleStatus": "active",
  "blockers": [
    {
      "kind": "active-server"
    }
  ]
}