canonical: https://jentic.com/apis/googleapis.com/apigeeregistry

# Google Apigee Registry API

The Apigee Registry API stores, versions, and indexes API descriptions and machine-readable specs in a Google Cloud project. It models APIs, ApiVersions, ApiSpecs, ApiDeployments, and Artifacts as first-class resources, exposes revisions and rollback for specs, and supports artifact storage for governance metadata such as scorecards and lint reports. It works alongside Apigee runtime but does not depend on it.

## For AI agents

Catalog, version, and govern OpenAPI and other machine-readable specs in a Google Cloud-managed registry. Useful for agents that maintain an enterprise API inventory or governance pipeline.

## Scope

Does not handle runtime traffic, proxy execution, or developer portal hosting - use for cataloging, versioning, and governing API specs and deployments only.

## Capabilities

- Register APIs, versions, specs, and deployments as governed resources
- Manage spec revisions and roll back to a previous known-good version
- Attach artifacts (scorecards, lint reports, owners) to any registry resource
- Retrieve raw spec contents for downstream tooling
- List and search APIs across a Google Cloud organization
- Track long-running operations for registry mutations

## Use cases

### Enterprise API inventory and governance

Platform teams use the registry as the source of truth for every API the company exposes, internal or external. APIs, versions, specs, and deployments are first-class resources with revisions, so governance teams can answer 'what is the contract for v3?' or 'who owns this API?' from a stable, queryable surface.

Example prompt: Register API 'orders', create version 'v1', upload openapi.yaml as a spec revision, and tag it with artifact 'owner=payments-team'.

### Spec revision and rollback

Specs evolve. The registry's revisions and rollback endpoints let teams keep a clean linear history, mark known-good revisions, and revert to a previous revision without losing the breaking-change attempt for diffing later.

Example prompt: Roll back the current spec under projects/p/locations/global/apis/orders/versions/v1/specs/openapi to its previous revision and confirm via the returned resource.

### Artifact-driven governance

Lint scores, security scans, and ownership metadata attach as artifacts to APIs, versions, or specs. CI pipelines write artifacts on every spec push so dashboards and gating policies can read a single, structured place rather than scraping spreadsheets.

Example prompt: Attach an artifact named 'lint-report' with mimeType application/json containing the latest spectral output to spec 'openapi' under version v1 of API orders.

### AI agent governance assistant via Jentic

An AI agent reviews PRs that update OpenAPI specs, runs lint and breaking-change checks, and writes the results back to the registry as artifacts through Jentic. The agent calls the registry without holding the project's service account credentials directly.

Example prompt: After a PR merges, upload the new spec revision, attach a generated lint-report artifact, and post a summary into the PR thread.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /v1/{+name}/locations | List available locations |
| GET | /v1/{+name}/operations | List long-running operations |
| POST | /v1/{+name}:cancel | Cancel a long-running operation |
| DELETE | /v1/{+name}:deleteRevision | Delete a specific revision |
| GET | /v1/{+name}:getContents | Get raw spec contents |
| GET | /v1/{+name}:listRevisions | List revisions of a spec |
| POST | /v1/{+name}:rollback | Roll back a spec to a previous revision |

## Key resources

- **Apis** — Top-level API entries in the registry
- **ApiVersions** — Version records (e.g. v1, v2) under an API
- **ApiSpecs** — Spec documents with revision history
- **ApiDeployments** — Records of where a version is deployed at runtime
- **Artifacts** — Arbitrary metadata blobs attached to any registry resource

## Why Jentic

- **Setup:** Wiring the Apigee Registry API by hand means configuring Google OAuth2, scoping a service account for registry access, and minting access tokens for each spec and revision call yourself. Through Jentic you install once, import the Apigee Registry API from the API Directory, store the OAuth credential once, and your agent calls it.
- **Permission scoping:** This API puts the resource name in the URL path (/v1/{name}:getContents, /v1/{name}:listRevisions), so a rule can pin your agent to one registry resource: it can read contents and list revisions there and nothing else. You choose the operations it may call, so actions like deleting a revision or rolling back are not included unless you add them.
- **Credential handling:** Your Apigee Registry OAuth credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'register an API spec' or 'roll back an API version', and Jentic returns the matching registry operation with its input schema so the agent calls the right endpoint without reading the registry reference.

## Related APIs

- **Apigee API** — Apigee runtime that often hosts the proxies described in registry entries.
- **API Gateway API** — Lightweight gateway that can deploy specs sourced from the registry.
- **App Hub API** — Catalogs applications and their attached services across a Google Cloud org.

## FAQ

### What authentication does the Apigee Registry API use?

OAuth 2.0 with Google Cloud credentials. Through Jentic the service account JSON is vaulted and exchanged for scoped access tokens at runtime.

### Can I roll back a spec to a previous revision?

Yes. Specs are revisioned, and the rollback endpoint at /v1/{+name}:rollback restores a prior revision while preserving the failed revision for diffing. Use listRevisions to enumerate available revisions before rolling back.

### What are the rate limits for the Apigee Registry API?

Standard Google Cloud per-project per-minute quotas apply. The registry is a control-plane service and is rarely the bottleneck; large-scale spec uploads should still batch through API operations rather than parallelising thousands of concurrent calls.

### How do I store an OpenAPI spec through Jentic?

Search Jentic for 'upload API spec to apigee registry', load the schema for the apis.versions.specs.create operation, and execute it with the API name, version name, and base64-encoded spec contents. Jentic returns the new spec revision name.

### Is the Apigee Registry API free?

Apigee Registry is part of the Apigee product family. Pricing is documented under Apigee; the registry is generally available without a separate per-call fee, but storage and operations roll up under your Apigee billing.

### Do I need Apigee runtime to use the registry?

No. The registry can be used independently to track specs and deployments even if your runtime is API Gateway, AWS, or anything else. ApiDeployment records simply describe where a version is hosted.

### Can I limit what my agent is allowed to do with the Apigee Registry API?

Yes. Because you run Jentic One yourself, your own rules decide which registry operations and which OAuth credential your agent may use. The Apigee Registry API puts the resource name in the URL path (for example /v1/{name}:getContents and /v1/{name}:listRevisions), so you can pin an agent to a single registry resource and let it only read contents and list revisions there. Destructive actions like :rollback or :deleteRevision stay off unless you explicitly grant them.