town.muni.arbiter.getArbiterConfig

zicklag.dev

Documentation

Get the current config object for an arbiter.

main query

Get the current config object for an arbiter.

Parameters

arbiterDid string did Required

The DID of the arbiter to fetch the config 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.

Output

Encodingapplication/json

Errors

ErrPermissionDenied The requesting user is not allowed to make the request.
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://api.bsky.social)
Parameters
The DID of the arbiter to fetch the config from
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.
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "ErrPermissionDenied",
      "description": "The requesting user is not allowed to make the request."
    }
  ],
  "output": {
    "schema": {
      "refs": [],
      "type": "union"
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "arbiterDid"
    ],
    "properties": {
      "arbiterDid": {
        "type": "string",
        "format": "did",
        "description": "The DID of the arbiter to fetch the config 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."
      }
    }
  },
  "description": "Get the current config object for an arbiter."
}

Lexicon Garden

@