Send Docs Feedback

Beta Release of SmartDocs

1. In the Resource URL, replace any values enclosed in "{}", such as your organization name.
2. Set the Basic Authentication credentials. These are your Edge email and password (user must be in the Org Admin role).
3. Tweak the Request Body as needed (if a body is needed).
4. Send the live request to Edge and view the response! You can also view Request data.

Edge Management Server API Documentation

API Product

Method
Description

[field_mana259a_model_verb]

Create API Product

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Search API Products

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Update API Product

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete API Product

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List API Products

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

Get API Product

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Updates API Product Attribute

[field_mana259a_model_path]

Updates the value of an API product attribute.

[field_mana259a_model_verb]

Get API Product Attribute

[field_mana259a_model_path]

Returns the value of an API product attribute.

[field_mana259a_model_verb]

Delete API Product Attribute

[field_mana259a_model_path]

Deletes an API product attribute.

[field_mana259a_model_verb]

Updates all API Product Attributes

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Gets all API Product Attributes

[field_mana259a_model_path]

Returns a list of all API product attributes.

API Proxy

Method
Description

[field_mana259a_model_verb]

Get API Proxy Deployment Details

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get API Proxy Revision Deployments

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List API Proxies

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Export API Proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get deployments for an organization

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Update API Proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Undeploy API Proxy

[field_mana259a_model_path]

Undeploys an API proxy revision from an environment.

[field_mana259a_model_verb]

Get API Proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete API Proxy Revision

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create an API Proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Import a new API Proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete API Proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Deploy API Proxy

[field_mana259a_model_path]

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

Analytics

Method
Description

[field_mana259a_model_verb]

Get List of Subscribed and Unsubscribed Users

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

Retrieve and Filter Metrics for a Dimension

[field_mana259a_model_path]

Retrieve and filter metrics for a dimension. Apigee Edge records and aggregates metrics for dimensions,...

Apps

Method
Description

[field_mana259a_model_verb]

List App IDs in an App Family

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List App IDs in an Organization

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List App IDs in an Organization by Key Status

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get App in an Organization by App ID

[field_mana259a_model_path]

Returns the app profile for the specified app ID.

[field_mana259a_model_verb]

List App IDs by App Type

[field_mana259a_model_path]

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

Audits

Method
Description

[field_mana259a_model_verb]

List Audit Entries for an API Proxy

[field_mana259a_model_path]

Lists audit records for management operations for an API proxy in an organization. For every call made to...

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

List Audit Entries for all Users

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List Audit Entries for an Organization

[field_mana259a_model_path]

Lists audit records for management operations for an organization. For every call made to the management...

[field_mana259a_model_verb]

List Audit Entries for a User

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

List Audit Entries for an API Product

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List Audit Entries for a Developer App

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List Audit Entries for all Developer Apps

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List Audit Entries for a Developer

[field_mana259a_model_path]

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

Caches

Method
Description

[field_mana259a_model_verb]

Get information about a cache

[field_mana259a_model_path]

Gets information about a cache.

[field_mana259a_model_verb]

List caches in an environment

[field_mana259a_model_path]

List caches in an environment.

[field_mana259a_model_verb]

Clear all cache entries

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Clear a cache entry

[field_mana259a_model_path]

Clears a cache entry, which is identified by the full CacheKey prefix and value. To learn how to clear a...

[field_mana259a_model_verb]

Create a cache in an environment

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Update a cache in an environment

[field_mana259a_model_path]

Updates a cache in an environment. All properties in the request body are optional.

[field_mana259a_model_verb]

Delete a cache

[field_mana259a_model_path]

Deletes a cache.

Company

Method
Description

[field_mana259a_model_verb]

List Companies

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create Company

[field_mana259a_model_path]

Creates a company in an organization.

[field_mana259a_model_verb]

Get Company Details

[field_mana259a_model_path]

List details for a company.

[field_mana259a_model_verb]

Delete Company

[field_mana259a_model_path]

Deletes an existing company.

[field_mana259a_model_verb]

Update Company

[field_mana259a_model_path]

Updates an existing company.   Note that to change the status of the Company you use [node:17711].

[field_mana259a_model_verb]

Set the Status of a Company

[field_mana259a_model_path]

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

Company App

Method
Description

[field_mana259a_model_verb]

Delete Company App

[field_mana259a_model_path]

Deletes a company app.

[field_mana259a_model_verb]

Get Count of API Resources for Company App

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List Company Apps

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create Company App

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Update Company App

[field_mana259a_model_path]

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

Company App Family

Method
Description

[field_mana259a_model_verb]

Update Company App Family

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete Company App Family

[field_mana259a_model_path]

Deletes a company app family.

[field_mana259a_model_verb]

Create Company App Family

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Remove Company App from Family

[field_mana259a_model_path]

Removes an app from a company app family.

[field_mana259a_model_verb]

List Company App Families

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Company App Family

[field_mana259a_model_path]

Gets a list of apps in an company app family.

Company App Keys

Method
Description

[field_mana259a_model_verb]

Update Company App Key with API Product

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

Delete Key for a Company App

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Key Information for a Company App

[field_mana259a_model_path]

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

Custom Aggregates

Method
Description

[field_mana259a_model_verb]

Get custom aggregate

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get custom aggregates

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create custom aggregate

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Activate or deactivate custom aggregate

[field_mana259a_model_path]

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

Data Mask

Method
Description

[field_mana259a_model_verb]

Create Data Masks for an Organization

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Data Mask Details for an Organization

[field_mana259a_model_path]

Get the details for a data mask for an organization.

[field_mana259a_model_verb]

Create Data Masks for an API Proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List Data Masks for an API Proxy

[field_mana259a_model_path]

List all data masks for an API proxy.

[field_mana259a_model_verb]

List Data Masks for an Organization

[field_mana259a_model_path]

List all data masks for an organization.

[field_mana259a_model_verb]

Get Data Mask Details for an API Proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete Data Masks for an API Proxy

[field_mana259a_model_path]

Delete a data mask for an API proxy.

[field_mana259a_model_verb]

Delete Data Masks for an Organization

[field_mana259a_model_path]

Delete a data mask for an organization.

Debug Session

Method
Description

[field_mana259a_model_verb]

Create a debug session

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete debug session

[field_mana259a_model_path]

Deletes a debug session.

[field_mana259a_model_verb]

List debug sessions

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get debug session transaction IDs

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get debug session transaction data

[field_mana259a_model_path]

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

Developer

Method
Description

[field_mana259a_model_verb]

Create Developer

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Developer

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Set Developer Status

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete Developer

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Update Developer

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List Developers

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Developer by App

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Gets all Developer Attributes

[field_mana259a_model_path]

Returns a list of all developer attributes.

[field_mana259a_model_verb]

Delete Developer Attribute

[field_mana259a_model_path]

Deletes a developer attribute.

[field_mana259a_model_verb]

Get Developer Attribute

[field_mana259a_model_path]

Returns the value of a developer attribute.

[field_mana259a_model_verb]

Updates a Developer Attribute

[field_mana259a_model_path]

Updates the value of a developer attribute.

[field_mana259a_model_verb]

Updates all Developer Attributes

[field_mana259a_model_path]

Updates or creates developer attributes.

Developer App

Method
Description

[field_mana259a_model_verb]

Get Developer App Details

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create Developer App

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List Developer Apps

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Approve or Revoke Developer App

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete Developer App

[field_mana259a_model_path]

Deletes a developer's app.

[field_mana259a_model_verb]

Update Developer App

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Count of API Resources for Developer App

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

Get App Attribute

[field_mana259a_model_path]

Returns the value of an app attribute.

[field_mana259a_model_verb]

Updates all App Attributes

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Gets all App Attributes

[field_mana259a_model_path]

Returns a list of all app attributes.

[field_mana259a_model_verb]

Delete App Attribute

[field_mana259a_model_path]

Deletes an app attribute.

[field_mana259a_model_verb]

Updates an App Attribute

[field_mana259a_model_path]

Updates an app attribute.

[field_mana259a_model_verb]

Update the Scope of an App

[field_mana259a_model_path]

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

Developer App Access Token

Method
Description

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

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

Developer App Family

Method
Description

[field_mana259a_model_verb]

Update Developer App Family

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Developer App Family

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete Developer App Family

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create Developer App Family

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Remove Developer App from Family

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List Developer App Families

[field_mana259a_model_path]

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

Developer App Key Access Token

Method
Description

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

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

Developer App Keys

Method
Description

[field_mana259a_model_verb]

Get Key Details for a Developer App

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Remove API Product for a Specific Key

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

Delete Key for a Developer App

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Add API Product to Key

[field_mana259a_model_path]

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

Developer within Company

Method
Description

[field_mana259a_model_verb]

Add or Update Company Developers

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List Developers in Company

[field_mana259a_model_path]

Lists all developers associated with a company.

[field_mana259a_model_verb]

Remove Developer from Company

[field_mana259a_model_path]

Removes the association of a developer with a company.

Environment

Method
Description

[field_mana259a_model_verb]

Get Environment Names

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Environment Details

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Gets deployment details for a specific API proxy revision in a specific environment.

[field_mana259a_model_verb]

Gets deployment details for an API proxy in a specific environment and organization.

[field_mana259a_model_verb]

Get API Proxy Deployments for an Environment

[field_mana259a_model_path]

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

KeyValueMaps

Method
Description

[field_mana259a_model_verb]

Delete KeyValueMap

[field_mana259a_model_path]

Deletes a KeyValueMap and all associated entries.

[field_mana259a_model_verb]

List KeyValueMaps

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get KeyValueMap

[field_mana259a_model_path]

Gets a KeyValueMap by name, along with associated entries.

[field_mana259a_model_verb]

Get Entry

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete Entry

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Update KeyValueMap

[field_mana259a_model_path]

Updates an existing KeyValueMap. Does not override the existing map. Instead, this method updates the entries...

[field_mana259a_model_verb]

Create KeyValueMap

[field_mana259a_model_path]

Creates a KeyValueMap. A key/value map is a simple structure for persistently storing name/value pairs as...

[field_mana259a_model_verb]

Get KeyValueMap Entry in an API proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create KeyValueMap in an API proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get KeyValueMap in an API proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete KeyValueMap from an API proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List KeyValueMaps for an API proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Update KeyValueMap in an API proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete KeyValueMap Entry in an API proxy

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete KeyValueMap from an Environment

[field_mana259a_model_path]

Deletes a KeyValueMap and all associated entries from an environment.

[field_mana259a_model_verb]

Get KeyValueMap Entry in an Environment

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Update KeyValueMap in an Environment

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get KeyValueMap in an Environment

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create KeyValueMap in an Environment

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List KeyValueMaps in an Environment

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete KeyValueMap Entry in an Environment

[field_mana259a_model_path]

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

OAuth 1.0a Access Token

Method
Description

[field_mana259a_model_verb]

Update OAuth 1.0a Access Token

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Count Of OAuth 1.0a Access Token

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Approve or Revoke OAuth 1.0a Access Token

[field_mana259a_model_path]

Approves or revokes the specified access token.

[field_mana259a_model_verb]

Delete OAuth 1.0a Access Token

[field_mana259a_model_path]

Deletes the specified access token.

[field_mana259a_model_verb]

Get OAuth 1.0a Access Token

[field_mana259a_model_path]

Gets the details for the specified access token.

OAuth 1.0a Request Token

Method
Description

[field_mana259a_model_verb]

List OAuth 1.0a Request Tokens

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get OAuth 1.0a Request Token

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete OAuth 1.0a Request Token

[field_mana259a_model_path]

Deletes the specified OAuth 1.0a request token.

[field_mana259a_model_verb]

Update OAuth 1.0a Request Token

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Approve or Revoke OAuth 1.0a Request Token

[field_mana259a_model_path]

Approves or revokes an OAuth 1.0 a request token.

OAuth 1.0a Verifier Code

Method
Description

[field_mana259a_model_verb]

Delete OAuth 1.0a Verifier Code

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List OAuth 1.0a Verifier Code

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get OAuth 1.0a Verifier Code

[field_mana259a_model_path]

Gets the detail of an OAuth 1.0a verifier code.

OAuth 2.0 Access Token

Method
Description

[field_mana259a_model_verb]

Delete OAuth 2.0 Access Token

[field_mana259a_model_path]

Deletes a specific OAuth 2.0 access token.

[field_mana259a_model_verb]

Approve or Revoke OAuth 2.0 Access Token

[field_mana259a_model_path]

Approves or revokes an OAuth 2.0 access token.

[field_mana259a_model_verb]

Get OAuth 2.0 Access Token

[field_mana259a_model_path]

Gets details of a specific OAuth 2.0 access token.

[field_mana259a_model_verb]

Update OAuth 2.0 Access Token

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Count of OAuth 2.0 Access Token

[field_mana259a_model_path]

Get count of OAuth 2.0 access tokens for an organization.

[field_mana259a_model_verb]

Revokes an OAuth 2.0 access token by end user ID, app ID, or both. Only users with the orgadmin...

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

List OAuth 2.0 Authorization Codes

[field_mana259a_model_path]

Lists all OAuth 2.0 authorization codes in an organization.

[field_mana259a_model_verb]

Delete OAuth 2.0 Authorization Code

[field_mana259a_model_path]

Deletes the OAuth 2.0 authorization code.

[field_mana259a_model_verb]

Get OAuth 2.0 Authorization Code

[field_mana259a_model_path]

Get details about a specific OAuth 2.0 authorization code.

OAuth 2.0 Refresh Token

Method
Description

[field_mana259a_model_verb]

Approve or revoke an OAuth 2.0 refresh token

[field_mana259a_model_path]

Approve or revoke an OAuth 2.0 refresh token.

Organization

Method
Description

[field_mana259a_model_verb]

Get Organization

[field_mana259a_model_path]

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

Permissions for Resource at Organization Level

Method
Description

[field_mana259a_model_verb]

Get Permission for a Single Resource

[field_mana259a_model_path]

Gets a list of permissions associated with the specified resource.

[field_mana259a_model_verb]

Gets permissions for all resources associated with a user role.

[field_mana259a_model_verb]

Delete Permission for Resource

[field_mana259a_model_path]

Removes a permission from a resource for the role specified.

[field_mana259a_model_verb]

Add Permissions for Resource to a Role

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Adds multiple permissions to multiple resources simultaneously.

[field_mana259a_model_verb]

Verify User Role Permission for Resource

[field_mana259a_model_path]

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

Reports

Method
Description

[field_mana259a_model_verb]

Update a Report

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete a Report

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Lists Reports

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create an Analytics report

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get a Report

[field_mana259a_model_path]

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

Resource File

Method
Description

[field_mana259a_model_verb]

Import a resource file for an environment

[field_mana259a_model_path]

Import and create a resource file for an environment.

[field_mana259a_model_verb]

Import a resource file for an API

[field_mana259a_model_path]

Import and create a resource file for an API.

[field_mana259a_model_verb]

Deletes a resource file from an organization

[field_mana259a_model_path]

Deletes a resource file from an organization.

[field_mana259a_model_verb]

List resource files in an organization

[field_mana259a_model_path]

Lists the resource files in an organization.

[field_mana259a_model_verb]

Get a resource file for an organization

[field_mana259a_model_path]

Gets the body of a resource from an organization.

[field_mana259a_model_verb]

Get a resource file from an environment

[field_mana259a_model_path]

Gets the body of a resource from an environment.

[field_mana259a_model_verb]

Get a resource file from an API

[field_mana259a_model_path]

Gets the body of a resource from an API.

[field_mana259a_model_verb]

Import a resource file for an organization

[field_mana259a_model_path]

Import and create a resource file for an organization.

[field_mana259a_model_verb]

Deletes a resource file from an API

[field_mana259a_model_path]

Deletes a resource file from an API.

[field_mana259a_model_verb]

Deletes a resource file from an environment

[field_mana259a_model_path]

Deletes a resource file from an environment.

[field_mana259a_model_verb]

List resource files in an environment

[field_mana259a_model_path]

Lists the resource files in an environment.

[field_mana259a_model_verb]

List resource files in an API

[field_mana259a_model_path]

Lists the resource files in an API.

Roles at Organization Level

Method
Description

[field_mana259a_model_verb]

Verify user role membership

[field_mana259a_model_path]

Verify user role membership.

[field_mana259a_model_verb]

Get Role

[field_mana259a_model_path]

Gets a user role.

[field_mana259a_model_verb]

List Roles of Organization

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Add a user to a role

[field_mana259a_model_path]

Add a user to a role.

[field_mana259a_model_verb]

Get users for a role

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete Role

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Add Roles to Organization

[field_mana259a_model_path]

Creates one ore more user roles in an organization.

[field_mana259a_model_verb]

Remove user membership in role

[field_mana259a_model_path]

Remove user membership in role.

Target Server

Method
Description

[field_mana259a_model_verb]

Delete a TargetServer

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create a TargetServer

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Update a TargetServer

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

List TargetServers in an environment

[field_mana259a_model_path]

List all TargetServers in an environment.

[field_mana259a_model_verb]

Get TargetServer

[field_mana259a_model_path]

Returns a TargetServer definition.

Virtual Host

Method
Description

[field_mana259a_model_verb]

List Virtual Hosts

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Virtual Host

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Update a Virtual Host

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete a Virtual Host

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create a Virtual Host

[field_mana259a_model_path]

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

Node.js Management

Method
Description

[field_mana259a_model_verb]

Gets npm dependencies for an API Proxy.

[field_mana259a_model_path]

Gets npm dependencies for an API Proxy.

[field_mana259a_model_verb]

Manage Node Packaged Modules

[field_mana259a_model_path]

Runs specified npm commands for a specified API proxy deployed on Apigee Edge. This API is the equivalent of...

Vaults

Method
Description

[field_mana259a_model_verb]

Create a Vault in an Org

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create a Vault Entry in an Org

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

Replace a Vault Entry Value in an Org

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Vault Names in an Org

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get List of Entries in a Vault in an Org

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get a Vault Entry in an Org

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete a Vault Entry in an Org

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete a Vault in an Org

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create a Vault in an Environment

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Create a Vault Entry in an Environment

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

Get Vault Names in an Environment

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

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

[field_mana259a_model_verb]

Get a Vault Entry in an Environment

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete a Vault Entry in an Environment

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Delete a Vault in an Environment

[field_mana259a_model_path]

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

Cached Logs

Method
Description

[field_mana259a_model_verb]

Get Cached Log Categories

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Get Cached Node.js Logs

[field_mana259a_model_path]

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

Keystores and Truststores

Method
Description

[field_mana259a_model_verb]

Upload a JAR file to a Keystore

[field_mana259a_model_path]

Uploads a JAR file to a keystore in an environment.

[field_mana259a_model_verb]

Get a Keystore or Truststore

[field_mana259a_model_path]

Returns a specific keystore or truststore in the environment.

[field_mana259a_model_verb]

Get a Cert from a Keystore or Truststore

[field_mana259a_model_path]

Returns a specific cert from a keystore or truststore.

[field_mana259a_model_verb]

List Keystores and Truststores

[field_mana259a_model_path]

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

[field_mana259a_model_verb]

Upload a Certificate to a Truststore

[field_mana259a_model_path]

Uploads a certificate to a truststore in an environment.

[field_mana259a_model_verb]

Delete a Keystore or Truststore

[field_mana259a_model_path]

Deletes a keystore or truststore in an environment.

[field_mana259a_model_verb]

Create a Keystore or Truststore

[field_mana259a_model_path]

Create a keystore or truststore in an environment.

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click Send Docs Feedback on this page.
    (Incorrect? Unclear? Broken link? Typo?)