APapicurio
Admin

Get a peer registry

Changed on

Experimental. Gets the details of a single peer registry (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:

  • The peerId is invalid (HTTP error 400)
  • No peer registry with the peerId exists (HTTP error 404)
  • Federation is not enabled (HTTP error 409)
  • A server error occurred (HTTP error 500)
get/admin/peers/{peerId}

Request

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

Response

When successful, returns the details of a peer registry.

peerIdstring required

Unique id of the peer registry. Lowercase letters, digits, ., _ and - only, at most 256 characters. local is reserved.

urlstring required

Base URL of the peer registry, for example https://registry.eu.example.com.

namestring

Display name of the peer registry.

descriptionstring

Description of the peer registry.

enabledboolean required

Whether the peer registry is used for federation.

credentialSecretRefstring

Name of the key in the registry's peer credentials directory that holds the credential for this peer. A reference only: the credential value is never stored or returned.

Example response

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

Changes

  • ff9684af2aadRevision 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

    • 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

  • f17f5df4e79cRevision 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