Get hostname config | Management API Reference

[Beta] Gets project's custom hostname config

get/v1/projects/{ref}/custom-hostname

OAuth scopes

domains:read

The fine-grained token must include the following permissions to access this endpoint:

custom_domain_read

Path parameters

ref
Required
string
Project ref

Response codes

Response (200)

1
{
2
  "status": "1_not_started",
3
  "custom_hostname": "lorem",
4
  "data": {
5
    "success": true,
6
    "errors": [
7
      "lorem"
8
    ],
9
    "messages": [
10
      "lorem"
11
    ],
12
    "result": {
13
      "id": "lorem",
14
      "hostname": "lorem",
15
      "ssl": {
16
        "status": "lorem",
17
        "validation_records": [
18
          {
19
            "txt_name": "lorem",
20
            "txt_value": "lorem"
21
          }
22
        ],
23
        "validation_errors": [
24
          {
25
            "message": "lorem"
26
          }
27
        ]
28
      },
29
      "ownership_verification": {
30
        "type": "lorem",
31
        "name": "lorem",
32
        "value": "lorem"
33
      },
34
      "custom_origin_server": "lorem",
35
      "verification_errors": [
36
        "lorem"
37
      ],
38
      "status": "lorem"
39
    }
40
  }
41
}