/groups/{groupId}/artifacts/{artifactId}

Get latest artifact

• dereference (query) — Allows the user to specify if the content should be dereferenced when being returned

/admin/artifactTypes

List artifact types

/admin/config/properties

List all configuration properties

/admin/config/properties/{propertyName}

Reset a configuration property

/admin/config/properties/{propertyName}

Get configuration property value

/admin/config/properties/{propertyName}

Update a configuration property

/admin/export

Export registry data

• forBrowser (query) — Indicates if the operation is done for a browser. If true, the response will be a JSON payload with a property called `href`. This `href` will be a single-use, naked download link suitable for use by a web browser to download the content.

/admin/import

Import registry data

• X-Registry-Preserve-GlobalId (header) — If this header is set to false, global ids of imported data will be ignored and replaced by next id in global id sequence. This allows to import any data even thought the global ids would cause a conflict.
• X-Registry-Preserve-ContentId (header) — If this header is set to false, content ids of imported data will be ignored and replaced by next id in content id sequence. The mapping between content and artifacts will be preserved. This allows to import any data even thought the content ids would cause a conflict.

/admin/loggers

List logging configurations

/admin/loggers/{logger}

Removes logger configuration

/admin/loggers/{logger}

Get a single logger configuration

/admin/loggers/{logger}

Set a logger's configuration

/admin/roleMappings

List all role mappings

/admin/roleMappings

Create a new role mapping

/admin/roleMappings/{principalId}

Delete a role mapping

/admin/roleMappings/{principalId}

Return a single role mapping

/admin/roleMappings/{principalId}

Update a role mapping

/admin/rules

Delete all global rules

/admin/rules

List global rules

/admin/rules

Create global rule

/admin/rules/{rule}

Delete global rule

/admin/rules/{rule}

Get global rule configuration

/admin/rules/{rule}

Update global rule configuration

/groups

List groups

• limit (query, limit) — The number of groups to return. Defaults to 20.
• offset (query, offset) — The number of groups to skip before starting the result set. Defaults to 0.
• order (query) — Sort order, ascending (`asc`) or descending (`desc`).
• orderby (query) — The field to sort by. Can be one of: * `name` * `createdOn`

/groups

Create a new group

/groups/{groupId}

Delete a group by the specified ID.

/groups/{groupId}

Get a group by the specified ID.

/groups/{groupId}/artifacts

Delete artifacts in group

/groups/{groupId}/artifacts

List artifacts in group

• limit (query, limit) — The number of artifacts to return. Defaults to 20.
• offset (query, offset) — The number of artifacts to skip before starting the result set. Defaults to 0.
• order (query) — Sort order, ascending (`asc`) or descending (`desc`).
• orderby (query) — The field to sort by. Can be one of: * `name` * `createdOn`

/groups/{groupId}/artifacts

Create artifact

• X-Registry-ArtifactType (header) — Specifies the type of the artifact being added. Possible values include: * Avro (`AVRO`) * Protobuf (`PROTOBUF`) * JSON Schema (`JSON`) * Kafka Connect (`KCONNECT`) * OpenAPI (`OPENAPI`) * AsyncAPI (`ASYNCAPI`) * GraphQL (`GRAPHQL`) * Web Services Description Language (`WSDL`) * XML Schema (`XSD`)
• X-Registry-ArtifactId (header) — A client-provided, globally unique identifier for the new artifact.
• X-Registry-Version (header) — Specifies the version number of this initial version of the artifact content. This would typically be a simple integer or a SemVer value. If not provided, the server will assign a version number automatically (starting with version `1`).
• ifExists (query) — Set this option to instruct the server on what to do if the artifact already exists.
• canonical (query) — Used only when the `ifExists` query parameter is set to `RETURN_OR_UPDATE`, this parameter can be set to `true` to indicate that the server should "canonicalize" the content when searching for a matching version. The canonicalization algorithm is unique to each artifact type, but typically involves removing extra whitespace and formatting the content in a consistent manner.
• X-Registry-Description (header) — Specifies the description of artifact being added. Description must be ASCII-only string. If this is not provided, the server will extract the description from the artifact content.
• X-Registry-Description-Encoded (header) — Specifies the description of artifact being added. Value of this must be Base64 encoded string. If this is not provided, the server will extract the description from the artifact content.
• X-Registry-Name (header) — Specifies the name of artifact being added. Name must be ASCII-only string. If this is not provided, the server will extract the name from the artifact content.
• X-Registry-Name-Encoded (header) — Specifies the name of artifact being added. Value of this must be Base64 encoded string. If this is not provided, the server will extract the name from the artifact content.
• X-Registry-Content-Hash (header) — Specifies the (optional) hash of the artifact to be verified.
• X-Registry-Hash-Algorithm (header) — The algorithm to use when checking the content validity. (available: SHA256, MD5; default: SHA256)

/groups/{groupId}/artifacts/{artifactId}

Delete artifact

/groups/{groupId}/artifacts/{artifactId}

Update artifact

• X-Registry-Version (header) — Specifies the version number of this new version of the artifact content. This would typically be a simple integer or a SemVer value. If not provided, the server will assign a version number automatically.
• X-Registry-Name (header) — Specifies the artifact name of this new version of the artifact content. Name must be ASCII-only string. If this is not provided, the server will extract the name from the artifact content.
• X-Registry-Name-Encoded (header) — Specifies the artifact name of this new version of the artifact content. Value of this must be Base64 encoded string. If this is not provided, the server will extract the name from the artifact content.
• X-Registry-Description (header) — Specifies the artifact description of this new version of the artifact content. Description must be ASCII-only string. If this is not provided, the server will extract the description from the artifact content.
• X-Registry-Description-Encoded (header) — Specifies the artifact description of this new version of the artifact content. Value of this must be Base64 encoded string. If this is not provided, the server will extract the description from the artifact content.

/groups/{groupId}/artifacts/{artifactId}/meta

Get artifact metadata

/groups/{groupId}/artifacts/{artifactId}/meta

Get artifact version metadata by content

• canonical (query) — Parameter that can be set to `true` to indicate that the server should "canonicalize" the content when searching for a matching version. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner.

/groups/{groupId}/artifacts/{artifactId}/meta

Update artifact metadata

/groups/{groupId}/artifacts/{artifactId}/owner

Get artifact owner

/groups/{groupId}/artifacts/{artifactId}/owner

Update artifact owner

/groups/{groupId}/artifacts/{artifactId}/rules

Delete artifact rules

/groups/{groupId}/artifacts/{artifactId}/rules

List artifact rules

/groups/{groupId}/artifacts/{artifactId}/rules

Create artifact rule

/groups/{groupId}/artifacts/{artifactId}/rules/{rule}

Delete artifact rule

/groups/{groupId}/artifacts/{artifactId}/rules/{rule}

Get artifact rule configuration

/groups/{groupId}/artifacts/{artifactId}/rules/{rule}

Update artifact rule configuration

/groups/{groupId}/artifacts/{artifactId}/state

Update artifact state

/groups/{groupId}/artifacts/{artifactId}/test

Test update artifact

/groups/{groupId}/artifacts/{artifactId}/versions

List artifact versions

• offset (query, offset) — The number of versions to skip before starting to collect the result set. Defaults to 0.
• limit (query, limit) — The number of versions to return. Defaults to 20.

/groups/{groupId}/artifacts/{artifactId}/versions

Create artifact version

• X-Registry-Version (header) — Specifies the version number of this new version of the artifact content. This would typically be a simple integer or a SemVer value. It must be unique within the artifact. If this is not provided, the server will generate a new, unique version number for this new updated content.
• X-Registry-Name (header) — Specifies the artifact name of this new version of the artifact content. Name must be ASCII-only string. If this is not provided, the server will extract the name from the artifact content.
• X-Registry-Description (header) — Specifies the artifact description of this new version of the artifact content. Description must be ASCII-only string. If this is not provided, the server will extract the description from the artifact content.
• X-Registry-Description-Encoded (header) — Specifies the artifact description of this new version of the artifact content. Value of this must be Base64 encoded string. If this is not provided, the server will extract the description from the artifact content.
• X-Registry-Name-Encoded (header) — Specifies the artifact name of this new version of the artifact content. Value of this must be Base64 encoded string. If this is not provided, the server will extract the name from the artifact content.

/groups/{groupId}/artifacts/{artifactId}/versions/{version}

Get artifact version

• dereference (query) — Allows the user to specify if the content should be dereferenced when being returned

/groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta

Delete artifact version metadata

/groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta

Get artifact version metadata

/groups/{groupId}/artifacts/{artifactId}/versions/{version}/meta

Update artifact version metadata

/groups/{groupId}/artifacts/{artifactId}/versions/{version}/references

Get artifact version

/groups/{groupId}/artifacts/{artifactId}/versions/{version}/state

Update artifact version state

/ids/contentHashes/{contentHash}/

Get artifact content by SHA-256 hash

/ids/contentHashes/{contentHash}/references

List artifact references by hash

/ids/contentIds/{contentId}/

Get artifact content by ID

/ids/contentIds/{contentId}/references

List artifact references by content ID

/ids/globalIds/{globalId}

Get artifact by global ID

• dereference (query) — Allows the user to specify if the content should be dereferenced when being returned

/ids/globalIds/{globalId}/references

List artifact references by global ID

/search/artifacts

Search for artifacts

• name (query) — Filter by artifact name.
• offset (query, offset) — The number of artifacts to skip before starting to collect the result set. Defaults to 0.
• limit (query, limit) — The number of artifacts to return. Defaults to 20.
• order (query) — Sort order, ascending (`asc`) or descending (`desc`).
• orderby (query) — The field to sort by. Can be one of: * `name` * `createdOn`
• labels (query) — Filter by label. Include one or more label to only return artifacts containing all of the specified labels.
• properties (query) — Filter by one or more name/value property. Separate each name/value pair using a colon. For example `properties=foo:bar` will return only artifacts with a custom property named `foo` and value `bar`.
• description (query) — Filter by description.
• group (query) — Filter by artifact group.
• globalId (query) — Filter by globalId.
• contentId (query) — Filter by contentId.

/search/artifacts

Search for artifacts by content

• canonical (query) — Parameter that can be set to `true` to indicate that the server should "canonicalize" the content when searching for matching artifacts. Canonicalization is unique to each artifact type, but typically involves removing any extra whitespace and formatting the content in a consistent manner. Must be used along with the `artifactType` query parameter.
• artifactType (query) — Indicates the type of artifact represented by the content being used for the search. This is only needed when using the `canonical` query parameter, so that the server knows how to canonicalize the content prior to searching for matching artifacts.
• offset (query, offset) — The number of artifacts to skip before starting to collect the result set. Defaults to 0.
• limit (query, limit) — The number of artifacts to return. Defaults to 20.
• order (query) — Sort order, ascending (`asc`) or descending (`desc`).
• orderby (query) — The field to sort by. Can be one of: * `name` * `createdOn`

/system/info

Get system information

/system/limits

Get resource limits information

/users/me

Get current user