Sign in

v51

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-01131107332.8 KB
Search
Versions

Search for versions

Returns a paginated list of all versions that match the provided filter criteria.

This operation can fail for the following reasons:

  • A server error occurred (HTTP error 500)
get/search/versions

Query parameters

versionstring

A single version of an artifact. Can be provided by the client when creating a new version, or it can be server-generated. The value can be any string unique to the artifact, but it is recommended to use a simple integer or a semver value.

Example:"3.1.6"

Filter by version number.

offsetinteger

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

limitinteger

The number of versions to return. Defaults to 20.

order'asc' | 'desc'

Sort order, ascending (asc) or descending (desc).

orderby'groupId' | 'artifactId' | 'version' | 'name' | 'createdOn' | 'modifiedOn' | 'globalId'

The field to sort by. Can be one of:

  • name
  • createdOn
labelsstring[]

Filter by one or more name/value label. Separate each name/value pair using a colon. For example labels=foo:bar will return only artifacts with a label named foo and value bar.

descriptionstring

Filter by description.

groupIdstring

An ID of a single artifact group.

Example:"my-group"

Filter by artifact group.

globalIdinteger

Filter by globalId.

contentIdinteger

Filter by contentId.

artifactIdstring

The ID of a single artifact.

Example:"example-artifact"

Filter by artifactId.

namestring

Filter by name.

state'ENABLED' | 'DISABLED' | 'DEPRECATED' | 'DRAFT' | 'SUNSET'

Describes the state of an artifact or artifact version.

  • ENABLED
  • DISABLED
  • DEPRECATED
  • DRAFT
  • SUNSET — Signals that a migration deadline has passed and the version will be removed. Requires transitioning through DEPRECATED first. Added in 3.3.0.

Filter by version state.

artifactTypestring
Example:AVRO

Filter by artifact type (AVRO, JSON, etc).

contentstring

Full-text search of artifact content. Requires the Lucene search index to be enabled.

structurestring

Search by structured content elements (schemas, paths, fields, etc.) using a faceted format. Supports three formats: type:kind:name for exact match (e.g. openapi:schema:Pet), kind:name for cross-type match (e.g. schema:Pet), or just name for plain text search. Requires the Lucene search index to be enabled.

skipCountboolean

Indicates whether to skip the total count query. When true, the total count is not computed and count will be 0 in the response. This can improve performance for large datasets.

Response

On a successful response, returns a result set of versions - one for each version in the registry that matches the criteria.

countinteger required

The total number of versions that matched the query (may be more than the number of versions returned in the result set).

Example response

{
  "versions": [
    {
      "groupId": "DemoGroup",
      "artifactId": "demo-artifact-id",
      "name": "Artifact Version Name",
      "description": "Description of the artifact version",
      "artifactType": "AVRO",
      "state": "ENABLED",
      "createdOn": "2018-02-10T09:30Z",
      "owner": "some text",
      "globalId": 37,
      "version": "1.0.7",
      "contentId": 62
    }
  ]
}