Skip to content
WatchTower15Docs

public.domains.view

GET
/domains/{domain_uuid}
curl --request GET \
  --url https://rest.watchtower15.com/v1/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”

DomainsViewResource

Media typeapplication/json
object
data
required
DomainsViewResource
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
checks
required

Which reachability endpoints are checked.

object
https_www
required
boolean
https_non_www
required
boolean
http_www
required
boolean
http_non_www
required
boolean
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
registration
required

The latest completed expiry scan; null until one completes.

object
registrar
required
string | null
registration_date
required

YYYY-MM-DD.

string | null
expiry_date
required

YYYY-MM-DD.

string | null
updated_date
required

YYYY-MM-DD.

string | null
days_until_expiry
required
integer | null
is_expired
required
boolean
nameservers
required
Array<string>
status_codes
required
Array<string>
checked_at
required

Epoch milliseconds.

integer | null
certificate
required

The latest completed certificate scan; null until one completes.

object
common_name
required
string | null
issuer_cn
required
string | null
issuer_org
required
string | null
valid_from
required

Epoch milliseconds.

integer | null
valid_until
required

Epoch milliseconds.

integer | null
days_until_expiry
required
integer | null
is_expired
required
boolean | null
is_self_signed
required
boolean | null
chain_valid
required
boolean | null
ssl_status
required

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

string | null
dns
required

The newest completed DNS scan; null with none.

object
checked_at
required

Epoch milliseconds.

integer | null
records
required
object
a
required
Array<string>
aaaa
required
Array<string>
mx
required
Array<string>
txt
required
Array<string>
cname
required
Array<string>
ns
required
Array<string>
soa
required
Array<string>
caa
required
Array<string>
next_scans
required

When each scan type runs next.

array
>= 3 items <= 3 items
tags
required
Array<object>
object
uuid
required
string
name
required
string
console_url
required

The domain’s page in the console.

string

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
}