Sign in

v51

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

Search for artifacts

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

This operation can fail for the following reasons:

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

Query parameters

namestring

Filter by artifact name.

offsetinteger

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

limitinteger

The number of artifacts to return. Defaults to 20.

order'asc' | 'desc'

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

orderby'groupId' | 'artifactId' | 'createdOn' | 'modifiedOn' | 'artifactType' | 'name'

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

Filter by artifact group.

globalIdinteger

Filter by globalId.

contentIdinteger

Filter by contentId.

artifactIdstring

Filter by artifactId.

artifactTypestring
Example:AVRO

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

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 artifacts - one for each artifact in the registry that matches the criteria.

countinteger required

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

Example response

{
  "artifacts": [
    {
      "groupId": "My-Group",
      "artifactId": "Procurement-Invoice",
      "name": "Artifact Name",
      "description": "Description of the artifact",
      "artifactType": "AVRO",
      "owner": "user1",
      "createdOn": "2019-03-22T12:51:19Z",
      "modifiedBy": "user2",
      "modifiedOn": "2019-04-01T12:51:19Z"
    }
  ]
}