town.muni.arbiter.deleteSpace

zicklag.dev

Documentation

Delete a space from the arbiter.

main procedure

Delete a space from the arbiter.

Input

Encodingapplication/json
arbiterDid stringdid Required

The DID of the arbiter to delete the space from.

resolverDepth integer Optional

The maximum depth to allow when doing remote resolutions. Because spaces are allowed to have members resolved from remote spaces, all of the arbiter endpoints have an optional resolution depth parameter that can be used to limit how many chained remote calls can be resolved. This applies both to queries and procedures. Queries may need to resolve external members to complete the member list, and procedures may need to resolve external members if the requesting member is not in the local member list, to see if the member has access through a remote list.

spaceKey string Required

The space key of the space to delete.

maxLength: 1024 bytes

Output

Encodingapplication/json

Errors

ErrPermissionDenied The requesting user is not allowed to make the request.
ErrSpaceNotExists The specified space does not exist on this arbiter.
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://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "arbiterDid",
        "spaceKey"
      ],
      "properties": {
        "spaceKey": {
          "type": "string",
          "maxLength": 1024,
          "description": "The space key of the space to delete."
        },
        "arbiterDid": {
          "type": "string",
          "format": "did",
          "description": "The DID of the arbiter to delete the space from."
        },
        "resolverDepth": {
          "type": "integer",
          "description": "The maximum depth to allow when doing remote resolutions.\n\nBecause spaces are allowed to have members resolved from remote spaces,\nall of the arbiter endpoints have an optional resolution depth parameter\nthat can be used to limit how many chained remote calls can be resolved.\n\nThis applies both to queries and procedures. Queries may need to resolve\nexternal members to complete the member list, and procedures may need\nto resolve external members if the requesting member is not in the local\nmember list, to see if the member has access through a remote list."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "ErrPermissionDenied",
      "description": "The requesting user is not allowed to make the request."
    },
    {
      "name": "ErrSpaceNotExists",
      "description": "The specified space does not exist on this arbiter."
    }
  ],
  "output": {
    "schema": {
      "refs": [],
      "type": "union"
    },
    "encoding": "application/json"
  },
  "description": "Delete a space from the arbiter."
}

Lexicon Garden

@