public.servers.view
const url = 'https://rest.watchtower15.com/v1/servers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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://rest.watchtower15.com/v1/servers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”ServersViewResource
object
object
The display name when one is set, else the hostname.
The source address of the agent’s last heartbeat.
From the latest system-information scan; null until one is pushed.
The logical core count; null until the agent reports it, never a guessed 1.
Epoch milliseconds: when the host booted, null when its agent never reported it.
The host’s own time zone, as its agent reports it.
Null until an agent that reports it pushes system information.
One of unknown, healthy, warning, critical.
Whether monitoring is switched on.
Epoch milliseconds; null for a server that is not archived.
object
One of active, pending_approval, revoked.
What the agent can do, as it reported.
Epoch milliseconds.
Connected, catching up, delayed, unreachable, rejected, powered off or never seen: an open set.
object
Null with no usage sample, never 0.
Used / (used + free), what df prints; null with no sample.
Null for a filesystem that keeps no inode count.
object
Whether the interface is up.
object
Alarms firing at critical, over the server’s own alarms and its volumes’, ports’ and units’.
Alarms the evaluator does not score.
Of the firing ones, the acknowledged.
object
String, name: string}|null Null only when the tag’s group is gone.
object
The server’s page in the console.
Example generated
{ "data": { "uuid": "example", "name": "example", "hostname": "example", "ip_address": "example", "os_type": "example", "os_name": "example", "os_version": "example", "kernel_version": "example", "cpu_model": "example", "cpu_cores": 1, "total_memory_mb": 1, "booted_at": 1, "timezone": "example", "utc_offset_seconds": 1, "in_container": true, "health_status": "example", "active": true, "archived_at": 1, "agent": { "status": "example", "version": "example", "capabilities": [ "example" ], "last_seen_at": 1, "connectivity_state": "example" }, "disks": [ { "mount_point": "example", "device": "example", "filesystem_type": "example", "total_gb": 1, "used_gb": 1, "free_gb": 1, "used_percent": 1, "inodes_used_percent": 1 } ], "network_interfaces": [ { "interface_name": "example", "ipv4_address": "example", "ipv6_address": "example", "is_up": true } ], "alarm_summary": { "critical": 1, "warning": 1, "ok": 1, "inactive": 1, "acknowledged": 1 }, "tags": [ { "uuid": "example", "name": "example", "group": { "uuid": "example", "name": "example" } } ], "console_url": "example" }}The API key is missing, malformed, expired or revoked.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}The key or its owner does not hold what the operation needs.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}No such record in this organisation (an absent id and another organisation’s answer alike).
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}The request is invalid; errors names the parameters.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}A rate limit or the organisation’s daily limit is reached; Retry-After says when to retry.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}An unexpected error.
object
https://docs.watchtower15.com/api/errors/<code>/
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "code": "example", "detail": "example", "request_id": "example", "errors": { "additionalProperty": [ "example" ] }, "limit": 1, "used": 1}