space.highport.manage.purge

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.

Details · procedure
Kindprocedure
Authoritymanage.highport.space
Indexed
cid bafyreicbiovpnp3nxzi6l52lzl36o3mjainowb5klyc72njr6r523xrfsu

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.paths.itemsNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$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
}