space.highport.manage.disconnectSpace

Forget a space: release its domains, purge them after the usual grace period, discard the credential and key, and stop renewing. Authority only.

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

Checks

Valid
  • unlimited-string defs.main.output.schema.properties.releasedDomains.itemsNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Forget a space: release its domains, purge them after the usual grace period, discard the credential and key, and stop renewing. Authority only.",
      "errors": [
        {
          "description": "Bard is not connected to that space.",
          "name": "SpaceNotFound"
        },
        {
          "description": "Only the space's authority may disconnect it.",
          "name": "NotSpaceAuthority"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "space": {
              "format": "at-uri",
              "type": "string"
            }
          },
          "required": [
            "space"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "disconnected": {
              "type": "boolean"
            },
            "releasedDomains": {
              "description": "The hostnames that were released.",
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "disconnected",
            "releasedDomains"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "space.highport.manage.disconnectSpace",
  "lexicon": 1
}