Sign in

v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
Domains

Add domain

Register a new domain. Only name is required; the assigned ip is returned for you to configure DNS.

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

post/domains

Request body

namestring required

The domain name to register.

Example request

{
  "name": "example.com"
}

Response

The created domain.

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"
}