Sign in

v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
Domains

Archive/Unarchive domain

Archive or unarchive a domain. Send archive: true to archive, or archive: false to restore it.

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

put/domains/archive/{id}

Request body

archiveboolean required

Set true to archive the domain, false to unarchive it.

Example request

{
  "archive": true
}

Response

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