Domains

List domains

Returns the team's monitored domains, newest first unless you sort.

get/domains

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, from 1.

per_pageinteger

Domains per page, 1 to 100.

filter[view]'attention' | 'unsigned' | 'paused'

Domain list views; a domain can be in several.

attention <br/> Expired, or expiring within its expiry_threshold_days.
unsigned <br/> No DNSSEC keys.
paused <br/> Monitoring is paused.

Only domains in this view.

filter[project_id]string uuid

Only domains of this project.

filter[search]string

Case-insensitive text in the name, registrar or nameservers.

sortstring

Sort by name, expires_at (unknown expiry last) or created_at. Prefix - for descending. Default -created_at.

Response

Paginated set of Domain

current_pageinteger required
first_page_urlstring nullable required
frominteger nullable required
last_page_urlstring nullable required
last_pageinteger required
next_page_urlstring nullable required
pathstring nullable required

Base path for paginator generated URLs.

per_pageinteger required

Number of items shown per page.

prev_page_urlstring nullable required
tointeger nullable required

Number of the last item in the slice.

totalinteger required

Total number of items being paginated.

Example response

{
  "data": [
    {
      "name": "example.com",
      "registrar": "Example Registrar, Inc.",
      "days_until_expiration": 212,
      "dnssec_keys": [
        {
          "key_tag": 2371,
          "algorithm": 13,
          "digest_type": 2
        }
      ],
      "expiry_threshold_days": 30,
      "escalation_paths": [
        {
          "name": "On-call engineers"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.