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
Kindprocedure
Authoritymanage.highport.space
Indexed

Showing version bafyreibmapgjglr6q24to4m2idlank52zwtg2sy6i7ilzxdlldgqfh2oy4. Show the latest

Procedure

procedure · POST

Input

application/json

domain

requiredstring
  • maxLength: 253

space

string · at-uri

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.

Output

application/json

domain

requiredstring

expiresAt

requiredstring · datetime

After this time an unverified registration is released.

records

requiredarray

space

string · at-uri

Errors

InvalidDomain

Not a syntactically valid, non-reserved, public-suffix-safe domain.

DomainTaken

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.

DomainDenied

On the operator denylist.

QuotaExceeded

This DID has reached its domain limit.

AlreadyRegistered

Already registered to this DID; use getDomain to retrieve instructions.

SpaceNotFound

Bard is not connected to that space; call connectSpace first.

NotSpaceAuthority

Only the space's authority may register a domain to it.

SpaceNotSynced

Registered, but bard cannot currently read the space, so the domain will not serve until it can.

DomainDelegated

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.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • Reserve a name directly under a delegation base for another identity. The name answers /.well-known/atproto-did with the subject right away, and the subject can then publish a site there. The caller must own the base. Any unproven claim on the name is replaced. Repeating the call for the same subject returns the existing reservation and does not count against maxNames. Reservations last as long as the base.

  • 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.

  • Make a registered domain a delegation base, so its owner can reserve names directly under it for other identities. Returns the wildcard record that routes those names. The caller must own the base, and it must be verified or active.

  • Look up which identity and record serve a domain. Useful for checking who owns a site.

  • place.wisp.v2.domain.claim

    procedure not from the namespace authority

    Claim a custom domain for the authenticated DID. Returns DNS setup instructions.