Sign in
Domains

Get All Domains

List all domains in your account.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

get/domains

Query parameters

_pageinteger

Page number (1-based).

itemsPerPageinteger

Items per page.

Response

The list of domains.

idinteger

Unique domain identifier.

namestring

The domain name.

ipstring

IP address the domain should point to (read-only).

status'NOT_CONFIGURED' | 'CONFIGURED' | 'VALIDATION_PENDING' | 'VALIDATION_DECLINED' | 'ARCHIVED' | 'LIMIT_REACHED'

Domain configuration status.

Example response

[
  {
    "id": 12,
    "name": "example.com",
    "ip": "192.0.2.10",
    "status": "CONFIGURED"
  }
]

Changes

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