Skip to content
Management API Reference

[Beta] Updates project's custom hostname configuration

post/v1/projects/{ref}/custom-hostname/initialize

OAuth scopes

  • domains:write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • custom_hostname
    Required
    string

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

Response (201)

1
{
2
"status": "1_not_started",
3
"custom_hostname": "lorem",
4
"data": {
5
"success": true,
6
"errors": [
7
null
8
],
9
"messages": [
10
null
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
}