Admin

Update a peer registry

Changed on Oct 31, 2026

Experimental. Replaces the definition of a single peer registry. Optional fields that are omitted are cleared.

The peer url must use https unless apicurio.federation.peer.insecure-http.enabled is set. It must not contain userinfo, a query or a fragment, and must not point at a link-local, unspecified, multicast, reserved or cloud metadata address, or at a loopback address unless apicurio.federation.peer.loopback.enabled is set. credentialSecretRef names a key in the registry's peer credentials directory; it is never a credential value.

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 or the peer definition is invalid (HTTP error 400)
No peer registry with the peerId exists (HTTP error 404)
The registry storage is read-only (HTTP error 409)
Federation is not enabled (HTTP error 409)
A server error occurred (HTTP error 500)

put/admin/peers/{peerId}

Request

The document declares no server URL.
Auth
none declared

Request body

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 request

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

Response

Response when the update is successful.

Changes

Oct 31, 2026ff9684af2aad Revision 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
Oct 29, 2026f17f5df4e79c Revision 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

Operation history (3 revisions)