Send Docs Feedback

Making management API calls from this page

  1. In the URL, replace any values indicated by "{ }", 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!

POST

Updates or creates app attributes.

This API replaces the current list of attributes with the attributes specified in the request body. This lets you update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body.

Updates or creates developer attributes. br> This API replaces the current list of attributes with the attributes specified in the request body. This lets you update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body.

Runs a specified npm command for an API proxy deployed on Apigee Edge. When you call this API, it is equivalent to executing an npm command in the resources/node directory of the API proxy.

Valid npm commands that you can execute with this API are:

  • install
  • update 
  • outdated 
  • dedupe 
  • prune 
  • ls (default if no query param is specified)

Usage: Specify the body of this API like this: "command={npm-command}". For example: command=install. The command is designed to install known dependencies for the API's package directory (resources/node).

Do not try to specify an arbitrary published Node.js package name with this API. For example, something like this will fail: command=install async.

With the exception of ls and outdated, all of these commands replace node_modules.zip and any other ZIP file in resources/node with the prefix node_modules with a new set of files that contains the updated dependencies.

For details about these individual npm commands, see https://docs.npmjs.com/cli/.

Example 1:

command=ls

Returns a list of Node.js dependencies. 

Example 2:

command=install

Installs all dependencies for the resources/node directory.

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

Set the status of an app's consumer key to 'approved' or 'revoked'.

You can approve a consumer key that is currently revoked or pending. Once approved, the app can use the consumer key to access APIs. You can also use this call to reapprove a revoked key.

Revoking a consumer key renders it unusable for the app to use to access an API.

Note: Any access tokens associated with a revoked app key will remain active, but Apigee Edge checks the status of the app key first. If the status is set to "revoked," Apigee Edge will not allow the call go through.

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

You can approve a consumer key that is currently revoked or pending for the API product. You can also reapprove a revoked key.

To consume API resources defined in an API product, an app's consumer key must be approved and it must also be approved for that specific API product.

Pages

Help or comments?