public.services.view

GET

/services/{service_uuid}

const url = 'https://rest.watchtower15.com/v1/services/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/services/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

http

Parameters

Path Parameters

service_uuid

required

string format: uuid

Responses

200

ServicesViewResource

application/json

object

data

required

ServicesViewResource

object

uuid

required

string

name

required

string

protocol

required

tcp, udp, http or https: how the service is checked.

string

host

required

string

port

required

integer

path

required

The request path, without its query string.

string | null

request_method

required

string | null

expected_http_statuses

required

The HTTP statuses that count as up; empty means the status is not checked.

Array<integer>

timeout_seconds

required

integer

check_interval_seconds

required

integer

active

required

Whether monitoring is switched on.

boolean

response_monitor_enabled

required

boolean

response_type

required

string | null

tls_verify

required

boolean

follow_redirects

required

boolean

status

required

One of up, down, pending (no reachability result yet) and suspended (switched off).

string

Allowed values: suspended pending up down

health_status

required

One of unknown, healthy, warning, critical: the effective health (no collectors reads unknown).

string

collector_status

required

The collector pool’s state: active and standby, or why it is not (needs_collectors, failing, …).

string

collector_status_reason

required

string | null

pool_mode

required

single, failover or quorum.

string

collector_last_result_at

required

Epoch milliseconds: when a collector last reported a result.

integer | null

latest_reachability

required

The latest scored reachability result; null until one completes.

object

is_reachable

required

boolean | null

response_time_ms

required

integer | null

error_message

required

string | null

checked_at

required

Epoch milliseconds.

integer | null

latest_response

required

The latest scored response check; null until one completes.

object

is_up

required

boolean | null

http_status_code

required

integer | null

status_match

required

boolean | null

body_match

required

boolean | null

response_time_ms

required

integer | null

content_type

required

string | null

error_message

required

string | null

checked_at

required

Epoch milliseconds.

integer | null

tags

required

Array<object>

object

uuid

required

string

name

required

string

console_url

required

The service’s page in the console.

string

Example

{
  "data": {
    "status": "suspended"
  }
}

401

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

application/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

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

application/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

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

application/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

The request is invalid; errors names the parameters.

application/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

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

application/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

An unexpected error.

application/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
}

public.services.view

Authorizations

Parameters

Path Parameters

Responses

200

Example

401

Example generated

403

Example generated

404

Example generated

422

Example generated

429

Example generated

500

Example generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated