List domains

get

https://{hostname}/domain-validation/v1/domains

Returns the list of available domains. By default, the results are paginated. You can disable pagination to retrieve all domains at once, but if the number of domains exceeds the allowed limit, the request returns a 409 Conflict error. In that case, use the pagination parameters to retrieve the full set of results.

Responses

Response body

object

Represents a response to listing domains.

domains

array of objects

required

length ≥ 0

List of returned domains.

domains*

object

Represents the domain details.

accountId

string

required

ID of an account.

domainName

string

required

Name of the domain.

domainStatus

string

enum

required

Validation status of the domain, either REQUEST_ACCEPTED, VALIDATION_IN_PROGRESS, VALIDATED, TOKEN_EXPIRED, or INVALIDATED. Read more about validation statuses.

REQUEST_ACCEPTED VALIDATION_IN_PROGRESS VALIDATED TOKEN_EXPIRED INVALIDATED

validationChallenge

Validation challenge | Empty object

Validation challenge of the domain.

validationCompletedDate

date-time

Timestamp of completing the validation.

validationMethod

string

enum

Method of the domain validation, either DNS_CNAME, DNS_TXT, HTTP, SYSTEM, or MANUAL. Read more about validation methods.

DNS_CNAME DNS_TXT HTTP SYSTEM MANUAL

validationRequestedBy

string

required

Name of the user who requested domain validation.

validationRequestedDate

date-time

required

Timestamp of the request.

validationScope

string

enum

required

Scope of the domain validation, either HOST, WILDCARD, or DOMAIN. Read more about validation scopes.

HOST WILDCARD DOMAIN

links

array of objects

length ≥ 0

Links to navigate between pages.

links

object

Represents the links section of a paginated API response.

href

string

required

Hyperlink reference of the page.

rel

string

enum

required

Type of link. either prev, next, or self.

prev next self

metadata

object

Represents the metadata section of a paginated API response.

hasNext

boolean

required

Whether the next page is available.

hasPrevious

boolean

required

Whether the previous page is available.

page

integer

required

Page number.

pageSize

integer

required

Size of the page.

totalRecords

integer

required

Total number of records available.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/domain-validation/v1/domains \
3
     --header 'accept: application/json'


xxxxxxxxxx
81
}
1
{
2
  "domains": [
3
    {
4
      "accountId": "A-CCT1234",
5
      "domainName": "example.com",
6
      "domainStatus": "VALIDATED",
7
      "validationChallenge": {},
8
      "validationCompletedDate": "2024-02-06T06:01:45Z",
9
      "validationMethod": "SYSTEM",
10
      "validationRequestedBy": "SYSTEM",
11
      "validationRequestedDate": "2024-02-06T06:01:45Z",
12
      "validationScope": "HOST"
13
    },
14
    {
15
      "accountId": "A-CCT3456",
16
      "domainName": "exists.example.com",
17
      "domainStatus": "REQUEST_ACCEPTED",
18
      "validationChallenge": {
19
        "cnameRecord": {
20
          "name": "_acme-challenge.exists.example.com",
21
          "target": "ac.e88730008a54281e9c147468782c4c16.example.com.validate-akdv.net"
22
        },
23
        "expirationDate": "2024-05-14T05:25:56Z",
24
        "httpFile": {
25
          "content": "u8oHMAKRRo3z3HyTUEtnZoUn8a9ix7idu8M12AnN7tcj1fvNycOo0A",
26
          "contentType": "text/plain",
27
          "path": "http://exists.example.com/.well-known/akamai/akamai-challenge/gn-SqMCmDbjCwlpk77fMtw"
28
        },
29
        "httpRedirect": {
30
          "from": "http://exists.example.com/.well-known/akamai/akamai-challenge/gn-SqMCmDbjCwlpk77fMtw",
31
          "to": "http://validation.akamai.com/.well-known/akamai/akamai-challenge/u8oHMAKRRo3z3HyTUEtnZoUn8a9ix7idu8M12AnN7tcj1fvNycOo0A"
32
        },
33
        "txtRecord": {
34
          "name": "_akamai-host-challenge.exists.example.com",
35
          "value": "u8oHMAKRRo3z3HyTUEtnZoUn8a9ix7idu8M12AnN7tcj1fvNycOo0A"
36
        }
37
      },
38
      "validationRequestedBy": "monagara",
39
      "validationRequestedDate": "2024-02-06T06:01:45Z",
40
      "validationScope": "HOST"
41
    },
42
    {
43
      "accountId": "A-CCT3456",
44
      "domainName": "example.com",
45
      "domainStatus": "REQUEST_ACCEPTED",
46
      "validationChallenge": {
47
        "cnameRecord": {
48
          "name": "_acme-challenge.example.com",
49
          "target": "ac.e88730008a54281e9c147468782c4c16.example.com.validate-akdv.net"

200The response shows available domains.

400Bad request.

401Unauthorized.

403Forbidden.

405Method not allowed.

409Conflict.

500Internal server error.