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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Apicurio

Apicurio Contracts API

The Contracts API from Apicurio — 16 operation(s) for contracts.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 27 operations across 16 paths, and defines 16 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.

27 operations 16 paths 16 schemas 4 DELETE12 GET5 POST6 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
Apicurio
License
Apache 2.0
Resource Areas
1

Authentication & Security 2

Apicurio Contracts 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 27

Across 16 paths, the API surfaces 27 operations — 4 DELETE, 12 GET, 5 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Contracts 27
GET
/admin/contracts/ruleset
Get global contract ruleset
getGlobalContractRuleset → 200500
PUT
/admin/contracts/ruleset
Set global contract ruleset
setGlobalContractRuleset body → 200500
DELETE
/admin/contracts/ruleset
Delete global contract ruleset
deleteGlobalContractRuleset → 204500
GET
/search/contract/rules
Search contract rules by tag
searchContractRulesByTag 1 param → 200400500
GET
/search/contracts
Search contracts
searchContracts 7 params → 200500
GET
/groups/{groupId}/artifacts/{artifactId}/contract/metadata
Get contract metadata
getContractMetadata 2 params → 200404500
PUT
/groups/{groupId}/artifacts/{artifactId}/contract/metadata
Update contract metadata
updateContractMetadata 2 params body → 200400404500
POST
/groups/{groupId}/artifacts/{artifactId}/contract/status
Transition contract status
transitionContractStatus 2 params body → 200400404409500
GET
/groups/{groupId}/artifacts/{artifactId}/contract/ruleset
Get artifact contract ruleset
getArtifactContractRuleset 2 params → 200404500
PUT
/groups/{groupId}/artifacts/{artifactId}/contract/ruleset
Set artifact contract ruleset
setArtifactContractRuleset 2 params body → 200400500
DELETE
/groups/{groupId}/artifacts/{artifactId}/contract/ruleset
Delete artifact contract ruleset
deleteArtifactContractRuleset 2 params → 204500
GET
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/contract/ruleset
Get version contract ruleset
getVersionContractRuleset 3 params → 200404500
PUT
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/contract/ruleset
Set version contract ruleset
setVersionContractRuleset 3 params body → 200400404500
DELETE
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/contract/ruleset
Delete version contract ruleset
deleteVersionContractRuleset 3 params → 204404500
POST
/groups/{groupId}/contracts
Submit an ODCS contract
submitContract 1 param body → 200400500
GET
/groups/{groupId}/contracts
List ODCS contracts
listContracts 3 params → 200500
GET
/groups/{groupId}/contracts/{contractId}
Get an ODCS contract
getContract 2 params → 200404500
PUT
/groups/{groupId}/contracts/{contractId}
Update an ODCS contract
updateContract 2 params body → 200400404500
DELETE
/groups/{groupId}/contracts/{contractId}
Delete an ODCS contract
deleteContract 2 params → 204404500
GET
/groups/{groupId}/artifacts/{artifactId}/contract/export
Export as ODCS
exportContractAsOdcs 2 params → 200404500
POST
/groups/{groupId}/artifacts/{artifactId}/contract/promote
Promote contract stage
promoteContract 2 params body → 200400404500
GET
/groups/{groupId}/artifacts/{artifactId}/contract/quality
Get quality score
getContractQuality 3 params → 200404500
GET
/groups/{groupId}/artifacts/{artifactId}/contract/audit
Get contract audit log
getContractAuditLog 4 params → 200404500
GET
/groups/{groupId}/artifacts/{artifactId}/contract/compatibility-group
Get compatibility group
getCompatibilityGroup 3 params → 200404500
PUT
/groups/{groupId}/artifacts/{artifactId}/contract/compatibility-group
Set compatibility group
setCompatibilityGroup 2 params body → 204400404500
POST
/groups/{groupId}/artifacts/{artifactId}/contract/migrate
Migrate record between versions
migrateContractRecord 2 params body → 200400404500
POST
/groups/{groupId}/artifacts/{artifactId}/versions/{versionExpression}/contract/execute
Execute contract rules
executeContractRules 3 params body → 200400404500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ContractRule (10 properties), ContractMetadata (10 properties), SearchedArtifact (10 properties), EditableContractMetadata (7 properties). Each schema is shown below with its type and property counts.

OdcsProjectionSummary
object
Summary of the projection performed when an ODCS contract is applied.
4 properties
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
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
OdcsContractSummary
object
Summary of an ODCS contract.
2 properties
EditableContractMetadata
object
Editable contract metadata fields.
7 properties
OdcsContractResult
object
Result of submitting or updating an ODCS contract.
3 properties
Labels
object
User-defined name-value pairs. Name and value must be strings.
ContractRuleSet
object
A set of contract rules, divided into domain and migration categories.
2 properties
ContractStatusTransition
object
Request body for transitioning the contract lifecycle status.
1 property 1 required
ArtifactSearchResults
object
Describes the response received when searching for artifacts.
2 properties 2 required
ArtifactId
string
The ID of a single artifact.
ContractRule
object
A single contract rule definition.
10 properties 4 required
ContractRuleSearchResult
object
A contract rule with its artifact coordinates, returned by tag search.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apicurio-contracts-api-openapi.yml Raw ↑

Other APIs Apicurio publishes across the network.

Apicurio Registry
AE Profile APIs.io
Apicurio Studio
AE Profile APIs.io
Apicurio Data Models
AE Profile APIs.io
Apicurio Codegen
AE Profile APIs.io
Apicurio Admin API
AE Profile APIs.io
Apicurio AI API
AE Profile APIs.io
Apicurio Artifact rules API
AE Profile APIs.io
Apicurio Artifact Type API
AE Profile APIs.io
Apicurio Artifacts API
AE Profile APIs.io
Apicurio Branches API
AE Profile APIs.io
Apicurio Content API
AE Profile APIs.io
Apicurio GitOps API
AE Profile APIs.io
#Contracts
← Back to A APIs
API Details
ID
apicurio:apicurio-contracts-api
Server
http://localhost:8080/apis/registry/v3
Docs
https://www.apicur.io/registry/
Provider
Apicurio
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=apicurio-contracts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/apicurio-contracts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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