Admin

List peer registries

Changed on

Experimental. Gets the list of all peer registries configured in the registry, including disabled peers, ordered by peerId.

This endpoint is only available when federation is enabled (apicurio.federation.enabled). Returns HTTP 409 (Conflict) otherwise.

This operation can fail for the following reasons:

  • Federation is not enabled (HTTP error 409)
  • A server error occurred (HTTP error 500)
get/admin/peers

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

limitinteger

The number of peers to return. Defaults to 20.

offsetinteger

The number of peers to skip before starting the result set. Defaults to 0.

Response

A successful response will return the list of peer registries.

countinteger required

The total number of peer registries (may be more than the number of peers in the result set).

Example response

{
  "peers": [
    {
      "peerId": "eu-registry",
      "url": "https://registry.eu.example.com",
      "name": "EU registry",
      "description": "Registry serving the EU region.",
      "enabled": true,
      "credentialSecretRef": "eu-registry"
    }
  ]
}

Changes

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status