COcommpeak
Domains

Add domain

Changed on

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

A new domain starts as NOT_CONFIGURED (or VALIDATION_PENDING while it is reviewed) until its DNS points at ip. A name that already exists on your account is rejected with 500.

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

post/domains

Request

  • Base URL
    https://api.commpeak.com/textpeak
  • URL
    https://api.commpeak.com/textpeak/domains
  • Auth
    API key in header Authorization

Request body

namestring required

The domain name to register. Must not already exist on your account.

Example request

{
  "name": "demo.example.com"
}

Response

Successful Response

idinteger required

Unique domain identifier.

namestring required

The domain name.

ipstring required

IP address the domain must point to (an A record). Set by TextPeak; read-only.

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

Example response

{
  "id": 12,
  "ip": "192.0.2.10",
  "name": "demo.example.com",
  "status": "NOT_CONFIGURED"
}

Changes

  • 5012671cf95dRevision changes
    • warning

      the request property's maxLength was set to 255

    • info

      api operation id addDomain removed and replaced with create_domain

    • info

      the endpoint scheme security APIKeyHeader was added to the API

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status