Skip to content
WatchTower15Docs

public.domains.scans

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Query Parameters

Section titled “Query Parameters”
type
required
string
Allowed values: dns expiry ssl
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”

DomainsScansResource

Media typeapplication/json
object
data
required
Array<object>
object
uuid
required
string
status
required
string
outcome
required
string | null
completed_at
required
integer | null
execution_time_ms
required
integer | null
error_message
required
string | null
has_changes
boolean | null
records
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>
registrar
string | null
registration_date
string | null
expiry_date
string | null
updated_date
string | null
days_until_expiry
integer | null
is_expired
boolean | null
nameservers
Array<string>
status_codes
Array<string>
common_name
string | null
issuer_cn
string | null
issuer_org
string | null
valid_from
integer | null
valid_until
integer | null
is_self_signed
boolean | null
chain_valid
boolean | null
next_cursor
required
string | null
total

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

integer

Example generated

{
  "data": [
    {
      "uuid": "example",
      "status": "example",
      "outcome": "example",
      "completed_at": 1,
      "execution_time_ms": 1,
      "error_message": "example",
      "has_changes": true,
      "records": {
        "a": [
          "example"
        ],
        "aaaa": [
          "example"
        ],
        "mx": [
          "example"
        ],
        "txt": [
          "example"
        ],
        "cname": [
          "example"
        ],
        "ns": [
          "example"
        ],
        "soa": [
          "example"
        ],
        "caa": [
          "example"
        ]
      },
      "registrar": "example",
      "registration_date": "example",
      "expiry_date": "example",
      "updated_date": "example",
      "days_until_expiry": 1,
      "is_expired": true,
      "nameservers": [
        "example"
      ],
      "status_codes": [
        "example"
      ],
      "common_name": "example",
      "issuer_cn": "example",
      "issuer_org": "example",
      "valid_from": 1,
      "valid_until": 1,
      "is_self_signed": true,
      "chain_valid": true
    }
  ],
  "next_cursor": "example",
  "total": 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
}