# space.highport.manage.purge

> 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.purge)
- [Documentation](https://lexicon.garden/lexicon/did:plc:ciygg5hma4q7ah2kxaszkyob/space.highport.manage.purge/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:ciygg5hma4q7ah2kxaszkyob/space.highport.manage.purge/examples)

## Definitions

### `space.highport.manage.purge`

**Type**: `procedure`

Clear the domain's cached pointer and snapshot on every origin replica. There is no shared HTTP cache, so this is only an escape hatch for a suspected stale in-process cache; publishing never needs it. Rate-limited.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `domain` | `string` | Yes | The registered hostname. |
| `paths` | `array` | No | Accepted but ignored. A purge always covers the whole domain. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `purged` | `boolean` | Yes |  |

#### Errors

- **DomainNotFound**: No registration for that domain belongs to the caller.
- **RateLimitExceeded**: Too many purge requests.

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Clear the domain's cached pointer and snapshot on every origin replica. There is no shared HTTP cache, so this is only an escape hatch for a suspected stale in-process cache; publishing never needs it. Rate-limited.",
      "errors": [
        {
          "description": "No registration for that domain belongs to the caller.",
          "name": "DomainNotFound"
        },
        {
          "description": "Too many purge requests.",
          "name": "RateLimitExceeded"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "domain": {
              "description": "The registered hostname.",
              "maxLength": 253,
              "type": "string"
            },
            "paths": {
              "description": "Accepted but ignored. A purge always covers the whole domain.",
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "domain"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "purged": {
              "type": "boolean"
            }
          },
          "required": [
            "purged"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "space.highport.manage.purge",
  "lexicon": 1
}
```