How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Apicurio Artifacts API

The Artifacts API from Apicurio — 9 operation(s) for artifacts.

Apicurio Artifacts API is one of 23 APIs that Apicurio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Artifacts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 9 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 3.1.x.

Requests are made against a single base URL, http://localhost:8080/apis/registry/v3.

12 operations 9 paths 25 schemas 2 DELETE8 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.1.x
Server
http://localhost:8080/apis/registry/v3
Authentication
HTTP Basic, OAuth 2.0
Contact
License
Resource Areas
1

Authentication & Security 2

Apicurio Artifacts API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 3 scopes.

Paths & Operations 12

Across 9 paths, the API surfaces 12 operations — 2 DELETE, 8 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Artifacts 12
GET
/ids/globalIds/{globalId}
Get artifact by global ID
getContentByGlobalId 3 params → 200404500401403
GET
/search/artifacts
Search for artifacts
searchArtifacts 12 params → 200500401403
POST
/search/artifacts
Search for artifacts by content
searchArtifactsByContent 7 params body → 200400500401403
GET
/ids/contentIds/{contentId}/references
List artifact references by content ID
referencesByContentId 1 param → 200401403
GET
/ids/globalIds/{globalId}/references
List artifact references by global ID
referencesByGlobalId 2 params → 200401403
GET
/groups/{groupId}/artifacts
List artifacts in group
listArtifactsInGroup 5 params → 200404500401403
POST
/groups/{groupId}/artifacts
Create artifact
createArtifact 4 params body → 200400404409422500401403
DELETE
/groups/{groupId}/artifacts
Delete artifacts in group
deleteArtifactsInGroup 1 param → 204500401403
GET
/ids/contentHashes/{contentHash}/references
List artifact references by hash
referencesByContentHash 1 param → 200401403
GET
/ids/contentHashes/{contentHash}
Get artifact content by SHA-256 hash
getContentByHash 1 param → 200404500401403
GET
/ids/contentIds/{contentId}
Get artifact content by ID
getContentById 1 param → 200404500401403
DELETE
/groups/{groupId}/artifacts/{artifactId}
Delete artifact
deleteArtifact 2 params → 204404405500401403

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are VersionMetaData (14 properties), ArtifactMetaData (11 properties), ContractMetadata (10 properties), SearchedArtifact (10 properties). Each schema is shown below with its type and property counts.

ProblemDetails
object
All error responses, whether 4xx or 5xx will include one of these as the response body.
6 properties 2 required
ContractMetadata
object
Contract metadata for an artifact.
10 properties
ArtifactType
string
VersionMetaData
object
14 properties 7 required
GroupId
string
An ID of a single artifact group.
SearchedArtifact
object
Models a single artifact from the result set returned when searching for artifacts.
10 properties 7 required
VersionContent
object
4 properties 2 required
RuleViolationCause
object
2 properties
ReferenceType
string
ArtifactSortBy
string
ArtifactMetaData
object
11 properties 7 required
ArtifactReference
object
A reference to a different artifact. Typically used with artifact types that can have dependencies like Protobuf.
4 properties 3 required
CreateArtifact
object
Data sent when creating a new artifact.
6 properties 1 required
Labels
object
User-defined name-value pairs. Name and value must be strings.
FileContent
string
ArtifactSearchResults
object
Describes the response received when searching for artifacts.
2 properties 2 required
ArtifactId
string
The ID of a single artifact.
RuleViolationProblemDetails
object
All error responses, whether 4xx or 5xx will include one of these as the response body.
HandleReferencesType
string
How to handle references when retrieving content. References can either be left unchanged (PRESERVE), re-written so they are valid in the context of the regist…
VersionState
string
Describes the state of an artifact or artifact version. ENABLED DISABLED DEPRECATED DRAFT SUNSET — Signals that a migration deadline has passed and the version…
CreateVersion
object
7 properties 1 required
Version
string
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 t…
CreateArtifactResponse
object
2 properties 1 required
IfArtifactExists
string
SortOrder
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apicurio-artifacts-api-openapi.yml Raw ↑

Other APIs Apicurio publishes across the network.

Apicurio Registry
Apicurio Studio
Apicurio Data Models
Apicurio Codegen
Apicurio Admin API
Apicurio AI API
Apicurio Artifact rules API
Apicurio Artifact Type API
Apicurio Branches API
Apicurio Content API
Apicurio Contracts API
Apicurio GitOps API
Where this information came from

This is an independent, third-party profile of Apicurio Artifacts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.