Skip to content
You're viewing documentation for v2026.11.11-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Probe server hardware specs

Probe server hardware specs live and persist the result.

POST/api/v1/servers/{id}/specs
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Responses
200

OK

errorstring
specsServerSpecsResponse
Show properties
archstring
disksDiskInfo[]required
Show properties
Array of DiskInfo
avail_bytesinteger<int64>
diskstring
mountstringrequired
namestringrequired
size_bytesinteger<int64>required
used_bytesinteger<int64>
listening_portsinteger<int64>[]
memory_total_bytesinteger<int64>required
os_idstring
os_versionstring
pg_cpu_limitinteger<int64>
pg_data_dirsstring[]
pg_memory_limit_bytesinteger<int64>
python_okboolean
shell_cleanboolean
sudo_msinteger<int64>
sudo_okboolean
var_lib_avail_bytesinteger<int64>
vcpusinteger<int64>required
statusstringrequired
default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X POST 'https://console.example.com/api/v1/servers/string/specs' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "error": "string",
  "specs": {
    "arch": "string",
    "disks": [
      {
        "avail_bytes": 0,
        "disk": "string",
        "mount": "string",
        "name": "string",
        "size_bytes": 0,
        "used_bytes": 0
      }
    ],
    "listening_ports": [
      0
    ],
    "memory_total_bytes": 0,
    "os_id": "string",
    "os_version": "string",
    "pg_cpu_limit": 0,
    "pg_data_dirs": [
      "string"
    ],
    "pg_memory_limit_bytes": 0,
    "python_ok": true,
    "shell_clean": true,
    "sudo_ms": 0,
    "sudo_ok": true,
    "var_lib_avail_bytes": 0,
    "vcpus": 0
  },
  "status": "string"
}