servers.testConnectivity

POST

/servers/{serverId}/connectivity-tests

const url = 'https://example.com/api/servers/example/connectivity-tests';
const options = {method: 'POST'};

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

curl --request POST \
  --url https://example.com/api/servers/example/connectivity-tests

Tests whether Appaloft can reach and inspect a server. Public docs: /docs/servers/register-connect/#server-connectivity-test

Parameters

Path Parameters

serverId

required

string

>= 1 characters

Responses

200

application/json

object

serverId

required

string

name

required

string

host

required

string

port

required

number

providerKey

required

string

checkedAt

required

string

status

required

string

Allowed values: healthy degraded unreachable

checks

required

Array<object>

object

name

required

string

status

required

string

Allowed values: passed failed skipped

message

required

string

durationMs

required

number

metadata

object

key

additional properties

string

Example

{
  "status": "healthy",
  "checks": [
    {
      "status": "passed"
    }
  ]
}