APapicurio
Admin

Create a peer registry

Changed on

Experimental. Registers a new peer registry.

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 peer definition is invalid (HTTP error 400)
  • A peer with the same peerId already exists (HTTP error 409)
  • The registry storage is read-only (HTTP error 409)
  • Federation is not enabled (HTTP error 409)
  • A server error occurred (HTTP error 500)
post/admin/peers

Request

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

Request body

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

Whether the peer registry is used for federation. Defaults to true.

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

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

Response

Returned when the peer registry was successfully created.

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

  • 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