COcommpeak
Domains

Get domain

Changed on

Retrieve a single domain by its ID.

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

get/domains/{id}

Request

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

Path parameters

idinteger required

Unique identifier of the resource.

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
    • breaking

      added the new path request parameter id

    • info

      api operation id getDomain removed and replaced with get_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