space.highport.manage.register
Register a domain to the calling identity — or, with space, to a space the caller is the authority of — and obtain the DNS records needed to prove ownership and route traffic.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | manage.highport.space |
| Indexed |
Showing version bafyreibmapgjglr6q24to4m2idlank52zwtg2sy6i7ilzxdlldgqfh2oy4. Show the latest
Checks
Validunlimited-stringdefs.main.output.schema.properties.domainNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "Register a domain to the calling identity — or, with space, to a space the caller is the authority of — and obtain the DNS records needed to prove ownership and route traffic.",
"errors": [
{
"description": "Not a syntactically valid, non-reserved, public-suffix-safe domain.",
"name": "InvalidDomain"
},
{
"description": "The domain is held and cannot be taken: registered to a different DID and proven (verified or active) or suspended; reserved under a base for a different DID and not released; or released with its wildcard certificate grant still being retired, which refuses every DID, the previous holder included, until the retirement finishes.",
"name": "DomainTaken"
},
{
"description": "On the operator denylist.",
"name": "DomainDenied"
},
{
"description": "This DID has reached its domain limit.",
"name": "QuotaExceeded"
},
{
"description": "Already registered to this DID; use getDomain to retrieve instructions.",
"name": "AlreadyRegistered"
},
{
"description": "Bard is not connected to that space; call connectSpace first.",
"name": "SpaceNotFound"
},
{
"description": "Only the space's authority may register a domain to it.",
"name": "NotSpaceAuthority"
},
{
"description": "Registered, but bard cannot currently read the space, so the domain will not serve until it can.",
"name": "SpaceNotSynced"
},
{
"description": "The domain is under a delegation base, whose names only the base's owner may register; the base's owner reserves them for other identities with reserveDomain.",
"name": "DomainDelegated"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"domain": {
"maxLength": 253,
"type": "string"
},
"space": {
"description": "Register the domain to a space bard is connected to rather than to the caller's public repo. The caller must be the space's authority.",
"format": "at-uri",
"type": "string"
}
},
"required": [
"domain"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"domain": {
"type": "string"
},
"expiresAt": {
"description": "After this time an unverified registration is released.",
"format": "datetime",
"type": "string"
},
"records": {
"items": {
"ref": "space.highport.defs#dnsInstruction",
"type": "ref"
},
"type": "array"
},
"space": {
"format": "at-uri",
"type": "string"
},
"status": {
"ref": "space.highport.defs#domainStatus",
"type": "ref"
}
},
"required": [
"domain",
"status",
"records",
"expiresAt"
],
"type": "object"
}
},
"type": "procedure"
}
},
"id": "space.highport.manage.register",
"lexicon": 1
}