Skip to content
Appaloft 文档 v0.6.0

servers.testDraftConnectivity

POST
/servers/connectivity-tests
 
curl --request POST \
  --url https://example.com/api/servers/connectivity-tests \
  --header 'Content-Type: application/json' \
  --data '{ "server": { "name": "example", "host": "example", "providerKey": "example", "port": 1, "credential": { "kind": "local-ssh-agent", "username": "example" } } }'

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

Request Body required

Section titled “Request Body required ”
Media type application/json
object
server
required
object
name
string
>= 1 characters
host
required
string
>= 1 characters
providerKey
required
string
>= 1 characters
port
integer
> 0 <= 9007199254740991
credential
One of:
object
kind
required
string
Allowed value: local-ssh-agent
username
string
>= 1 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type 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"
    }
  ]
}