Send Docs Feedback

Making management API calls from this page

  1. In the URL, replace any values enclosed in "{ }", such as your organization name.
  2. Set the Basic Authentication credentials: Edge email and password (user must be in the Org Admin role).
    If you don't have an Apigee account,
    go here.
  3. Tweak the parameters and request body as needed.
  4. Send the live request to Edge!

Audits

Method
Description

GET

List Audit Entries for an Organization

https://api.enterprise.apigee.com/v1/audits/organizations/{org_name}

Lists audit records for management operations for an organization. For API proxy revisions, deploy and...

GET

List Audit Entries for all API Products in an Organization

https://api.enterprise.apigee.com/v1/audits/organizations/{org_name}/apiproducts

Lists audit records for management operations for all API products in an organization. For every call made...

GET

List Audit Entries for an API Product

https://api.enterprise.apigee.com/v1/audits/organizations/{org_name}/apiproducts/{apiproduct_name}

Lists audit records for management operations for a specific API product in an organization. For every call...

GET

List Audit Entries for an API Proxy

https://api.enterprise.apigee.com/v1/audits/organizations/{org_name}/apis/{api_name}

Lists audit records for management operations for an API proxy in an organization. For API proxy revisions,...

GET

List Audit Entries for all Developers in an Organization

https://api.enterprise.apigee.com/v1/audits/organizations/{org_name}/developers

Lists audit records for management operations for all developers in an organization. For every call made to...

GET

List Audit Entries for a Developer

https://api.enterprise.apigee.com/v1/audits/organizations/{org_name}/developers/{developer_email}

Lists audit records for management operations for a developer. For every call made to the management API,...

GET

List Audit Entries for all Developer Apps

https://api.enterprise.apigee.com/v1/audits/organizations/{org_name}/developers/{developer_email}/apps

Lists audit records for management operations for all developer apps in an organization. For every call made...

GET

List Audit Entries for a Developer App

https://api.enterprise.apigee.com/v1/audits/organizations/{org_name}/developers/{developer_email}/apps/{app_name}

Lists audit records for management operations for a developer app. For every call made to the management API...

GET

List Audit Entries for all Users

https://api.enterprise.apigee.com/v1/audits/organizations/{org_name}/users

Lists audit records for management operations for all users in an organization. The audit records include...

GET

List Audit Entries for a User

https://api.enterprise.apigee.com/v1/audits/organizations/{org_name}/users/{user_email}

Lists audit records for management operations for a user in an organization. The audit records include when...

Cached Logs

Method
Description

GET

Get Cached Log Categories

https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/apis/{api_name}/cachedlogs/categories

Retrieves the names of the available cached log categories. Currently, "nodejs" is the only category...

GET

Get Cached Node.js Logs

https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/apis/{api_name}/cachedlogs/categories/nodejs

Retrieve the most recent number of Node.js log records for the specified API. The exact number of log records...

Organization

Method
Description

GET

Get Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}

Gets the profile of a specific organization. An organization is the base container for all objects in an...

API Product

Method
Description

GET

List API Products

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts

Get a list of all API product names for an organization.

POST

Create API Product

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts

Creates an API product in an organization. You create API products after you have proxied backend services...

GET

Search API Products

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts

Returns a list of API products filtered by attribute names and values.

PUT

Update API Product

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_name}

Updates an existing API product. You must include all required values, whether or not you are updating...

DELETE

Delete API Product

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_name}

Deletes an API product from an organization. Deleting an API product will cause app requests to the...

GET

Get Keys, Apps, Developers, or Companies for an API Product

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_name}

Gets a count or a list of any one of the following entities associated with an API product: keys, app IDs,...

GET

Get API Product

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_name}

Gets an API product by name. The API product name required in the request URL is not the "Display Name"...

POST

Updates all API Product Attributes

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_name}/attributes

Updates or creates API product attributes. This API replaces the current list of attributes with the...

GET

Gets all API Product Attributes

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_name}/attributes

Returns a list of all API product attributes.

POST

Updates API Product Attribute

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_name}/attributes/{attribute_name}

Updates the value of an API product attribute.

DELETE

Delete API Product Attribute

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_name}/attributes/{attribute_name}

Deletes an API product attribute.

GET

Get API Product Attribute

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_name}/attributes/{attribute_name}

Returns the value of an API product attribute.

API Proxy

Method
Description

GET

List API Proxies

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis

Gets the names of all API proxies in an organization. The names correspond to the names defined in the...

POST

Create an API Proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis

Creates an API Proxy. The API proxy that is created using this call will not be accessible at runtime until...

POST

Import a new API Proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis

Uploads a ZIP-formatted API proxy configuration bundle from a local machine to an organization on Edge. API...

DELETE

Delete API Proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}

Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be...

GET

Get API Proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}

Gets an API proxy by name, including a list of existing revisions of the proxy.

GET

Get API Proxy Deployment Details

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/deployments

Returns detail on all deployments of the API proxy for all environments. All deployments are listed in the...

PUT

Update API Proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}

Update a specific API proxy in an organization. Only the information to be updated needs to be included....

GET

Export API Proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}

Outputs an API proxy revision as a ZIP formatted bundle of code and config files. This enables local...

DELETE

Delete API Proxy Revision

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}

Deletes a revision of an API proxy and all policies, resources, endpoints, and revisions associated with it....

GET

Get API Proxy Revision Deployments

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/deployments

Get deployment details for a specific revision number of an API proxy.

GET

Get deployments for an organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/deployments

Returns a list of all API proxies that are deployed in all environments in an organization.

DELETE

Undeploy API Proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/deployments

Undeploys an API proxy revision from an environment.

POST

Deploy API Proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/deployments

Deploys a revision of an API proxy to an environment in an organization. API proxies cannot be invoked until...

KeyValueMaps

Method
Description

GET

List KeyValueMaps for an API proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/keyvaluemaps

List the name of all KeyValueMaps for an API proxy, and optionally returns an expanded view of all...

POST

Create KeyValueMap in an API proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/keyvaluemaps

Creates a KeyValueMap in an API proxy. A key/value map is a simple structure for persistently storing name...

DELETE

Delete KeyValueMap from an API proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/keyvaluemaps/{map_name}

Deletes a KeyValueMap and all associated entries from an API proxy.

GET

Get KeyValueMap in an API proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/keyvaluemaps/{map_name}

Gets a KeyValueMap in an API proxy by name, along with associated entries.

PUT

Update KeyValueMap in an API proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/keyvaluemaps/{map_name}

Updates an existing KeyValueMap in an API proxy. Does not override the existing map. Instead, this method...

POST

Create entries in an API proxy KeyValueMap (CPS)

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/keyvaluemaps/{map_name}/entries

Creates entries in an existing KeyValueMap scoped to an API proxy. A key cannot be larger than 2 KB. CPS...

POST

Update a KeyValueMap entry in an API proxy (CPS)

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/keyvaluemaps/{map_name}/entries/{entry_name}

Updates an entry in a KeyValueMap scoped to an API proxy. A key cannot be larger than 2 KB. CPS This API...

GET

Get KeyValueMap Entry in an API proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/keyvaluemaps/{map_name}/entries/{entry_name}

Gets a specific key/value map entry in an API proxy by name, along with associated entries.

DELETE

Delete KeyValueMap Entry in an API proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/keyvaluemaps/{map_name}/entries/{entry_name}

Deletes a specific key/value map entry in an API proxy by name, along with associated entries.

GET

List keys in an API proxy KeyValueMap (CPS)

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/keyvaluemaps/{map_name}/keys

Lists keys in a KeyValueMap scoped to an API proxy. A key cannot be larger than 2 KB. CPS This API can...

POST

Create entries in an API proxy revision KeyValueMap (CPS)

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision}/keyvaluemaps/{map_name}/entries

Creates entries in an existing KeyValueMap scoped to an API proxy revision. A key cannot be larger than 2 KB...

POST

Update a KeyValueMap entry in an API proxy revision (CPS)

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision}/keyvaluemaps/{map_name}/entries/{entry_name}

Updates an entry in a KeyValueMap scoped to an API proxy revision. A key cannot be larger than 2 KB. CPS...

GET

List keys in an API proxy revision KeyValueMap (CPS)

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision}/keyvaluemaps/{map_name}/keys

Lists keys in a KeyValueMap scoped to an API proxy revision. CPS This API can only be used in...

POST

Create KeyValueMap in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keyvaluemaps

Creates a KeyValueMap in an Environment. A key/value map is a simple structure for persistently storing...

GET

List KeyValueMaps in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keyvaluemaps

List the name of all KeyValueMaps for an environment, and optionally returns an expanded view of all...

DELETE

Delete KeyValueMap from an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keyvaluemaps/{map_name}

Deletes a KeyValueMap and all associated entries from an environment.

PUT

Update KeyValueMap in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keyvaluemaps/{map_name}

Updates an existing KeyValueMap in an environment. Does not override the existing map. Instead, this method...

GET

Get KeyValueMap in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keyvaluemaps/{map_name}

Gets a KeyValueMap in an environment by name, along with associated entries.

POST

Create entries in an environment KeyValueMap (CPS)

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keyvaluemaps/{map_name}/entries

Creates entries in an existing KeyValueMap scoped to an environment. A key cannot be larger than 2 KB....

DELETE

Delete KeyValueMap Entry in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keyvaluemaps/{map_name}/entries/{entry_name}

Deletes a specific key/value map entry in an Environment by name, along with associated entries.

GET

Get KeyValueMap Entry in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keyvaluemaps/{map_name}/entries/{entry_name}

Gets a specific key/value map entry in an Environment by name, along with associated entries.

POST

Update a KeyValueMap entry in an environment (CPS)

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keyvaluemaps/{map_name}/entries/{entry_name}

Updates an entry in a KeyValueMap scoped to an environment. A key cannot be larger than 2 KB. CPS This...

GET

List keys in an environment KeyValueMap (CPS)

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keyvaluemaps/{map_name}/keys

Lists keys in a KeyValueMap scoped to an environment. CPS This API can only be used in organizations with...

POST

Create KeyValueMap in an Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/keyvaluemaps

Creates a KeyValueMap in an Organization. A key/value map is a simple structure for persistently storing...

GET

List KeyValueMaps in an Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/keyvaluemaps

List the name of all KeyValueMaps for an organization, and optionally returns an expanded view of all...

GET

Get KeyValueMap in an Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/keyvaluemaps/{map_name}

Gets a KeyValueMap in an Organization by name, along with associated entries.

PUT

Update KeyValueMap in an Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/keyvaluemaps/{map_name}

Updates an existing KeyValueMap in an Organization. Does not override the existing map. Instead, this method...

DELETE

Delete KeyValueMap from an Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/keyvaluemaps/{map_name}

Deletes a KeyValueMap and all associated entries from an Organization.

POST

Create entries in an organization KeyValueMap (CPS)

https://api.enterprise.apigee.com/v1/organizations/{org_name}/keyvaluemaps/{map_name}/entries

Create entries in an existing KeyValueMap scoped to an organization. A key cannot be larger than 2 KB....

GET

Get KeyValueMap Entry in an Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/keyvaluemaps/{map_name}/entries/{entry_name}

Gets a specific key/value map entry in an Organization based on the key name of the entry.

DELETE

Delete KeyValueMap Entry in an Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/keyvaluemaps/{map_name}/entries/{entry_name}

Deletes a single key/value entry in the map of an Organization based on the key name.

POST

Update a KeyValueMap entry in an organization (CPS)

https://api.enterprise.apigee.com/v1/organizations/{org_name}/keyvaluemaps/{map_name}/entries/{entry_name}

Updates an entry in a KeyValueMap scoped to an organization. A key cannot be larger than 2 KB. CPS: This...

GET

List keys in an organization KeyValueMap (CPS)

https://api.enterprise.apigee.com/v1/organizations/{org_name}/keyvaluemaps/{map_name}/keys

Lists keys in a KeyValueMap scoped to an organization. CPS This API can only be used in organizations...

Data Mask

Method
Description

POST

Create Data Masks for an API Proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/maskconfigs

Create a data masks for an API proxy. You can capture message content to assist in runtime debugging of APIs...

GET

List Data Masks for an API Proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/maskconfigs

List all data masks for an API proxy.

GET

Get Data Mask Details for an API Proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/maskconfigs/{maskconfig_name}

Get the details for a data mask for an API proxy.

DELETE

Delete Data Masks for an API Proxy

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/maskconfigs/{maskconfig_name}

Delete a data mask for an API proxy.

GET

List Data Masks for an Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/maskconfigs

List all data masks for an organization.

POST

Create Data Masks for an Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/maskconfigs

Create a data masks for an organization. You can capture message content to assist in runtime debugging of...

GET

Get Data Mask Details for an Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/maskconfigs/{maskconfig_name}

Get the details for a data mask for an organization.

DELETE

Delete Data Masks for an Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/maskconfigs/{maskconfig_name}

Delete a data mask for an organization.

Resource File

Method
Description

POST

Import a resource file for an API

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/resourcefiles

Import and create a resource file for an API. Paste the contents of the file in the request body. You can...

GET

List resource files in an API

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/resourcefiles

Lists the resource files in an API.

GET

Get a resource file from an API

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/resourcefiles/{resource_type}/{resource_name}

Gets the body of a resource from an API.

DELETE

Deletes a resource file from an API

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/resourcefiles/{resource_type}/{resource_name}

Deletes a resource file from an API.

GET

List resource files in an environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/resourcefiles

Lists the resource files in an environment.

POST

Import a resource file for an environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/resourcefiles

Import and create a resource file for an environment. Paste the contents of the file in the request body....

DELETE

Deletes a resource file from an environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/resourcefiles/{resource_type}/{resource_name}

Deletes a resource file from an environment.

GET

Get a resource file from an environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/resourcefiles/{resource_type}/{resource_name}

Gets the body of a resource from an environment.

POST

Import a resource file for an organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/resourcefiles

Import and create a resource file for an organization. Paste the contents of the file in the request body....

GET

List resource files in an organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/resourcefiles

Lists the resource files in an organization.

DELETE

Deletes a resource file from an organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/resourcefiles/{resource_type}/{resource_name}

Deletes a resource file from an organization.

GET

Get a resource file for an organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/resourcefiles/{resource_type}/{resource_name}

Gets the body of a resource from an organization.

Node.js Management

Method
Description

GET

Gets npm dependencies for an API Proxy.

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision_num}/npm

Gets npm dependencies for an API Proxy.

POST

Manage Node Packaged Modules

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apis/{api_name}/revisions/{revision_num}/npm

Runs a specified npm command for an API proxy deployed on Apigee Edge. When you call this API, it is...

Apps

Method
Description

GET

List App IDs in an Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apps

List app IDs in an organization. You can return the full profile for each app by including the expand query...

GET

List App IDs in an App Family

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apps

Lists, by ID, all apps contained in an app family.

GET

List App IDs in an Organization by Key Status

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apps

Returns a list of app IDs within an organization that have the specified key status. Valid values for the...

GET

List App IDs by App Type

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apps

Lists app IDs by app type. Valid app types are developer (which returns all developer apps) and company (...

GET

Get App in an Organization by App ID

https://api.enterprise.apigee.com/v1/organizations/{org_name}/apps/{app_id}

Returns the app profile for the specified app ID.

Company

Method
Description

GET

List Companies

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies

List all companies in an organization, and optionally returns an expanded list of companies, displaying a...

POST

Create Company

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies

Creates a company in an organization. The company is always created with a status of active. To set the...

GET

Get Company Details

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}

List details for a company.

PUT

Set the Status of a Company

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}

Sets the status of a company to active or inactive. If you set the status to inactive, you cannot access the...

DELETE

Delete Company

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}

Deletes an existing company.

PUT

Update Company

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}

Updates an existing company.Send the complete company record as a payload with any changes you want to make....

Company App Family

Method
Description

POST

Create Company App Family

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/appfamilies

Creates a company app family. A company app family is a collection of apps associate with a company entity...

GET

List Company App Families

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/appfamilies

Lists all app families for a company in an organization, and optionally provide an expanded view of the app...

GET

Get Company App Family

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/appfamilies/{appfamily_name}

Gets a list of apps in an company app family.

POST

Update Company App Family

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/appfamilies/{appfamily_name}

Updates a company app family by modifying the apps associated with it. This method does not simply add the...

DELETE

Delete Company App Family

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/appfamilies/{appfamily_name}

Deletes a company app family.

DELETE

Remove Company App from Family

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/appfamilies/{appfamily_name}/apps/{app_name}

Remove an app from a company app family.

Company App

Method
Description

POST

Create Company App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/apps

Creates an app for a company. Note that you must first create a profile for the company in your organization...

GET

List Company Apps

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/apps

List company apps in an organization. Optionally specify to expand the response to include the profile for...

GET

Get Count of API Resources for Company App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/apps/{app_name}

Gets the count of API resources for a company app. The API resources are aggregated across all API products...

DELETE

Delete Company App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/apps/{app_name}

Deletes a company app.

PUT

Update Company App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/apps/{app_name}

Updates an existing company app. Request Payload Elements: Name Description Required...

Company App Keys

Method
Description

POST

Approve or Revoke a Specific Key of Company App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/apps/{app_name}/keys/{consumer_key}

Sets the state of a key associated with a company app to 'approved' or 'revoked'. An app with an...

DELETE

Delete Key for a Company App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/apps/{app_name}/keys/{consumer_key}

Deletes a key for a company app and removes all API products associated with the app. The key can no longer...

GET

Get Key Information for a Company App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/apps/{app_name}/keys/{consumer_key}

Gets information about the consumer key issued to a specific company app.

POST

Update Company App Key with API Product

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/apps/{app_name}/keys/{consumer_key}

Updates an existing company app key to add additional API products or attributes. Note that only a single API...

Developer within Company

Method
Description

POST

Add or Update Company Developers

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/developers

Adds a developer to a company, or updates an existing developer in the company. When updating an existing...

GET

List Developers in Company

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/developers

Lists all developers associated with a company.

DELETE

Remove Developer from Company

https://api.enterprise.apigee.com/v1/organizations/{org_name}/companies/{company_name}/developers/{developer_email}

Removes the association of a developer with a company.

Developer

Method
Description

GET

List Developers

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers

Lists all developers in an organization by email address. This call does not list any company developers who...

GET

Get Developer by App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers

Gets the developer profile by app name. The profile retrieved is for the developer associated with the app in...

POST

Create Developer

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers

Creates a profile for a developer in an organization. Once created, the developer can register an app and...

POST

Set Developer Status

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}

Sets a developer's status to active, inactive, or login_lock. By default, the status of a developer is set...

PUT

Update Developer

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}

Update an existing developer profile. To add new values or update existing values, submit the new or...

GET

Get Developer

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}

Returns the profile for a developer by email address or ID. All time values are UNIX time values. The profile...

DELETE

Delete Developer

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}

Deletes a developer from an organization. All apps associated with the developer are also removed from the...

GET

Gets all Developer Attributes

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/attributes

Returns a list of all developer attributes.

POST

Updates all Developer Attributes

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/attributes

Updates or creates developer attributes. This API replaces the current list of attributes with the...

GET

Get Developer Attribute

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/attributes/{attribute_name}

Returns the value of a developer attribute.

DELETE

Delete Developer Attribute

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/attributes/{attribute_name}

Deletes a developer attribute.

POST

Updates a Developer Attribute

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/attributes/{attribute_name}

Updates the value of a developer attribute.

Developer App Family

Method
Description

GET

List Developer App Families

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/appfamilies

Lists all developer app families in an organization. Optionally returns an expanded list of all app families...

POST

Create Developer App Family

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/appfamilies

Creates an app family for a developer. An app family is an association of one or more apps in the family. An...

GET

Get Developer App Family

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/appfamilies/{appfamily_name}

Gets a list of apps in an app family for a developer.

POST

Update Developer App Family

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/appfamilies/{appfamily_name}

Updates an existing app family to change its name or the list of apps in the family. You must specify the...

DELETE

Delete Developer App Family

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/appfamilies/{appfamily_name}

Deletes a developer's app family. The apps in the family are not affected.

DELETE

Remove Developer App from Family

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/appfamilies/{appfamily_name}/apps/{app_name}

Removes an app from a developer's app family. An app family requires at least one app. Therefore, removing...

Developer App

Method
Description

GET

List Developer Apps

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps

Lists all apps created by a developer in an organization, and optionally provides an expanded view of the...

POST

Create Developer App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps

Creates an app associated with a developer. The name is the unique ID of the app, which can be different...

DELETE

Delete Developer App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}

Deletes a developer's app.

GET

Get Developer App Details

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}

Get the profile of a specific developer app. All times in the response are UNIX times. Note that the...

POST

Approve or Revoke Developer App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}

Set the API key status of a developer app to 'approved' or 'revoked'. A revoked app cannot access any API...

POST

Regenerate the consumer key for a developer app

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}

Regenerates the consumer keys for the named developer app. This allows you to regenerate the keys for an app...

GET

Get Count of API Resources for Developer App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}

Gets the number of API resources that have been approved for access by a developer app in a specific...

PUT

Update Developer App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}

Updates a developer app. Only the information to be updated needs to be included in the request body. Note...

POST

Updates all App Attributes

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/attributes

Updates or creates app attributes. This API replaces the current list of attributes with the attributes...

GET

Gets all App Attributes

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/attributes

Returns a list of all app attributes.

GET

Get App Attribute

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/attributes/{attribute_name}

Returns the value of an app attribute.

POST

Updates an App Attribute

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/attributes/{attribute_name}

Updates an app attribute.

DELETE

Delete App Attribute

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/attributes/{attribute_name}

Deletes an app attribute.

PUT

Update the Scope of an App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/keys/{consumer_key}

Updates the scope of an app. Note that this API sets the scopes element under the apiProducts element in the...

Developer App Keys

Method
Description

GET

Get Key Details for a Developer App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/keys/{consumer_key}

Returns details for a consumer key for a developer app, including the key and secret value, associated API...

POST

Add API Product to Key

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/keys/{consumer_key}

Adds an API product to a developer app key, enabling the app that holds the key to access the API resources...

POST

Approve or Revoke Specific Key of Developer App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/keys/{consumer_key}

Set the status of an app's consumer key to 'approved' or 'revoked'. You can approve a consumer key that is...

DELETE

Delete Key for a Developer App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/keys/{consumer_key}

Deletes a consumer key that belongs to an app, and removes all API products associated with the app. Once...

DELETE

Remove API Product for a Specific Key

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/keys/{consumer_key}/apiproducts/{apiproduct_name}

Removes an API product from an app's consumer key, and thereby renders the app unable to access the API...

POST

Approve or Revoke API Product for a Key for a Developer App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/keys/{consumer_key}/apiproducts/{apiproduct_name}

Sets the association of an app's consumer key with an API product to 'approved' or 'revoked'. The API product...

Developer App Key Access Token

Method
Description

GET

Get OAuth 1.0 Access Tokens Count for a Developer App Key

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}/oauth1accesstokens

Get count of OAuth 1.0 access tokens for a developer's app key.

GET

Get OAuth 2.0 Access Tokens Count for a Developer App Key

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}/oauth2accesstokens

Get count of OAuth 2.0 access tokens for a developer's app key.

Developer App Access Token

Method
Description

GET

Get Count of OAuth 1.0 Access Tokens for a Developer App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email}/apps/{app_name}/oauth1accesstokens

Get count of OAuth 1.0 access tokens for a developer's app.

GET

Get a Count of OAuth 2.0 Access Tokens for a Developer App

https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers/{developer_email}/apps/{app_name}/oauth2accesstokens

Get count of OAuth 2.0 access tokens for a developer's app.

Environment

Method
Description

GET

Get Environment Names

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments

Gets the names of all environments in an organization. By default, an Apigee organization contains two...

GET

Get Environment Details

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}

Gets environment details, such as the UNIX times at which the environment was created and last modified, the...

GET

Get Deployment Details for an API Proxy in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/apis/{api_name}/deployments

Mention the organization name

GET

Get Deployment Details for an API Proxy Revision in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/deployments

Gets a list of all API proxies that are deployed to a specific environment.\ \ \ \  \ \ \ \ The server...

GET

Get API Proxy Deployments for an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/deployments

Gets a list of all API proxies that are deployed to a specific environment. The server element is used to...

Debug Session

Method
Description

GET

List debug sessions

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/debugsessions

List all debug sessions created by the Create Debug Session APi call or by the Trace tool in the Edge...

POST

Create a debug session

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/debugsessions

Create a debug session. A debug session records detailed information on messages, the Flow processing, and...

DELETE

Delete debug session

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/debugsessions/{session_name}

Deletes a debug session.

GET

Get debug session transaction IDs

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/debugsessions/{session_name}/data

Retrieves a list of transaction IDs for a debug session that was created by the Create Debug Session API call...

GET

Get debug session transaction data

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/apis/{api_name}/revisions/{revision_number}/debugsessions/{session_name}/data/{session_id}

Get debug session transaction data. Specify the ID of a debug transaction as returnd by the "Get debug...

Caches

Method
Description

GET

List caches in an environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/caches

List caches in an environment.

POST

Create a cache in an environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/caches

Creates a cache in an environment. Caches are created per environment. For data segregation, a cache created...

GET

Get information about a cache

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/caches/{cache_name}

Gets information about a cache. The response might contain a property named persistent. That property is no...

DELETE

Delete a cache

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/caches/{cache_name}

Deletes a cache.

PUT

Update a cache in an environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/caches/{cache_name}

Updates a cache in an environment. You must specify the complete definition of the cache, including the...

POST

Clear all cache entries

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/caches/{cache_name}/entries

Clears all cache entries. Entries to be cleared can be scoped by CacheKey prefix by using the 'prefix'...

POST

Clear a cache entry

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/caches/{cache_name}/entries/{entry}

Clears a cache entry, which is identified by the full CacheKey prefix and value. For more on cache keys, see...

Keystores and Truststores

Method
Description

POST

Create a Keystore or Truststore

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keystores

Create a keystore or truststore in an environment. To configure functionality that relies on public key...

GET

List Keystores and Truststores

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keystores

Returns a list of all keystores and truststores in the environment.

GET

Get a Keystore or Truststore

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}

Returns a specific keystore or truststore in the environment.

DELETE

Delete a Keystore or Truststore

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}

Deletes a keystore or truststore in an environment.

POST

Upload a Certificate to a Truststore

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}/certs

Uploads a certificate as a PEM file to a truststore in an environment. If the cert is part of a chain, then...

GET

Get a Cert from a Keystore or Truststore

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}/certs/{cert_name}

Returns a specific cert from a keystore or truststore.

POST

Upload a JAR file to a Keystore

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}/keys

Uploads a JAR file to a keystore in an environment. After you create a named keystore in an environment,...

Analytics

Method
Description

GET

Retrieve and Filter Metrics for a Dimension

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/stats/{dimension_name}

Retrieve and filter metrics for a dimension. For a list of examples using this API, see Analytics command...

GET

Subscribe or Unsubscribe from Analytics Report

https://api.enterprise.apigee.com/v1/organizations/{org_name}/stats/preferences/reports/dailysummaryreport

All organization administrators are automatically subscribed to receive daily analytics summary reports...

GET

Get List of Subscribed and Unsubscribed Users

https://api.enterprise.apigee.com/v1/organizations/{org_name}/stats/preferences/reports/dailysummaryreport/users

Return the list of users who have opted in (subscribed) or opted out (unsubscribed) from the daily analytics...

Target Server

Method
Description

GET

List TargetServers in an environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/targetservers

List all TargetServers in an environment.

POST

Create a TargetServer

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/targetservers

Create a TargetServer in the specified environment. TargetServers are used to decouple TargetEndpoint...

GET

Get TargetServer

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/targetservers/{targetserver_name}

Returns a TargetServer definition.

DELETE

Delete a TargetServer

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/targetservers/{targetserver_name}

Delete a TargetServer configuration from an environment. Returns information about the deleted TargetServer.

PUT

Update a TargetServer

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/targetservers/{targetserver_name}

Modifies an existing TargetServer. For example, use this method to toggles a TargetServer configuration...

Vaults

Method
Description

POST

Create a Vault in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/vaults

Creates a vault in a specified environment. For key information about the appropriate use of vaults as...

GET

Get Vault Names in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/vaults

Gets a list of vault names in a specified environment. For key information about the appropriate use of...

GET

Get List of Entries in a Vault in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/vaults/{vault_name_in_env}

Gets a list of entries in a vault in a specified environment. This will not retrieve the encrypted values of...

DELETE

Delete a Vault in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/vaults/{vault_name_in_env}

Deletes an entire vault in a specified environment. For key information about the appropriate use of...

POST

Create a Vault Entry in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/vaults/{vault_name_in_env}/entries

Creates an entry with a specific name and secure value in a vault in a specified environment. For key...

GET

Get a Vault Entry in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/vaults/{vault_name_in_env}/entries/{entry_name}

Gets an entry in a vault in a specified environment. This will not retrieve the encrypted value of the entry...

DELETE

Delete a Vault Entry in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/vaults/{vault_name_in_env}/entries/{entry_name}

Deletes an entry in a vault in a specified environment. For key information about the appropriate use of...

POST

Validate a Vault Entry's Secure Value in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/vaults/{vault_name_in_env}/entries/{entry_name}

Compares a value that you supply against a vault entry's secured value in a specified environment. Enter the...

PUT

Replace Secured Value of Vault Entry in an Environment

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/vaults/{vault_name_in_env}/entries/{entry_name}

Replaces the existing secured value of a vault entry with a value that you supply. Enter the value that...

GET

Get Vault Names in an Org

https://api.enterprise.apigee.com/v1/organizations/{org_name}/vaults

Gets a list of vault names in a specific org. For key information about the appropriate use of vaults as...

POST

Create a Vault in an Org

https://api.enterprise.apigee.com/v1/organizations/{org_name}/vaults

Creates a vault in a specified org. For key information about the appropriate use of vaults as secure...

DELETE

Delete a Vault in an Org

https://api.enterprise.apigee.com/v1/organizations/{org_name}/vaults/{vault_name_in_org}

Deletes an entire vault in a specified org. For key information about the appropriate use of vaults as...

GET

Get List of Entries in a Vault in an Org

https://api.enterprise.apigee.com/v1/organizations/{org_name}/vaults/{vault_name_in_org}

Gets a list of entries in a vault in a specified org. This will not retrieve the encrypted values of the...

POST

Create a Vault Entry in an Org

https://api.enterprise.apigee.com/v1/organizations/{org_name}/vaults/{vault_name_in_org}/entries

Creates an entry with a specific name and secure value in a vault in a specified org. For key information...

PUT

Replace a Vault Entry Value in an Org

https://api.enterprise.apigee.com/v1/organizations/{org_name}/vaults/{vault_name_in_org}/entries/{entry_name}

Replaces the existing secured value of a vault entry with a value that you supply. Enter the value that...

GET

Get a Vault Entry in an Org

https://api.enterprise.apigee.com/v1/organizations/{org_name}/vaults/{vault_name_in_org}/entries/{entry_name}

Gets an entry in a vault in a specified org. This will not retrieve the encrypted value of the vault entry...

DELETE

Delete a Vault Entry in an Org

https://api.enterprise.apigee.com/v1/organizations/{org_name}/vaults/{vault_name_in_org}/entries/{entry_name}

Deletes an entry in a vault in a specified org. For key information about the appropriate use of vaults as...

POST

Validate a Vault Entry's Secure Value in an Org

https://api.enterprise.apigee.com/v1/organizations/{org_name}/vaults/{vault_name_in_org}/entries/{entry_name}

Compares a value that you supply against a vault entry's secured value in a specified org. Enter the value...

Virtual Host

Method
Description

GET

List Virtual Hosts

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/virtualhosts

Lists all virtual hosts in an environment. By default, two virtual hosts are available for each environment...

POST

Create a Virtual Host

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/virtualhosts

Edge on-premises installation only. For an Edge cloud installation, contact Apigee Customer Support....

PUT

Update a Virtual Host

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/virtualhosts/{virtualhost_name}

Apigee Edge for Private Cloud installation only. For use in Edge cloud, contact Apigee Customer Support....

DELETE

Delete a Virtual Host

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/virtualhosts/{virtualhost_name}

Edge on-premises installation only. For an Edge cloud installation, contact Apigee Customer Support. Deletes...

GET

Get Virtual Host

https://api.enterprise.apigee.com/v1/organizations/{org_name}/environments/{env_name}/virtualhosts/{virtualhost_name}

Gets details for a named virtual host. Every environment has at least one virtual host that defines the HTTP...

OAuth 1.0a Access Token

Method
Description

GET

Get Count Of OAuth 1.0a Access Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/accesstokens

Returns a count of all 1.0a access tokens in an organization.

DELETE

Delete OAuth 1.0a Access Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/accesstokens/{access_token}

Deletes the specified access token.

POST

Approve or Revoke OAuth 1.0a Access Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/accesstokens/{access_token}

Approves or revokes the specified access token.

GET

Get OAuth 1.0a Access Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/accesstokens/{access_token}

Gets the details for the specified access token. DEPRECATED: This API is deprecated and will be removed from...

POST

Update OAuth 1.0a Access Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/accesstokens/{access_token}

Updates the attributes of given access token. The scope property is required. Only specify other properties...

OAuth 1.0a Request Token

Method
Description

GET

List OAuth 1.0a Request Tokens

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/requesttokens

Returns a detailed list of all OAuth 1.0a request tokens.

GET

Get OAuth 1.0a Request Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/requesttokens/{request_token}

Gets the Oauth 1.0 a request token for the speficied consumer key.

DELETE

Delete OAuth 1.0a Request Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/requesttokens/{request_token}

Deletes the specified OAuth 1.0a request token.

POST

Update OAuth 1.0a Request Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/requesttokens/{request_token}

Updates an OAuth 1.0a request token with a new profile.

POST

Approve or Revoke OAuth 1.0a Request Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/requesttokens/{request_token}

Approves or revokes an OAuth 1.0 a request token.

OAuth 1.0a Verifier Code

Method
Description

GET

List OAuth 1.0a Verifier Code

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/verifiers

Gets a list of all OAuth 1.0a verifier codes and details for each verifier in an organization.

GET

Get OAuth 1.0a Verifier Code

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/verifiers/{verifier_code}

Gets the detail of an OAuth 1.0a verifier code.

DELETE

Delete OAuth 1.0a Verifier Code

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1/verifiers/{verifier_code}

Deletes the specified OAuth 1.0a verifier code, which is the verifier code given by the provider.

OAuth 2.0 Access Token

Method
Description

GET

Get Count of OAuth 2.0 Access Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth2/accesstokens

Get count of OAuth 2.0 access tokens for an organization. DEPRECATED: This API is deprecated and will be...

DELETE

Delete OAuth 2.0 Access Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth2/accesstokens/{access_token}

Deletes a specific OAuth 2.0 access token.

POST

Approve or Revoke OAuth 2.0 Access Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth2/accesstokens/{access_token}

Approves or revokes an OAuth 2.0 access token.

GET

Get OAuth 2.0 Access Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth2/accesstokens/{access_token}

Gets details of a specific OAuth 2.0 access token.

POST

Update OAuth 2.0 Access Token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth2/accesstokens/{access_token}

Updates the OAuth 2.0 access token attributes. Only attributes specified in the request body are updated. Any...

POST

Revoke OAuth 2.0 Access Token by End User ID or App ID

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth2/revoke

This API call is available for Apigee Edge Enterprise plans only.This API call is available for Apigee Edge...

GET

Get OAuth 2.0 Access Token by End User ID or App ID

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth2/search

This API call is available for Apigee Edge Enterprise plans only. Retrieves an OAuth 2.0 access token by end...

OAuth 2.0 Authorization Code

Method
Description

GET

List OAuth 2.0 Authorization Codes

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth2/authorizationcodes

Lists all OAuth 2.0 authorization codes in an organization.

GET

Get OAuth 2.0 Authorization Code

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth2/authorizationcodes/{authorization_code}

Get details about a specific OAuth 2.0 authorization code.

DELETE

Delete OAuth 2.0 Authorization Code

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth2/authorizationcodes/{authorization_code}

Deletes the OAuth 2.0 authorization code.

OAuth 2.0 Refresh Token

Method
Description

POST

Approve or revoke an OAuth 2.0 refresh token

https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth2/refreshtokens/{refresh_token}

Approve or revoke an OAuth 2.0 refresh token.

Reports

Method
Description

GET

Lists Reports

https://api.enterprise.apigee.com/v1/organizations/{org_name}/reports

Lists all the reports in an organization. The report name is the report's numeric UUID, such as 62d9de1f-...

POST

Create an Analytics report

https://api.enterprise.apigee.com/v1/organizations/{org_name}/reports

Generates metadata for an analytics report. For more information on metrics, dimensions, and other report...

DELETE

Delete a Report

https://api.enterprise.apigee.com/v1/organizations/{org_name}/reports/{report_name}

Delete a report from an organization. For the report name, use the "name" value, which is the report's...

GET

Get a Report

https://api.enterprise.apigee.com/v1/organizations/{org_name}/reports/{report_name}

Gets the contents of a report stored in an organization on Apigee Edge. For the report name, use the "name...

PUT

Update a Report

https://api.enterprise.apigee.com/v1/organizations/{org_name}/reports/{report_name}

Update the definition of an existing report. For the report name, use the 'name' value, which is the report'...

Custom Aggregates

Method
Description

GET

List custom aggregates

https://api.enterprise.apigee.com/v1/organizations/{org_name}/stats/customaggregates

Returns the list of custom aggregates. Use the status query parameter to customize the list. The returned...

POST

Create custom aggregate

https://api.enterprise.apigee.com/v1/organizations/{org_name}/stats/customaggregates

Creates a new custom aggregate table and starts aggregation. The name of this custom aggregate table should...

PUT

Activate or deactivate custom aggregate

https://api.enterprise.apigee.com/v1/organizations/{org_name}/stats/customaggregates/{custom_agg_name}

Activates (restarts) or deactivates a custom aggregate. The name of an aggregate is a combination of the...

GET

Get custom aggregate

https://api.enterprise.apigee.com/v1/organizations/{org_name}/stats/customaggregates/{custom_agg_name}

Returns the specified custom aggregate. The name of an aggregate is a combination of the displayName...

Roles at Organization Level

Method
Description

POST

Add Roles to Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles

Creates one ore more user roles in an organization.

GET

List Roles of Organization

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles

Gets a list of roles available to users in an organization.

GET

Get Role

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles/{role_name}

Gets a user role.

DELETE

Delete Role

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles/{role_name}

Deletes a role from an organization. Roles can only be deleted when no users are in the role.

POST

Add a user to a role

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles/{role_name}/users

Add a user to a role.

GET

Get users for a role

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles/{role_name}/users

Returns a list of all system users associated with a role.

GET

Verify user role membership

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles/{role_name}/users/{user_email}

Verify user role membership.

DELETE

Remove user membership in role

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles/{role_name}/users/{user_email}

Remove user membership in role.

Permissions for Resource at Organization Level

Method
Description

GET

Get Permission for a Resource

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles/{role_name}/permissions

Gets a list of permissions associated with the specified resource.

GET

List Permissions for All Resources Associated with a Role

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles/{role_name}/permissions

Gets permissions for all resources associated with a user role.

POST

Add Permissions for Resource to a Role

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles/{role_name}/permissions

In Apigee Edge, different user roles are assigned different permissions to view (GET), create or update (both...

DELETE

Delete Permission for Resource

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles/{role_name}/permissions/{permission}

Removes a permission from a resource for the role specified.

GET

Verify User Role Permission for Resource

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles/{role_name}/permissions/{permission}

Verifies that a user role's permission on a specific resource exists. Returns a value of true or false.

POST

Add Multiple Resource Permissions for Resource

https://api.enterprise.apigee.com/v1/organizations/{org_name}/userroles/{role_name}/resourcepermissions

Adds multiple permissions to multiple resources simultaneously.

Help or comments?