Skip to content
WatchTower15Docs

public.domains.list

GET
/domains
curl --request GET \
  --url 'https://rest.watchtower15.com/v1/domains?status=active&sort=name&direction=asc&include_total=true' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
search
string | null
<= 255 characters
status
string | null
Allowed values: active expired pending suspended
health
Array<string> | null
Allowed values: unknown healthy warning critical
registrar
string | null
<= 255 characters
tag_uuids
Array<string> | null
sort
string | null
Allowed values: name health registration_expiry ssl_expiry dns_last_change uptime
direction
string | null
Allowed values: asc desc
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”

DomainsListResource

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

apex, subdomain or wildcard.

string | null
status
required

One of active, expired, pending (no expiry scan yet) and suspended (switched off).

string
Allowed values: suspended pending expired active
health_status
required

One of unknown, healthy, warning, critical.

string
active
required

Whether monitoring is switched on.

boolean
registrar
required

The registrar of the latest expiry scan.

string | null
expiry_date
required

YYYY-MM-DD: the registration expiry of the latest expiry scan.

string | null
ssl_status
required

One of valid, warn (30 days or fewer left), expired; null with no certificate scan.

string | null
ssl_expiry_date
required

Epoch milliseconds: when the latest certificate expires.

integer | null
dns_last_changed_at
required

Epoch milliseconds: the last DNS change; null when it was the baseline scan.

integer | null
uptime_7d_percent
required

The last 7 days’ reachability, one decimal; null with no data.

number | null
scans_enabled
required

Which scan types are switched on.

object
expiry
required
boolean
dns
required
boolean
ssl
required
boolean
whois
required
boolean
reachability
required
boolean
console_url
required

The domain’s page in the console.

string
next_cursor
required
string | null
total

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

integer

Example 

{
  "data": [
    {
      "status": "suspended"
    }
  ]
}

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
}