social.colibri.beta.bridge.getPairing Documentation (EN)

main query

Describes a pending pairing code so an admin can see which bridge they are about to connect.

Parameters

code string Required

The pairing code.

Output

Encodingapplication/json

pairing refsocial.colibri.beta.bridge.defs#pairingView Required

The pending pairing.

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.

PairingNotFound The code does not exist, has expired, or was already used.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

code * The pairing code.

View raw schema

{
  "description": "Describes a pending pairing code so an admin can see which bridge they are about to connect.",
  "errors": [
    {
      "description": "The request is missing, malformed, or unverifiable service auth.",
      "name": "AuthRequired"
    },
    {
      "description": "The code does not exist, has expired, or was already used.",
      "name": "PairingNotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "pairing": {
          "description": "The pending pairing.",
          "ref": "social.colibri.beta.bridge.defs#pairingView",
          "type": "ref"
        }
      },
      "required": [
        "pairing"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "code": {
        "description": "The pairing code.",
        "maxLength": 32,
        "type": "string"
      }
    },
    "required": [
      "code"
    ],
    "type": "params"
  },
  "type": "query"
}