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 Versions API

The Versions API from Apicurio — 11 operation(s) for versions.

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

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

This API exposes 17 operations across 11 paths, and defines 31 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.

17 operations 11 paths 31 schemas 2 DELETE8 GET4 POST3 PUT

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 Versions 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 17

Across 11 paths, the API surfaces 17 operations — 2 DELETE, 8 GET, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Versions 17
DELETE
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}
Delete artifact version
deleteArtifactVersion 3 params → 204400404405500401403
GET
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/references
Get artifact version references
getArtifactVersionReferences 4 params → 200400404500401403
GET
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/references/graph
Get artifact version references as a graph
getArtifactVersionReferencesGraph 5 params → 200400404500401403
GET
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/comments
Get artifact version comments
getArtifactVersionComments 3 params → 200400404500401403
POST
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/comments
Add new comment
addArtifactVersionComment 3 params body → 200400404500401403
PUT
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/comments/{commentId}
Update a comment
updateArtifactVersionComment 4 params body → 204400404500401403
DELETE
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/comments/{commentId}
Delete a single comment
deleteArtifactVersionComment 4 params → 204400404500401403
GET
/groups/{groupId}/artifacts/{artifactId}/versions
List artifact versions
listArtifactVersions 6 params → 200404500401403
POST
/groups/{groupId}/artifacts/{artifactId}/versions
Create artifact version
createArtifactVersion 3 params body → 200400404409422500401403
GET
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/content
Get artifact version
getArtifactVersionContent 4 params → 200400404500401403
PUT
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/content
Update artifact version content
updateArtifactVersionContent 3 params body → 204404405409500401403
GET
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/export
Export artifact version as ZIP
exportArtifactVersion 3 params → 200400404500401403
GET
/search/versions
Search for versions
searchVersions 16 params → 200500401403
POST
/search/versions
Search for versions by content
searchVersionsByContent 8 params body → 200400500401403
POST
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/render
Render a prompt template
renderPromptTemplate 3 params body → 200400404500401403
GET
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/state
Get artifact version state
getArtifactVersionState 3 params → 200404500401403
PUT
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/state
Update the artifact version state
updateArtifactVersionState 4 params body → 204400404409500401403

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are SearchedVersion (14 properties), VersionMetaData (14 properties), ReferenceGraphNode (8 properties), CreateVersion (7 properties). Each schema is shown below with its type and property counts.

ReferenceGraphMetadata
object
Metadata about the reference graph.
4 properties
ReferenceGraphNode
object
A node in the reference graph representing an artifact version.
8 properties 4 required
ProblemDetails
object
All error responses, whether 4xx or 5xx will include one of these as the response body.
6 properties 2 required
ArtifactType
string
VersionMetaData
object
14 properties 7 required
GroupId
string
An ID of a single artifact group.
VersionContent
object
4 properties 2 required
RuleViolationCause
object
2 properties
RenderValidationError
object
A validation error encountered when validating template variables.
4 properties 2 required
ReferenceType
string
ArtifactReference
object
A reference to a different artifact. Typically used with artifact types that can have dependencies like Protobuf.
4 properties 3 required
WrappedVersionState
object
1 property 1 required
ReferenceGraphDirection
string
The direction of references to include in the graph.
VersionSearchResults
object
Describes the response received when searching for artifacts.
2 properties 2 required
Labels
object
User-defined name-value pairs. Name and value must be strings.
Comment
object
4 properties 4 required
ReferenceGraph
object
A graph representation of artifact references.
4 properties 4 required
NewComment
object
1 property 1 required
FileContent
string
ArtifactId
string
The ID of a single artifact.
RenderPromptResponse
object
Response from rendering a prompt template.
5 properties 1 required
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…
VersionSortBy
string
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…
ReferenceGraphEdge
object
An edge in the reference graph representing a reference from one artifact to another.
3 properties 2 required
RenderPromptRequest
object
Request body for rendering a prompt template with variable substitution.
1 property 1 required
SortOrder
string
SearchedVersion
object
Models a single artifact from the result set returned when searching for artifacts.
14 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apicurio-versions-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 Artifacts API
Apicurio Branches API
Apicurio Content API
Apicurio Contracts API
Where this information came from

This is an independent, third-party profile of Apicurio Versions 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.