space.highport.manage.listReservations

lexicons.highport.space

Documentation

Names reserved under one of the caller's delegation bases, with who each is reserved for and whether it routes. The base's probe is not included.

main query

Names reserved under one of the caller's delegation bases, with who each is reserved for and whether it routes. The base's probe is not included.

Parameters

cursor string Optional

Pagination cursor from a previous response.

domain string Required

The base domain.

limit integer Optional

Maximum entries to return.

Output

Encodingapplication/json
cursor string Optional

Present when more entries exist.

reservations array Required

No description available.

Errors

NotBaseOwner No verified or active registration of that domain belongs to the caller.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Pagination cursor from a previous response.
The base domain.
Maximum entries to return.
View raw schema 
{
  "description": "Names reserved under one of the caller's delegation bases, with who each is reserved for and whether it routes. The base's probe is not included.",
  "errors": [
    {
      "description": "No verified or active registration of that domain belongs to the caller.",
      "name": "NotBaseOwner"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "description": "Present when more entries exist.",
          "type": "string"
        },
        "reservations": {
          "items": {
            "ref": "#reservationView",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "reservations"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cursor": {
        "description": "Pagination cursor from a previous response.",
        "type": "string"
      },
      "domain": {
        "description": "The base domain.",
        "maxLength": 253,
        "type": "string"
      },
      "limit": {
        "default": 50,
        "description": "Maximum entries to return.",
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      }
    },
    "required": [
      "domain"
    ],
    "type": "params"
  },
  "type": "query"
}
reservationView object

One reserved name.

Properties

domain ref space.highport.defs#domainView Required

The reservation's registration. did is the identity it is reserved for, and delegatedBase is the base.

edge ref space.highport.defs#edgeReachability Optional

Whether the name still routes to this service's edge. A name can stop routing while its base still routes, if a record for that name in the base's zone overrides the wildcard.

servingDefaultTile boolean Optional

Whether this name is serving the base's default tile. False when the base has set none, and false once the subject publishes a site of their own, which replaces it.

takenUpAt string datetime Optional

When this service first saw the subject use the name as its handle (its DID document lists at://<domain> and the name resolves back). Set once, and kept even if the handle later changes or the check fails. Absent before then. Releasing the name clears it.

View raw schema 
{
  "description": "One reserved name.",
  "properties": {
    "domain": {
      "description": "The reservation's registration. did is the identity it is reserved for, and delegatedBase is the base.",
      "ref": "space.highport.defs#domainView",
      "type": "ref"
    },
    "edge": {
      "description": "Whether the name still routes to this service's edge. A name can stop routing while its base still routes, if a record for that name in the base's zone overrides the wildcard.",
      "ref": "space.highport.defs#edgeReachability",
      "type": "ref"
    },
    "servingDefaultTile": {
      "description": "Whether this name is serving the base's default tile. False when the base has set none, and false once the subject publishes a site of their own, which replaces it.",
      "type": "boolean"
    },
    "takenUpAt": {
      "description": "When this service first saw the subject use the name as its handle (its DID document lists at://<domain> and the name resolves back). Set once, and kept even if the handle later changes or the check fails. Absent before then. Releasing the name clears it.",
      "format": "datetime",
      "type": "string"
    }
  },
  "required": [
    "domain"
  ],
  "type": "object"
}

Lexicon Garden

@