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

The Admin API from Apicurio — 17 operation(s) for admin.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 28 operations across 17 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.

28 operations 17 paths 25 schemas 5 DELETE14 GET5 POST4 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 Admin 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 28

Across 17 paths, the API surfaces 28 operations — 5 DELETE, 14 GET, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Admin 28
GET
/admin/rules
List global rules
listGlobalRules → 200500401403
POST
/admin/rules
Create global rule
createGlobalRule body → 204400409500401403
DELETE
/admin/rules
Delete all global rules
deleteAllGlobalRules → 204500401403
GET
/admin/rules/{ruleType}
Get global rule configuration
getGlobalRuleConfig 1 param → 200404500401403
PUT
/admin/rules/{ruleType}
Update global rule configuration
updateGlobalRuleConfig 1 param body → 200404500401403
DELETE
/admin/rules/{ruleType}
Delete global rule
deleteGlobalRule 1 param → 204404500401403
GET
/admin/export
Export registry data
exportData 2 params → 200404500401403
POST
/admin/import
Import registry data
importData 3 params body → 201409500401403
GET
/admin/roleMappings/{principalId}
Return a single role mapping
getRoleMapping 1 param → 200404500401403
PUT
/admin/roleMappings/{principalId}
Update a role mapping
updateRoleMapping 1 param body → 204404500401403
DELETE
/admin/roleMappings/{principalId}
Delete a role mapping
deleteRoleMapping 1 param → 204404500401403
GET
/admin/config/properties
List all configuration properties
listConfigProperties → 200500401403
GET
/admin/config/properties/{propertyName}
Get configuration property value
getConfigProperty 1 param → 200404500401403
PUT
/admin/config/properties/{propertyName}
Update a configuration property
updateConfigProperty 1 param body → 204404500401403
DELETE
/admin/config/properties/{propertyName}
Reset a configuration property
resetConfigProperty 1 param → 204404500401403
GET
/admin/roleMappings
List all role mappings
listRoleMappings 2 params → 200500401403
POST
/admin/roleMappings
Create a new role mapping
createRoleMapping body → 204500401403
GET
/admin/config/artifactTypes
List artifact types
listArtifactTypes → 200500401403
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
POST
/admin/snapshots
Trigger storage snapshot
triggerSnapshot → 200500401403
GET
/admin/gitops/status
Get GitOps synchronization status
getGitOpsStatus → 200409500401403
POST
/admin/gitops/sync
Trigger GitOps synchronization
triggerGitOpsSync → 204409500401403
GET
/admin/usage/summary
Get usage summary
getUsageSummary → 200409500
GET
/admin/usage/artifacts/{groupId}/{artifactId}
Get artifact usage metrics
getArtifactUsageMetrics 2 params → 200404409500
GET
/admin/usage/artifacts/{groupId}/{artifactId}/heatmap
Get consumer version heatmap
getConsumerVersionHeatmap 2 params → 200409500
GET
/admin/usage/artifacts/{groupId}/{artifactId}/versions/{version}/deprecation-readiness
Get deprecation readiness report
getDeprecationReadiness 3 params → 200409500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are ContractRule (10 properties), GitOpsStatus (8 properties), VersionUsageMetrics (8 properties), ProblemDetails (6 properties). Each schema is shown below with its type and property counts.

VersionUsageMetrics
object
Usage metrics for a specific artifact version.
8 properties 7 required
RoleMappingSearchResults
object
Describes the response received when searching for artifacts.
2 properties 2 required
ProblemDetails
object
All error responses, whether 4xx or 5xx will include one of these as the response body.
6 properties 2 required
UpdateRole
object
1 property 1 required
GitOpsStatus
object
Describes the current synchronization status of the GitOps storage backend. This includes the current sync state, the Git commit marker, load statistics, and a…
8 properties
UsageClassification
string
Classification of schema usage based on last fetch time.
SnapshotMetaData
object
1 property 1 required
DeprecationReadiness
object
6 properties 4 required
ConsumerVersionHeatmap
object
4 properties 4 required
RoleType
string
ArtifactTypeInfo
object
1 property
CreateRule
object
2 properties 1 required
Rule
object
2 properties 1 required
RuleType
string
ContractRuleSet
object
A set of contract rules, divided into domain and migration categories.
2 properties
UpdateConfigurationProperty
object
1 property 1 required
ArtifactUsageMetrics
object
3 properties 3 required
GitOpsError
object
Describes an error that occurred during a GitOps sync attempt.
3 properties 1 required
FileContent
string
ConfigurationProperty
object
5 properties 5 required
ConsumerVersionEntry
object
4 properties 1 required
DownloadRef
object
Models a download "link". Useful for browser use-cases.
2 properties 1 required
RoleMapping
object
The mapping between a user/principal and their role.
3 properties 2 required
UsageSummary
object
3 properties 3 required
ContractRule
object
A single contract rule definition.
10 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apicurio-admin-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 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 Contracts API
AE Profile APIs.io
Apicurio GitOps API
AE Profile APIs.io
#Admin
← Back to A APIs
API Details
ID
apicurio:apicurio-admin-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-admin-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/apicurio-admin-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 Admin 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.