MARS documentation
API reference

Federation peer status

Contract and client context

Operation: federation_peer_status · HTTP: GET /v1/admin/federation/peers

Use an operator-supplied registry base URL. Request execution is disabled in this documentation explorer. Generated request snippets are templates, not signed or authorized submissions.

Exact operation definition
{
  "operationId": "federation_peer_status",
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "items": {
              "$ref": "#/components/schemas/FederationPeerStatus"
            },
            "type": "array"
          }
        }
      },
      "description": "Protected durable peer cursor, breaker, lag, and quarantine status"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Operator session missing or invalid"
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Admin capability required"
    }
  },
  "security": [
    {
      "siwsSession": []
    },
    {
      "siwsCookie": []
    }
  ],
  "tags": [
    "federation"
  ]
}

Resolve schema references against the complete OpenAPI document. Standalone schemas and hashes are generated from the same checked-in source.

GET/v1/admin/federation/peers

Authorization

AuthorizationBearer <token>

Opaque capability-bearing MARS session issued by an enabled authentication profile.

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/admin/federation/peers"
[  {    "breakerState": "closed",    "consecutiveFailures": 0,    "cursor": 0,    "lag": 0,    "lastSuccessAt": "2019-08-24T14:15:22Z",    "latencyMs": 0,    "nextAttemptAt": "2019-08-24T14:15:22Z",    "peerDid": "string",    "quarantines": 0  }]