Open documentation ↗Overview
Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Note: This product is available as a free trial for a time period of 60 days.
Apigee API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 109 endpoints.
At a glance
- Authentication
- OAuth
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Analytics
- Base URL
https://apigee.googleapis.com/- Version
- v1
- Endpoints
- 109
- OpenAPI
- Specification ↗
- Spec updated
- 2023-04-21
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://apigee.googleapis.com/v1/NAME" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN"const response = await fetch("https://apigee.googleapis.com/v1/NAME", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer YOUR_TOKEN",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://apigee.googleapis.com/v1/NAME",
headers={
"Accept": "application/json",
"Authorization": "Bearer YOUR_TOKEN",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /v1/organizations | Creates an Apigee organization. See [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). |
| POST | /v1/{instance}:reportStatus | Reports the latest status for a runtime instance. |
| GET | /v1/{name} | Gets a category on the portal. |
| POST | /v1/{name} | Updates a shared flow revision. This operation is only allowed on revisions which have never been deployed. After deployment a revision becomes immutable, even |
| PUT | /v1/{name} | Update an existing custom report definition |
| PATCH | /v1/{name} | Updates a category on the portal. |
| DELETE | /v1/{name} | Deletes a category from the portal. |
| POST | /v1/{name}/attributes | Updates attributes for a developer app. This API replaces the current attributes with those specified in the request. |
| GET | /v1/{name}/certificate | Gets the certificate from an alias in PEM-encoded form. |
| GET | /v1/{name}/csr | Generates a PKCS #10 Certificate Signing Request for the private key in an alias. |
| DELETE | /v1/{name}/data | Deletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in run |
| GET | /v1/{name}/deployments | Gets the deployment of a shared flow revision and actual state reported by runtime pods. |
| POST | /v1/{name}/deployments | Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the `override` parameter to `true` to have this revi |
| DELETE | /v1/{name}/deployments | Undeploys a shared flow revision from an environment. For a request path `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, |
| POST | /v1/{name}/deployments:generateDeployChangeReport | Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when |
| POST | /v1/{name}/deployments:generateUndeployChangeReport | Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when |
| GET | /v1/{name}/operations | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
| POST | /v1/{name}:activate | Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. **Note:** Not supported for Apigee hybrid. |
| POST | /v1/{name}:adjust | Adjust the prepaid balance for the developer. This API will be used in scenarios where the developer has been under-charged or over-charged. |
| POST | /v1/{name}:credit | Credits the account balance for the developer. |
| POST | /v1/{name}:expire | Expires an API product subscription immediately. |
| POST | /v1/{name}:generateDownloadUrl | Generates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be used |
| GET | /v1/{name}:getProjectMapping | Gets the project ID and region for an Apigee organization. |
| POST | /v1/{name}:getSyncAuthorization | Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in t |
| GET | /v1/{name}:listRevisions | ListSecurityProfileRevisions lists all the revisions of the security profile. |
| POST | /v1/{name}:setSyncAuthorization | Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning |
| POST | /v1/{orgenv}/securityStats:queryTabularStats | Retrieve security statistics as tabular rows. |
| POST | /v1/{orgenv}/securityStats:queryTimeSeriesStats | Retrieve security statistics as a collection of time series. |
| POST | /v1/{org}:setAddons | Configures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced. |
| GET | /v1/{parent} | Lists the Apigee organizations and associated Google Cloud projects that you have permission to access. See [Understanding organizations](https://cloud.google.c |
| POST | /v1/{parent}/aliases | Creates an alias from a key/certificate pair. The structure of the request is controlled by the `format` query parameter: - `keycertfile` - Separate PEM-encoded |
| GET | /v1/{parent}/analytics/datastores | List Datastores |
| POST | /v1/{parent}/analytics/datastores | Create a Datastore for an org |
| POST | /v1/{parent}/analytics/datastores:test | Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage |
| GET | /v1/{parent}/analytics/exports | Lists the details and status of all analytics export jobs belonging to the parent organization and environment. |
| POST | /v1/{parent}/analytics/exports | Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the s |
| GET | /v1/{parent}/apicategories | Lists the categories on the portal. |
| POST | /v1/{parent}/apicategories | Creates a new category on the portal. |
| GET | /v1/{parent}/apiproducts | Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned |
| POST | /v1/{parent}/apiproducts | Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of |
| GET | /v1/{parent}/apis | Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. |
| POST | /v1/{parent}/apis | Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the `nam |
| GET | /v1/{parent}/apps | Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100 developer |
| POST | /v1/{parent}/apps | Creates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to us |
| GET | /v1/{parent}/archiveDeployments | Lists the ArchiveDeployments in the specified Environment. |
| POST | /v1/{parent}/archiveDeployments | Creates a new ArchiveDeployment. |
| POST | /v1/{parent}/archiveDeployments:generateUploadUrl | Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to CreateArchiveD |
| GET | /v1/{parent}/attachments | Lists all attachments to an instance. **Note:** Not supported for Apigee hybrid. |
| POST | /v1/{parent}/attachments | Creates a new attachment of an environment to an instance. **Note:** Not supported for Apigee hybrid. |
| GET | /v1/{parent}/attributes | Returns a list of all developer attributes. |
| POST | /v1/{parent}/attributes | Updates developer attributes. This API replaces the existing attributes with those specified in the request. Add new attributes, and include or exclude any exis |
| POST | /v1/{parent}/canaryevaluations | Creates a new canary evaluation for an organization. |
| GET | /v1/{parent}/datacollectors | Lists all data collectors. |
| POST | /v1/{parent}/datacollectors | Creates a new data collector. |
| GET | /v1/{parent}/debugsessions | Lists debug sessions that are currently active in the given API Proxy revision. |
| POST | /v1/{parent}/debugsessions | Creates a debug session for a deployed API Proxy revision. |
| GET | /v1/{parent}/deployments | Lists all deployments of a shared flow revision. |
| GET | /v1/{parent}/developers | Lists all developers in an organization by email address. By default, the response does not include company developers. Set the `includeCompany` query parameter |
| POST | /v1/{parent}/developers | Creates a developer. Once created, the developer can register an app and obtain an API key. At creation time, a developer is set as `active`. To change the deve |
| GET | /v1/{parent}/endpointAttachments | Lists the endpoint attachments in an organization. |
| POST | /v1/{parent}/endpointAttachments | Creates an endpoint attachment. **Note:** Not supported for Apigee hybrid. |
| GET | /v1/{parent}/entries | Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. |
| POST | /v1/{parent}/entries | Creates key value entries in a key value map scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. |
| GET | /v1/{parent}/envgroups | Lists all environment groups. |
| POST | /v1/{parent}/envgroups | Creates a new environment group. |
| POST | /v1/{parent}/environments | CreateSecurityProfileEnvironmentAssociation creates profile environment association i.e. attaches environment to security profile. |
| GET | /v1/{parent}/hostQueries | Return a list of Asynchronous Queries at host level. |
| POST | /v1/{parent}/hostQueries | Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to th |
| GET | /v1/{parent}/hostSecurityReports | Return a list of Security Reports at host level. |
| POST | /v1/{parent}/hostSecurityReports | Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to th |
| GET | /v1/{parent}/instances | Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid. |
| POST | /v1/{parent}/instances | Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hy |
| POST | /v1/{parent}/keys | Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee fr |
| POST | /v1/{parent}/keys/create | Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee fr |
| POST | /v1/{parent}/keystores | Creates a keystore or truststore. - Keystore: Contains certificates and their associated keys. - Truststore: Contains trusted certificates used to validate a se |
| POST | /v1/{parent}/keyvaluemaps | Creates a key value map in an organization. |
| GET | /v1/{parent}/natAddresses | Lists the NAT addresses for an Apigee instance. **Note:** Not supported for Apigee hybrid. |
| POST | /v1/{parent}/natAddresses | Creates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not us |
| GET | /v1/{parent}/overrides | Lists all of the distributed trace configuration overrides in an environment. |
| POST | /v1/{parent}/overrides | Creates a trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override. U |
| GET | /v1/{parent}/queries | Return a list of Asynchronous Queries |
| POST | /v1/{parent}/queries | Submit a query to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In ad |
| GET | /v1/{parent}/rateplans | Lists all the rate plans for an API product. |
| POST | /v1/{parent}/rateplans | Create a rate plan that is associated with an API product in an organization. Using rate plans, API product owners can monetize their API products by configurin |
| POST | /v1/{parent}/references | Creates a Reference in the specified environment. |
| GET | /v1/{parent}/reports | Return a list of Custom Reports |
| POST | /v1/{parent}/reports | Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which |
| GET | /v1/{parent}/resourcefiles | Lists all resource files, optionally filtering by type. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api |
| POST | /v1/{parent}/resourcefiles | Creates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Reso |
| GET | /v1/{parent}/resourcefiles/{type} | Lists all resource files, optionally filtering by type. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api |
| GET | /v1/{parent}/resourcefiles/{type}/{name} | Gets the contents of a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/ |
| PUT | /v1/{parent}/resourcefiles/{type}/{name} | Updates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Reso |
| DELETE | /v1/{parent}/resourcefiles/{type}/{name} | Deletes a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-file |
| GET | /v1/{parent}/securityIncidents | ListSecurityIncidents lists all the security incident associated with the environment. |
| GET | /v1/{parent}/securityProfiles | ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles. |
| GET | /v1/{parent}/securityReports | Return a list of Security Reports |
| POST | /v1/{parent}/securityReports | Submit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. |
| GET | /v1/{parent}/sharedflows | Lists all shared flows in the organization. |
| POST | /v1/{parent}/sharedflows | Uploads a ZIP-formatted shared flow configuration bundle to an organization. If the shared flow already exists, this creates a new revision of it. If the shared |
| GET | /v1/{parent}/subscriptions | Lists all API product subscriptions for a developer. |
Showing the first 100 of 109 endpoints; the full list is in the documentation.
Questions
Does the Apigee API API need an API key?
Yes. The Apigee API API uses OAuth authentication; the documentation explains how to get credentials.
Does the Apigee API API support HTTPS?
Yes, the Apigee API API is served over HTTPS.
How many endpoints does the Apigee API API have?
Its OpenAPI description lists 109 endpoints in version v1. The first 100 are shown on this page.
What are alternatives to the Apigee API API?
Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.
Similar analytics APIs
Compare alternatives →Google Play Integrity API
AnalyticsThe Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.
OAuth1 endpoints
versionhistory.googleapis.com API
AnalyticsVersion History API - Prod
No auth4 endpoints
Doc Converter
AnalyticsThis api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)
No auth1 endpoints
Perspective Comment Analyzer API
AnalyticsThe Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.
OAuth2 endpoints
Safe Browsing API
AnalyticsEnables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.
No auth7 endpoints
Web Fonts Developer API
AnalyticsThe Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.
No auth1 endpoints
Listed from APIs.guru (CC0).