at.happyproto.server.removeDomain
Schema Diff
+12 -0
Compatibility Analysis
Backward Compatible
No changes detected.
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
5
"description": "Remove a custom domain from one of the caller's instances. HappyProto stops serving it. Customers only.",
6
6
"errors": [
7
7
{
8
8
"description": "This endpoint requires an authenticated caller.",
9
9
"name": "AuthRequired"
10
10
},
11
11
{
12
12
"description": "The caller is not a HappyProto customer, or the provisioner refused them.",
13
13
"name": "Forbidden"
14
14
},
15
15
{
16
16
"description": "instanceId, domainId or idempotencyKey is not a UUID.",
17
17
"name": "InvalidRequest"
18
18
},
19
19
{
20
20
"description": "No such instance or domain, or it is not the caller's. The cases are indistinguishable.",
21
21
"name": "NotFound"
22
22
},
23
23
{
24
24
"description": "Custom domains are not switched on yet.",
25
25
"name": "NotAvailable"
26
26
},
27
27
{
28
28
"description": "Passed through from the provisioner.",
29
29
"name": "InvalidSlug"
30
30
},
31
31
{
32
32
"description": "Passed through from the provisioner.",
33
33
"name": "SlugTaken"
34
34
},
35
35
{
36
36
"description": "Passed through from the provisioner.",
37
37
"name": "NotEntitled"
38
38
},
39
39
{
40
40
"description": "Passed through from the provisioner.",
41
41
"name": "InstanceLimit"
42
42
},
43
43
{
44
44
"description": "Passed through from the provisioner.",
45
45
"name": "NoCapacity"
46
46
},
47
47
{
48
48
"description": "Passed through from the provisioner: the instance is already changing, or a request with this idempotencyKey is still running.",
49
49
"name": "OperationInProgress"
50
50
},
51
51
{
52
52
"description": "Passed through from the provisioner.",
53
53
"name": "InvalidHostname"
54
54
},
55
55
{
56
56
"description": "Passed through from the provisioner.",
57
57
"name": "PlatformHostname"
58
58
},
59
59
{
60
60
"description": "Passed through from the provisioner.",
61
61
"name": "DomainExists"
62
62
},
63
63
{
64
64
"description": "Passed through from the provisioner.",
65
65
"name": "DomainLimit"
66
66
},
67
67
{
68
68
"description": "Passed through from the provisioner.",
69
69
"name": "TooSoon"
70
70
},
71
71
{
72
72
"description": "The domain is the instance's primary. Make the platform subdomain primary first.",
73
73
"name": "DomainIsPrimary"
74
74
},
75
75
{
76
+
"description": "Passed through from the provisioner.",
77
+
"name": "NotVerified"
78
+
},
79
+
{
80
+
"description": "Passed through from the provisioner.",
81
+
"name": "CertificateNotReady"
82
+
},
83
+
{
84
+
"description": "Passed through from the provisioner.",
85
+
"name": "VersionTooOld"
86
+
},
87
+
{
76
88
"description": "The provisioner is unreachable, not configured, or answered with an error it does not explain to callers, or the job could not be started.",
77
89
"name": "Upstream"
78
90
}
79
91
],
80
92
"input": {
81
93
"encoding": "application/json",
82
94
"schema": {
83
95
"properties": {
84
96
"domainId": {
85
97
"description": "The domain's UUID.",
86
98
"type": "string"
87
99
},
88
100
"idempotencyKey": {
89
101
"description": "A UUID the client generates once per intended change and resends on every retry of it, so a retry gets the original reply instead of acting twice.",
90
102
"type": "string"
91
103
},
92
104
"instanceId": {
93
105
"description": "The instance's UUID.",
94
106
"type": "string"
95
107
}
96
108
},
97
109
"required": [
98
110
"instanceId",
99
111
"domainId",
100
112
"idempotencyKey"
101
113
],
102
114
"type": "object"
103
115
}
104
116
},
105
117
"output": {
106
118
"encoding": "application/json",
107
119
"schema": {
108
120
"properties": {
109
121
"jobId": {
110
122
"description": "The background job following the routing change, when there was one. Poll it with at.happyproto.server.getJob.",
111
123
"type": "string"
112
124
}
113
125
},
114
126
"required": [],
115
127
"type": "object"
116
128
}
117
129
},
118
130
"type": "procedure"
119
131
}
120
132
},
121
133
"id": "at.happyproto.server.removeDomain",
122
134
"lexicon": 1
123
135
}