Skip to content
WatchTower15Docs

public.servers.systemServices

GET
/servers/{server_uuid}/system-services
curl --request GET \
  --url 'https://rest.watchtower15.com/v1/servers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/system-services?include_total=true' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
server_uuid
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
limit
integer | null
>= 1 <= 100
cursor
string | null
<= 512 characters
include_total
string | null
Allowed values: true false 1 0

Responses

Section titled “Responses”

200

Section titled “200”

ServersSystemServicesResource

Media typeapplication/json
object
data
required
Array<object>
object
uuid
required
string
unit_name
required

The systemd unit’s name, e.g. nginx.service.

string
description
required
string | null
load_state
required

Systemd’s LoadState.

string | null
active_state
required

Systemd’s ActiveState.

string | null
sub_state
required

Systemd’s SubState.

string | null
unit_file_state
required

Systemd’s UnitFileState.

string | null
monitored
required

Whether the unit is monitored: only a monitored unit has alarms and store figures.

boolean
health_status
required

One of unknown, healthy, warning, critical.

string
restarts
required

Restarts in the range; null where the store has none.

integer | null
memory_bytes
required

Memory in bytes; null where the store has none.

integer | null
cpu_percent
required

The latest CPU as a percentage of one core, two decimals; null where not reported (not running, CPU accounting off, an older agent).

number | null
state_changed_at
required
integer | null
first_seen_at
required
integer | null
missing_since
required

Epoch milliseconds: since when a monitored unit has been missing from the last complete inventory.

integer | null
next_cursor
required
string | null
total

The whole list’s size; present only with include_total=true.

integer
meta
object
service_manager
required

systemd, systemd_no_bus, unsupported, disabled, or null for an agent without the collector.

string | null
reported_at
required
integer | null

Example generated

{
  "data": [
    {
      "uuid": "example",
      "unit_name": "example",
      "description": "example",
      "load_state": "example",
      "active_state": "example",
      "sub_state": "example",
      "unit_file_state": "example",
      "monitored": true,
      "health_status": "example",
      "restarts": 1,
      "memory_bytes": 1,
      "cpu_percent": 1,
      "state_changed_at": 1,
      "first_seen_at": 1,
      "missing_since": 1
    }
  ],
  "next_cursor": "example",
  "total": 1,
  "meta": {
    "service_manager": "example",
    "reported_at": 1
  }
}

401

Section titled “401”

The API key is missing, malformed, expired or revoked.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

403

Section titled “403”

The key or its owner does not hold what the operation needs.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

404

Section titled “404”

No such record in this organisation (an absent id and another organisation’s answer alike).

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

422

Section titled “422”

The request is invalid; errors names the parameters.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

429

Section titled “429”

A rate limit or the organisation’s daily limit is reached; Retry-After says when to retry.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

500

Section titled “500”

An unexpected error.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}