# space.highport.manage.listReservations

> Published by [lexicons.highport.space](https://lexicon.garden/identity/did:plc:ciygg5hma4q7ah2kxaszkyob)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:ciygg5hma4q7ah2kxaszkyob/space.highport.manage.listReservations)
- [Documentation](https://lexicon.garden/lexicon/did:plc:ciygg5hma4q7ah2kxaszkyob/space.highport.manage.listReservations/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:ciygg5hma4q7ah2kxaszkyob/space.highport.manage.listReservations/examples)

## Definitions

### `space.highport.manage.listReservations`

**Type**: `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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | Pagination cursor from a previous response. |
| `domain` | `string` | Yes | The base domain. |
| `limit` | `integer` | No | Maximum entries to return. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | Present when more entries exist. |
| `reservations` | `array` | Yes |  |

#### Errors

- **NotBaseOwner**: No verified or active registration of that domain belongs to the caller.

### `space.highport.manage.listReservations#reservationView`

**Type**: `object`

One reserved name.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `domain` | `ref` → `space.highport.defs#domainView` | Yes | The reservation's registration. did is the identity it is reserved for, and delegatedBase is the base. |
| `edge` | `ref` → `space.highport.defs#edgeReachability` | No | 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` | No | 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) | No | 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. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "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": {
      "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"
    }
  },
  "id": "space.highport.manage.listReservations",
  "lexicon": 1
}
```