space.highport.manage.reserveDomain

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "hostname",
        "subject"
      ],
      "properties": {
        "subject": {
          "type": "string",
          "format": "did",
          "description": "The identity the name is reserved for. Without genesisOp only its syntax is checked: it does not need to resolve, and its DID document does not need to list the hostname yet."
        },
        "hostname": {
          "type": "string",
          "maxLength": 253,
          "description": "A name exactly one label below a delegation base the caller owns."
        },
        "genesisOp": {
          "type": "unknown",
          "description": "Optional proof for a did:plc subject: its signed genesis operation, as sent to a PLC directory, checked offline. It must have a null prev, hash to the subject, be signed by one of the subject's rotation keys, and list at://<hostname> in alsoKnownAs, or the call fails with InvalidSubject."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "InvalidDomain",
      "description": "Not a valid, non-reserved domain."
    },
    {
      "name": "DomainDenied",
      "description": "The hostname or the subject is on the operator denylist."
    },
    {
      "name": "NotBaseOwner",
      "description": "The name is not under a delegation base with a verified or active registration owned by the caller."
    },
    {
      "name": "DomainTaken",
      "description": "The name is taken: by a proven registration (including one the base owner made directly), by a live reservation for a different subject or a suspended one, by an unproven claim that is itself a base with a delegation or certificate grant, or by a release that still carries a delegation or grant, such as a wildcard being retired. Release it or wait for the retirement to finish."
    },
    {
      "name": "DelegationNotVerified",
      "description": "The base's wildcard has not been shown to route here: its probe has not passed yet, or its routing has lapsed. The error message names the probe hostname and the *.<base> record to publish or restore. The reserved name itself is never resolved."
    },
    {
      "name": "InvalidSubject",
      "description": "The subject is not a well-formed did:plc or did:web, is a did:web rooted at the hostname being reserved, or came with a genesisOp that does not prove it. The error message says which."
    },
    {
      "name": "DelegatedNameTooDeep",
      "description": "The name is more than one label below the base. A wildcard covers only one label, so a deeper name could never complete a TLS handshake."
    },
    {
      "name": "DelegationQuotaExceeded",
      "description": "The base already holds maxNames reservations. Never returned when reserving a name again for its current subject."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "hostname",
        "status",
        "subject"
      ],
      "properties": {
        "status": {
          "ref": "space.highport.defs#domainStatus",
          "type": "ref"
        },
        "subject": {
          "type": "string",
          "format": "did"
        },
        "hostname": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "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."
}