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

# Google Apigee API

The Apigee API is the control plane for Google Cloud's enterprise API management platform. It exposes operations to develop and secure API proxies, deploy and undeploy proxy revisions, monitor traffic, configure environments and instances, manage developer apps and API products, and run analytics and monetization workflows. Resources include organizations, environments, API proxies, shared flows, target servers, key value maps, and developer portals.

## For AI agents

Manage the full lifecycle of Apigee API proxies, environments, developer apps, and API products. Useful for agents operating an enterprise API management program.

## Scope

Does not handle backend service hosting, runtime traffic processing, or non-Apigee gateway products - use for Apigee organization, proxy, developer, and analytics control-plane only.

## Capabilities

- Deploy and undeploy API proxy revisions across environments
- Manage developer apps, API products, and consumer keys
- Configure environments, instances, and target servers
- Maintain shared flows and policy bundles for reuse across proxies
- Run analytics queries and monetization rate plans
- Manage organization-level resources and IAM

## Use cases

### API proxy promotion across environments

Engineering builds a proxy in the dev environment, validates it, then promotes the same revision to test and prod. The deployments endpoints handle deploy and undeploy, and the operation handles report success or surface configuration errors so promotion is auditable rather than tribal knowledge.

Example prompt: Deploy revision 12 of proxy 'orders-v1' to environment 'prod' under organization my-org and confirm the deployment via the returned operation.

### Developer onboarding and key management

Partner platforms create developers, register apps under an API product, and surface the generated consumer key and secret. Apps can be revoked, rotated, or expanded to new products without leaving the platform's admin UI, because every step is exposed via the developer apps endpoints.

Example prompt: Create developer dev@partner.com, then create an app 'partner-app' assigned to product 'tier-2', and return the generated consumerKey.

### Traffic and error analytics

Operations teams query Apigee analytics for error rates, latency percentiles, and traffic mix across environments, then drive on-call dashboards or auto-remediation. The analytics endpoints accept dimension and metric filters so reports stay focused without dumping every log line.

Example prompt: Query the analytics endpoint for 4xx counts grouped by proxy in environment prod for the last hour and return the top 5 proxies.

### AI agent API platform operator via Jentic

An AI agent acting as an Apigee operator handles routine deploys, key rotations, and product changes by reading tickets and calling Jentic-mediated operations. The agent never holds the project's service account JSON; Jentic securely stores it and exchanges it for scoped tokens at call time.

Example prompt: On a ticket request 'rotate consumer key for partner-app', call the developers.apps update operation with a new consumerKey and post the new key into the ticket.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /v1/organizations | Create an Apigee organization |
| POST | /v1/{+name}/attributes | Update attributes on a resource |
| GET | /v1/{+name}/certificate | Retrieve an environment certificate |
| GET | /v1/{+name}/csr | Retrieve a certificate signing request |
| DELETE | /v1/{+name}/deployments | Undeploy proxy revisions |
| POST | /v1/{+instance}:reportStatus | Report instance status |

## Key resources

- **Organizations** — Top-level Apigee tenant containing environments and proxies
- **Environments** — Runtime environments where proxies are deployed
- **ApiProxies** — API proxy bundles and their revisions
- **Deployments** — Deploy and undeploy proxy revisions
- **Developers and Apps** — Manage external developers, apps, and consumer keys
- **ApiProducts** — Group proxies into consumable products with quotas
- **SharedFlows** — Reusable policy bundles included by multiple proxies

## Why Jentic

- **Setup:** Wiring the Apigee API by hand means setting up Google OAuth2, granting a service account org-level Apigee scopes, and refreshing tokens across its 130 control-plane operations yourself. Through Jentic you install once, import the Apigee 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}/attributes, /v1/{name}/certificate), so a rule can pin your agent to one Apigee organization or proxy: it can read certificates and CSRs and set attributes there and nothing else. You choose the operations it may call, so destructive ones like deleting deployments are not included unless you add them.
- **Credential handling:** Your Apigee 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 'deploy an Apigee proxy' or 'create a developer app', and Jentic returns the matching operation across the 130-endpoint surface with its input schema so the agent calls the right endpoint without reading the full Apigee reference.

## Related APIs

- **API Gateway API** — Lightweight gateway for fronting Cloud Run and Functions with OpenAPI specs.
- **Apigee Registry API** — Stores, versions, and indexes API specs alongside Apigee runtime.
- **App Engine Admin API** — Hosts backend services that Apigee proxies front.

## FAQ

### What authentication does the Apigee API use?

OAuth 2.0 with Google Cloud credentials. Service accounts with the appropriate Apigee roles call this API. Through Jentic the service account is vaulted and exchanged for scoped access tokens at runtime.

### Can I deploy a proxy revision across multiple environments at once?

Each deploy is per environment via /v1/organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments. Loop over environments to promote a single revision; each call returns its own operation handle to track.

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

Control-plane calls follow standard Google Cloud per-project quotas. Heavy operations (analytics queries, large deployments) consume more quota; analytics queries also have shape limits on dimensions and time ranges enforced by the Apigee analytics service.

### How do I create a developer app and consumer key through Jentic?

Search Jentic for 'create apigee developer app', load the schema for developers.apps.create, and execute it with the developer email, app name, and target API product. The response includes the generated consumerKey.

### Is the Apigee API free?

Control-plane calls do not have a separate fee, but Apigee itself is paid based on environment, traffic, and add-on tier. Calls fail until your project has an Apigee organization provisioned and licensed.

### How do I roll back a bad proxy deployment?

Undeploy the bad revision and deploy the previous known-good revision in the same environment. Both are calls under /v1/organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments - DELETE for undeploy and POST for deploy.

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

Yes. Because you run Jentic One yourself, your own rules decide which Apigee operations and credentials the agent may use. Since the Apigee API carries the resource name in the URL path, you can pin the agent to a single organization or proxy and allow only safe calls, such as reading an environment certificate or CSR and setting attributes on that resource. Destructive operations like undeploying proxy revisions or deleting deployments stay off limits unless you explicitly grant them.