Everything a client needs to onboard one domain: registration state, DNS records to publish, last verification result, and certificate state. This is the endpoint to poll.
Parameters
Output
Encoding
application/jsondomain
refspace.highport.defs#domainView
Required
No description available.
records
array
Required
The DNS records to publish, the same as register returned.
tls
refspace.highport.defs#tlsView
Required
No description available.
verification
refspace.highport.defs#verificationView
Required
No description available.
Errors
DomainNotFound
No registration for that domain belongs to the caller. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "query",
"errors": [
{
"name": "DomainNotFound",
"description": "No registration for that domain belongs to the caller."
}
],
"output": {
"schema": {
"type": "object",
"required": [
"domain",
"records",
"verification",
"tls"
],
"properties": {
"tls": {
"ref": "space.highport.defs#tlsView",
"type": "ref"
},
"domain": {
"ref": "space.highport.defs#domainView",
"type": "ref"
},
"records": {
"type": "array",
"items": {
"ref": "space.highport.defs#dnsInstruction",
"type": "ref"
},
"description": "The DNS records to publish, the same as register returned."
},
"verification": {
"ref": "space.highport.defs#verificationView",
"type": "ref"
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"maxLength": 253,
"description": "The registered hostname."
}
}
},
"description": "Everything a client needs to onboard one domain: registration state, DNS records to publish, last verification result, and certificate state. This is the endpoint to poll."
}