Skip to content
ShipSquares

/servers/{id}/check

POST
/servers/{id}/check
 
curl --request POST \
  --url https://example.com/api/v1/servers/example/check

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
object
dockerOk
required
boolean
dockerVersion
required
Any of:
string
caddyOk
required
boolean
diskUsedPct
required
Any of:
number
diskUsedBytes
required
Any of:
number
diskTotalBytes
required
Any of:
number
reachable
required
boolean
lastCheckedAt
required
string format: date-time
Example generated
{
  "dockerOk": true,
  "dockerVersion": "example",
  "caddyOk": true,
  "diskUsedPct": 1,
  "diskUsedBytes": 1,
  "diskTotalBytes": 1,
  "reachable": true,
  "lastCheckedAt": "2026-04-15T12:00:00Z"
}

404

Section titled “404 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}