Sign in

v51

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

Search for artifacts by content

Returns a paginated list of all artifacts with at least one version that matches the posted content.

This operation can fail for the following reasons:

  • Provided content (request body) was empty (HTTP error 400)
  • A server error occurred (HTTP error 500)
post/search/artifacts

Query parameters

canonicalboolean

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.

artifactTypestring
Example:AVRO

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.

groupIdstring

Filter by artifact group.

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
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"
    }
  ]
}