volos-util-apigee

v0.1.2

Published

2 months ago

Apigee Edge Utils

Downloads

176

0High
0Medium
0Low

keyurkarnik

Apigee Edge CLI

apigeeutils

This is a tool for administering Apigee Edge things, including

deploying and undeploying API proxies or sharedflows
listing, creating, updating, or deleting products, caches, KVMs, developers, and apps
and other stuff

This is not an official Google product

This tool and the library included here is not an official Google product. Support is available on a best-effort basis via github or the community site. Pull requests are welcomed.

This tool does not support Apigee X or hybrid

This tool works with Apigee Edge. It does not work with Apigee X or hybrid. For a similar tool that works with X or hybrid, see here.

Installation

apigeeutils is a Node.js module and you can install it using npm:

`npm install -g volos-util-apigee

NOTE: The -g option places the apigeeutils command in your PATH. On "*nix"-based machines, sudo may be required with the -g option. If you do not use -g, then you need to add the apigeeutils command to your PATH manually. Typically, the -g option places modules in: /usr/local/lib/node_modules/volos-util-apigee on *nix-based machines.

What you need to know about apigeeutils

You must have an account on Apigee Edge to perform any apigeeutils functions. These functions include:

deploying an API proxy or shared flow to Edge,
undeploying an API proxy or shared flow from Edge,
listing deployed API proxies or shared flows on Edge,
retrieving deployed proxies or shared flows from Edge,
deleting proxy or shared flow definitions from Edge, and
create or delete an API product in Edge
create or delete a Developer in Edge
create or delete a Developer Application in Edge
create or delete a Cache resource in Edge
create, retrieve or delete a KVM Map in Edge
create, retrieve or delete a KVM Entry in Edge
attach, detach, or get a FlowHook
create, get, delete, list Target Servers
create, get, delete, List Roles
get, set Role Permisions
assign, remove, verify Users for a Role
list all Users in a Role

Obviously, this tool is only useful if you are familiar with basic concepts and features of Apigee Edge such as API proxies, organizations, environments, products, and so on.

For more information, refer to the Apigee Edge docs.

Common Parameters

The following parameters are available on all of the commands supported by this tool:

--baseuri -L (optional) The base URI for you organization on Apigee Edge. The default is the base URI for Apigee cloud deployments is api.enterprise.apigee.com. For on-premise deployments, the base URL may be different.

--header -H (optional) Adds a header to the API call. Format is header:value. This option may be used multiple times if more than one header is needed.

--cafile -c (optional) The names of one of more PEM files that represent trusted certificate authorities. Multiple file names may be comma-separated. Use this to communicate with an installation of Apigee Edge that uses a custom certificate for API calls.

--keyfile -K (optional) The name of the PEM file that represents the private key in a mutual auth connection.

--certfile -C (optional) The name of the PEM file that represents the certificate in a mutual auth connection.

--debug -D (optional) Prints additional information about the deployment, including router and message processor IDs.

--help -h (optional) Displays help on this command.

--insecure -k (optional) Do not validate the TLS certificate of the HTTPS target for API calls. Use this to communicate with an installation of Apigee Edge that does not use a trusted TLS certificate.

--asynclimit -a (optional) Limit for the maximum number of operations performed concurrently. Currently this only affects file uploads in the deploynodeapp command. Defaults to 4.

--json -j (optional) Formats the command's response as a JSON object.

--organization -o (required) The name of the organization to deploy to. May be set as an environment variable APIGEE_ORGANIZATION.

--password -p (required) Your Apigee account password. May be set as an environment variable APIGEE_PASSWORD.

--username -u (required) Your Apigee account username. May be set as an environment variable APIGEE_USERNAME.

--token -t (optional) Your Apigee access token. Use this in lieu of -u / -p

--netrc -N (optional) Use this in lieu of -u / -p, to tell apigeeutils to retrieve credentials from your .netrc file.

--verbose -V (optional) Prints additional information as the deployment proceeds.

Command reference and examples

deploynodeapp

Deploys a Node.js app to Apigee Edge as an API proxy. With your Node.js app deployed to Edge, you can take advantage of Edge features like security, quotas, caching, analytics, trace tool, and more.

Examples

Deploys a Node.js app to Apigee Edge.

apigeeutils deploynodeapp -u [email protected] -o sdoe -e test -n 'Test Node App 2' -d . -m app.js -b /node2

Deploys a Node.js app to both the default (HTTP) and secure (HTTPS) virtual hosts.

apigeeutils deploynodeapp -u [email protected] -o sdoe -e test -n 'Test Node App 2' -d . -m app.js -b /node2 -v default,secure

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

For example, if you do not specify a password using "-p", apigeeutils will prompt for the password on the command line.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--environments -e (required) The name(s) of the environment(s) to deploy to (comma-delimited).

Optional parameters

--api -n (optional) The name of the API proxy. The name of the API proxy must be unique within an organization. The characters you are allowed to use in the name are restricted to the following: A-Z0-9._\-$ %. If not specified, will attempt to use name from package.json.

--base-path -b (optional) The base path of the API proxy. For example, for this API proxy, the base path is /example-proxy: http://myorg-test.apigee.net/example-proxy/resource1.

--directory -d (optional) The path to the root directory of the API proxy on your local system. Will attempt to use current directory is none is specified.

--import-only -i (optional) Imports the API proxy to Apigee Edge but does not deploy it.

--main -m (optional) The Node.js file you want to be the main file. If not specified, will attempt to use main from package.json.

--preserve-policies -P (optional) If specified, the highest revision of the existing proxy will be downloaded and the node code in your directory will be overlayed upon it to create a resulting proxy that contains both any existing policies and the node code in the directory. If there is no existing revision, this option will have no effect.

--resolve-modules -R (optional) If the API proxy includes Node.js modules (e.g., in a node_modules directory), this option updates them on Apigee Edge without uploading them from your system. Basically, it's like running "npm install" on Apigee Edge in the root directory of the API proxy bundle.

--production (optional) Indicates if Apigee Edge should use the --production flag during npm install. Defaults to true, example of disabling the flag would be --production false.

--upload-modules -U
(optional) If specified, uploads Node.js modules from your system to Apigee Edge rather than resolving the modules directly on Apigee Edge (the default behavior).

--virtualhosts -v (optional) A comma-separated list of virtual hosts that the deployed app will use. The two most common options are default and secure. The default option is always HTTP and secure is always HTTPS. By default, apigeeutils deploynodeapp uses default,secure.

--bundled-dependencies (optional) If specified, the source code will be uploaded with its bundledDependencies as defined in the package.json.

--wait-after-import -W
(optional) Number of seconds to delay before deploying node.js proxy.

deployhostedtarget

Deploys a Hosted Target to Apigee Edge as an API proxy. With your Hosted Target deployed to Edge, you can take advantage of Edge features like security, quotas, caching, analytics, trace tool, and more.

Examples

Deploys a Node.js app as a Hosted Target to Apigee Edge.

apigeeutils deployhostedtarget -u [email protected] -o sdoe -e test -n 'test-node-app-2' -b /node2

Deploys a Node.js app as a Hosted Target to both the default (HTTP) and secure (HTTPS) virtual hosts.

apigeeutils deployhostedtarget -u [email protected] -o sdoe -e test -n 'test-node-app-2' -b /node2 -v default,secure

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

For example, if you do not specify a password using "-p", apigeeutils will prompt for the password on the command line.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--api -n The name of the API proxy. The name of the API proxy must be unique within an organization. The characters you are allowed to use in the name are restricted to the following: a-z0-9._\-$ %.

--environments -e (required) The name(s) of the environment(s) to deploy to (comma-delimited).

Optional parameters

--base-path -b (optional) The base path of the API proxy. For example, for this API proxy, the base path is /example-proxy: http://myorg-test.apigee.net/example-proxy/resource1.

--directory -d (optional) The path to the root directory of the API proxy on your local system. Will attempt to use current directory is none is specified.

--import-only -i (optional) Imports the API proxy to Apigee Edge but does not deploy it.

--preserve-policies -P (optional) If specified, the highest revision of the existing proxy will be downloaded and the source code in your directory will be overlayed upon it to create a resulting proxy that contains both any existing policies and the source code in the directory. If there is no existing revision, this option will have no effect.

--bundled-dependencies (optional) If specified, the source code will be uploaded with its bundledDependencies as defined in the package.json.

deployproxy

Deploys an API proxy to Apigee Edge. If the proxy is currently deployed, it will be undeployed first, and the newly deployed proxy's revision number is incremented.

Example

Deploys an API proxy called example-proxy to Apigee Edge. Per the -d flag, the command is executed in the root directory of the proxy bundle.

apigeeutils deployproxy  -u [email protected] -o sdoe  -e test -n example-proxy -d .

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--api -n (required) The name of the API proxy. Note: The name of the API proxy must be unique within an organization. The characters you are allowed to use in the name are restricted to the following: A-Z0-9._\-$ %.

--environments -e (required) The name(s) of the environment(s) to deploy to (comma delimited).

Optional parameters

--base-path -b (optional) The base path of the API proxy. For example, for this API proxy, the base path is /example-proxy: http://myorg-test.apigee.net/example-proxy/resource1.

--directory -d (optional) The path to the root directory of the API proxy on your local system. Will attempt to use current directory is none is specified.

--import-only -i (optional) Imports the API proxy to Apigee Edge but does not deploy it.

--resolve-modules -R (optional) If the API proxy includes Node.js modules (e.g., in a node_modules directory), this option updates them on Apigee Edge without uploading them from your system. Basically, it's like running npm on Apigee Edge in the root directory of the API proxy bundle.

--upload-modules -U (optional) If specified, uploads Node.js modules from your system to Apigee Edge.

--bundled-dependencies (optional) If specified, the node & hosted resources will be uploaded with their bundledDependencies as defined in their respective package.json files.

--wait-after-import -W
(optional) Number of seconds to delay before deploying node.js proxy.

deployExistingRevision

Deploys an existing API proxy revision to Apigee Edge. If a different revision is already deployed to the targeted environments, it will be undeployed and replaced with the requested revision.

Example

Deploys an existing API proxy revision called example-proxy to Apigee Edge.

apigeeutils deployExistingRevision  -u [email protected] -o sdoe  -e test -n example-proxy -r 1

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--api -n
(required) The name of the API proxy. Note: The name of the API proxy must be unique within an organization. The characters you are allowed to use in the name are restricted to the following: A-Z0-9._\-$ %.

--environments -e
(required) The name(s) of the environment(s) to deploy to (comma delimited).

--revision -r (required) The existing revision of the proxy to be deployed.

undeploy

Undeploys a named API proxy or Node.js app deployed on Apigee Edge.

Example

Undeploy the proxy named "example-proxy".

apigeeutils undeploy -u [email protected] -o sdoe  -n example-proxy -e test -D

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--api -n (required) The name of the API proxy or app to undeploy.

--environment -e (required) The environment on Apigee Edge where the API proxy or app is currently deployed.

Optional parameters

--revision -r (optional) Specify the revision number of the API proxy to undeploy.

listdeployments

Lists the API proxies deployed on Apigee Edge for the specified organization. Lets you filter the result by API proxy name or environment.

Examples

List all API proxies in an organization:

$ apigeeutils listdeployments -u [email protected] -o sdoe -e test`

List API proxies named "example-proxy":

$ apigeeutils listdeployments -u [email protected] -o sdoe -n example-proxy

Required parameters

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

Required, mutually exclusive parameters

--api -n (You must specify either api or environment in this command) The name of the API proxy to list.

--environment -e (You must specify either api or environment in this command) The environment for which you want to list deployments. When -e is specified, the command lists all deployed proxies in the environment.

Optional parameters

--long -l (optional) Returns additional information about the API proxy or Node.js app, including the URL to use as the base path for each one.

--revision -r (optional) Filters the list by the specified revision number.

fetchproxy

Fetches a deployed API proxy or Node.js application from Apigee Edge. The result will be a ZIP file that contains the contents of the entire proxy.

Regardless of whether "deployproxy" or "deploynodeapp" is used to deploy the proxy or app, the result of "fetchproxy" will always be a ZIP file that represents an API proxy. The resulting proxy may be "unzipped" and re-deployed using "deployproxy."

Example

Fetch the deployed proxy named "example-proxy".

apigeeutils fetchproxy -u [email protected] -o sdoe -n example-proxy -r 1

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--api -n (required) The name of the API proxy or app to undeploy.

--revision -r (required) Specifies the revision to retrieve.

Optional parameters

--file -f (optional) The name of the file to write as the result. If not specified, then the file name will be the same as the name passed to the "name" parameter.

delete

Delete all revisions of a proxy from Apigee Edge.

It is an error to delete a proxy that still has deployed revisions. Revisions must be undeployed using "undeploy" before this command may be used.

Example

Delete the proxy named "example-proxy".

apigeeutils delete -u [email protected] -o sdoe -n example-proxy

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--api -n (required) The name of the API proxy or app to undeploy.

getlogs

Retrieve the last set of log records from a Node.js application or Hosted Target deployed to Apigee Edge.

The resulting log files will be written directly to standard output. Each is prefixed with:

A timestamp, in UTC by default
An indication of whether the log record came from standard output or standard error
A unique identifier of the server where the log was generated.

Since Apigee Edge, by default, deploys each Node.js application on at least two different servers, most applications will see at least two sets of logs. These are sorted in time stamp order.

The log records from this command come from a cache inside Apigee Edge that retains the last 500 lines of log output from each server. The cache is a circular buffer, so older messages will be discarded when it fills up.

By default, the last set of log records will be pulled and written to standard output. However, if the "-f" option is used, then "apigeeutils" will poll Edge for new log records and append them to standard output, in the manner of "tail -f". (By default, the tool polls every five seconds).

For example, a set of log records might look like this:

Required Parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--api -n (required) The name of the deployed app to get logs from.

--environment -e (required) The environment on Apigee Edge where the app is currently deployed.

Optional Parameters

--streaming -f (optional) If specified, do not exit, but instead poll Apigee Edge for new log records and write them to standard output in the manner of "tail -f."

--timezone -z (optional) If specified, use the time zone to format the timestamps on the log records. If not specified, then the default is UTC. The timestamp name should be a name such as "PST."

--hosted-build (optional) If specified will attempt to get the build logs for a deployed Hosted Target.

--hosted-runtime (optional) If specified will attempt to get the runtime logs for a deployed Hosted Target.

deploySharedflow

Deploys a sharedFlow to Apigee Edge. If the sharedFlow is currently deployed, it will be undeployed first, and the newly deployed sharedflow's revision number is incremented.

Example

Deploys a SharedFlow called example-sf to Apigee Edge. Per the -d flag, the command is executed in the root directory of the sharedflow bundle.

apigeeutils deploySharedflow  -u [email protected] -o sdoe  -e test -n example-sf -d .

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--name -n (required) The name of the SharedFlow. Note: The name of the SharedFlow must be unique within an organization. The characters you are allowed to use in the name are restricted to the following: A-Z0-9._\-$ %.

--environments -e (required) The name(s) of the environment(s) to deploy to (comma delimited).

Optional parameters

--directory -d (optional) The path to the root directory of the sharedflow on your local system. Will attempt to use current directory is none is specified.

--import-only -i (optional) Imports the sharedflow to Apigee Edge but does not deploy it.

undeploySharedflow

Undeploys a SharedFlow deployed on Apigee Edge.

Example

Undeploy the proxy named "example-sf".

apigeeutils undeploySharedflow -u [email protected] -o sdoe  -n example-sf -e test -D

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--name -n (required) The name of the sharedflow to undeploy.

--environment -e (required) The environment on Apigee Edge where the sharedflow is currently deployed.

Optional parameters

--revision -r (optional) Specify the revision number of the sharedflow to undeploy.

listSharedflows

List shared flows

Example

apigeeutils listSharedflows -t $TOKEN -o $ORG

listSharedflowDeployments

Lists the sharedflows deployed on Apigee Edge for the specified organization. Lets you filter the result by API proxy name or environment.

Examples

List all Sharedflows in an organization:

$ apigeeutils listSharedflowDeployments -u [email protected] -o sdoe -e test

List Sharedflows named "example-sf":

$ apigeeutils listSharedflowDeployments -u [email protected] -o sdoe -n example-sf

Required parameters

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

Required, mutually exclusive parameters

--name -n (You must specify either name or environment in this command) The name of the Sharedflow to list.

--environment -e (You must specify either name or environment in this command) The environment for which you want to list deployments. When -e is specified, the command lists all deployed proxies in the environment.

Optional parameters

--revision -r (optional) Filters the list by the specified revision number.

fetchSharedFlow

Fetches a sharedFlow from Apigee Edge. The result will be a ZIP file that contains the contents of the entire sharedflow.The resulting ZIP file may be "unzipped" and re-deployed using "deploySharedflow."

Example

Fetch the deployed proxy named "example-proxy".

apigeeutils fetchSharedflow -u [email protected] -o sdoe -n example-proxy -r 1

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--name -n (required) The name of the sharedflow or app to undeploy.

--revision -r (required) Specifies the revision to retrieve.

Optional parameters

--file -f (optional) The name of the file to write as the result. If not specified, then the file name will be the same as the name passed to the "name" parameter.

deleteSharedflow

Delete all revisions of a sharedflow from Apigee Edge.

It is an error to delete a proxy that still has deployed revisions. Revisions must be undeployed using "undeploySharedflow" before this command may be used.

Example

Delete the proxy named "example-sf".

apigeeutils deleteSharedflow -u [email protected] -o sdoe -n example-sf

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--name -n (required) The name of the API proxy or app to undeploy.

KVM Operations

The following commands support the varying scoped of the Apigee KVM.

When just the --organization option is present, the operation will correspond to the Organization-scoped KVM.

When the --organization and --environment options are present, the operation will correspond to the Environment-scoped KVM.

When the --organization and --api options are present, the operation will correspond to the API-scoped KVM.

createKVMmap

Creates a map in the Apigee KVM with the given name.

Example

Create KVM map named "test-map"

apigeeutils createKVMmap -u [email protected] -o sdoe -e test --mapName test-map

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--mapName (required) The name of the map to be created.

Optional parameters

--environment -e (optional) The environment to target for an Environment-scoped KVM operation.

--api -n (optional) The API to target for an API-scoped KVM operation.

--encrypted (optional) Create a encrypted KVM Map.

addEntryToKVM

Adds an entry of name:value to the named map in the Apigee KVM.

Example

Add entry to KVM with name "test1" and value "value1"

apigeeutils addEntryToKVM -u [email protected] -o sdoe -e test --mapName test-map --entryName test1 --entryValue value1

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--mapName (required) The name of the map the entry will belong to.

--entryName (required) The name of the entry to be created.

--entryValue (required) The value of the entry to be created.

Optional parameters

--environment -e (optional) The environment to target for an Environment-scoped KVM operation.

--api -n (optional) The API to target for an API-scoped KVM operation.

updateKVMEntry

Updates an entry of name:value to the named map in the Apigee KVM.

Example

Update entry to KVM with name "test1" and value "value1"

apigeeutils updateKVMentry -u [email protected] -o sdoe -e test --mapName test-map --entryName test1 --entryValue value1

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--mapName (required) The name of the map the entry will belong to.

--entryName (required) The name of the entry to be created.

--entryValue (required) The value of the entry to be created.

--environment -e (optional) The environment to target for an Environment-scoped KVM operation.

getKVMmap

Retrieves an entire KVM map with all of its entries, by name.

Example

Get map named "test-map".

apigeeutils getKVMmap -u [email protected] -o sdoe -e test --mapName test-map

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--mapName (required) The name of the map to be retrieved.

Optional parameters

--environment -e (optional) The environment to target for an Environment-scoped KVM operation.

--api -n (optional) The API to target for an API-scoped KVM operation.

getKVMentry

Retrieve an unencrypted KVM entry from an Apigee KVM map, by name.

Example

Retrieve the KVM entry named "test1" in the map "test-map".

apigeeutils getKVMentry -u [email protected] -o sdoe -e test --mapName test-map --entryName test1

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--mapName (required) The name of the map that the entry belongs to.

--entryName (required) The name of the entry to be retrieved.

Optional parameters

--environment -e (optional) The environment to target for an Environment-scoped KVM operation.

--api -n (optional) The API to target for an API-scoped KVM operation.

deleteKVMmap

Deletes an entire map from the Apigee KVM along with all of its entries.

Example

Delete map named "test-map".

apigeeutils deleteKVMmap -u [email protected] -o sdoe -e test --mapName test-map

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--mapName (required) The name of the map to be deleted.

Optional parameters

--environment -e (optional) The environment to target for an Environment-scoped KVM operation.

--api -n (optional) The API to target for an API-scoped KVM operation.

deleteKVMentry

Deletes a single entry by name from an Apigee KVM map.

Example

Delete entry named "test1" from the map named "test-map".

apigeeutils deleteKVMmmap -u [email protected] -o sdoe -e test --mapName test-map --entryName test1

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

--mapName (required) The name of the map that the entry belongs to.

--entryName (required) The name of the entry to be deleted.

Optional parameters

--environment -e (optional) The environment to target for an Environment-scoped KVM operation.

--api -n (optional) The API to target for an API-scoped KVM operation.

Cache Operations

createcache

Creates a Cache with the given name.

Example

Create Cache map named "test-cache"

apigeeutils createcache -u [email protected] -o sdoe -e test -z test-cache

Create Cache map named "test-cache" (with description and expiry)

apigeeutils createcache -u [email protected] -o sdoe -e test -z test-cache --description "sample key" --cacheExpiryInSecs 40000

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password, and the "-o" parameter for organization name, all of which are required.

-z (required) The name of the cache to be created.

--environment -e (required) The environment to target.

--description (optional) The description of the cache to be created.

--cacheExpiryByDate (optional) Date by which the cache will expire. Date format must be mm-dd-yyyy.

--cacheExpiryInSecs (optional) Duration in seconds by which the cache will expire.

Target Server Operations

createTargetServer

Creates a Target Server with the given name.

Example

Create Target Server named "test-target" with SSL enabled.

apigeeutils createTargetServer -N -o $ORG -e $ENV --targetServerName test-target --targetHost httpbin.org --targetPort 443 --targetSSL true

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--environment -e (required) The environment to target.
--targetServerName (required) The name of the Target Server to be created.
--targetHost (required) The hostname of the target.
--targetPort (required) The port number of the target.
--targetSSL (optional) Whether or not SSL is configured, defaults to none.
--targetEnabled (optional) Whether or not the Target Server itself is enabled, defaults to true.

updateTargetServer

Update a Target Server with the given name.

Examples

Update Target Server named "test-target" with SSL enabled.

apigeeutils updateTargetServer -N -o $ORG -e $ENV --targetServerName test-target --targetHost httpbin.org --targetPort 443 --targetSSL true

Disable the Target Server named "test-target"

apigeeutils updateTargetServer -N -o $ORG -e $ENV --targetServerName test-target --targetEnabled false

Enable the Target Server named "test-target"

apigeeutils updateTargetServer -N -o $ORG -e $ENV --targetServerName test-target --targetEnabled true

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--environment -e (required) The environment to target.
--targetServerName (required) The name of the Target Server to be created.
--targetHost (optional) The hostname of the target.
--targetPort (optional) The port number of the target.
--targetSSL (optional) Whether or not SSL is configured, defaults to none.
--targetEnabled (optional) Whether or not the Target Server itself is enabled, defaults to true.

deleteTargetServer

Deletes a Target Server with the given name.

Example

Delete Target Server named "test-target".

apigeeutils deleteTargetServer -N -o $ORG -e $ENV --targetServerName test-target

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--environment -e (required) The environment to target.
--targetServerName (required) The name of the Target Server to be deleted.

getTargetServer

Get details for a Target Server with the given name.

Example

Get Target Server named "test-target".

apigeeutils getTargetServer -N -o $ORG -e $ENV --targetServerName test-target

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--environment -e (required) The environment to target.
--targetServerName (required) The name of the Target Server to be deleted.

listTargetServers

List Target Servers in a given environment.

Example

List Target Servers.

apigeeutils listTargetServers -N -o $ORG -e $ENV

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--environment -e (required) The environment to target.

FlowHook Operations

Operations on the pre-defined FlowHook names:

PreProxyFlowHook
PreTargetFlowHook
PostTargetFlowHook
PostProxyFlowHook

attachFlowHook

Attach a deployed SharedFlow to one of the [named FlowHooks](#FlowHook Operations).

Example

Attach SharedFlow "GetLogValues" to "PreProxyFlowHook".

apigeeutils attachFlowHook -N -o $ORG -e $ENV --flowHookName PreProxyFlowHook --sharedFlowName GetLogValues

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--environment -e (required) The environment to target.
--flowHookName (required) The pre-defined name of the FlowHook.
--sharedFlowName (required) The name of a deployed SharedFlow.

detachFlowHook

Detach a SharedFlow from one of the [named FlowHooks](#FlowHook Operations).

Example

Detach "PreProxyFlowHook".

apigeeutils detachFlowHook -N -o $ORG -e $ENV --flowHookName PreProxyFlowHook

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--environment -e (required) The environment to target.
--flowHookName (required) The pre-defined name of the FlowHook.

getFlowHook

Get the SharedFlow currently attached to one of the [named FlowHooks](#FlowHook Operations).

Example

Detach "PreProxyFlowHook".

apigeeutils getFlowHook -N -o $ORG -e $ENV --flowHookName PreProxyFlowHook

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--environment -e (required) The environment to target.
--flowHookName (required) The pre-defined name of the FlowHook.

Roles and Permissions Operations

Operations on Roles, Permissions and User assignment. The general flow is:

Create a role
Assign Permissions to the Role
Assign the Role to a User

createRole

Create a role.

Example

Create role "AllowGetUserRoles".

apigeeutils createRole -N -o $ORG --roleName AllowGetUserRoles

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--roleName (required) The name for the role.

getRole

Get a role.

Example

Get role "AllowGetUserRoles".

apigeeutils getRole -N -o $ORG --roleName AllowGetUserRoles

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--roleName (required) The name for the role.

deleteRole

Delete a role.

Example

Delete role "AllowGetUserRoles".

apigeeutils deleteRole -N -o $ORG --roleName AllowGetUserRoles

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--roleName (required) The name for the role.

listProxies

List proxies

Example

apigeeutils listProxies -t $TOKEN -o $ORG

listRoles

List roles.

Example

apigeeutils listRoles -N -o $ORG

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.

setRolePermissions

Set Role Permissions for a Role.

Example

Set Permissions on Role "AllowGetUserRoles" to allow access to list Roles.

apigeeutils setRolePermissions -N -o $ORG --roleName AllowGetUserRoles --permissions '[{"path":"/userroles","permissions":["get"]}]'

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--roleName (required) The name for the role.
--permissions Permissions array for path and verbs.

getRolePermissions

Get Role Permissions for a Role.

Example

Get Permissions on Role "AllowGetUserRoles".

apigeeutils getRolePermissions -N -o $ORG --roleName AllowGetUserRoles

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--roleName (required) The name for the role.

assignUserRole

Assign existing User to a Role. NOTE: User must already exist in Edge.

Example

Assign "[email protected]" to Role "AllowGetUserRoles".

apigeeutils assignUserRole -N -o $ORG --email "[email protected]" --roleName AllowGetUserRoles

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--email (required) Email for an existing User in Edge.
--roleName (required) The name for the role.

removeUserRole

Remove existing User from a Role.

Example

Remove "[email protected]" from Role "AllowGetUserRoles".

apigeeutils removeUserRole -N -o $ORG --email "[email protected]" --roleName AllowGetUserRoles

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--email (required) Email for an existing User in Edge.
--roleName (required) The name for the role.

verifyUserRole

Verify User assigned to a Role.

Example

Verify "[email protected]" assigned to Role "AllowGetUserRoles".

apigeeutils verifyUserRole -N -o $ORG --email "[email protected]" --roleName AllowGetUserRoles

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--email (required) Email for an existing User in Edge.
--roleName (required) The name for the role.

listRoleUsers

Get Users assigned to a Role.

Example

List Users assigned to Role "AllowGetUserRoles".

apigeeutils listRoleUsers -N -o $ORG --roleName AllowGetUserRoles

Required parameters

The following parameters are required. However, if any are left unspecified on the command line, and if apigeeutils is running in an interactive shell, then apigeeutils will prompt for them.

See Common Parameters for a list of additional parameters, including the "-u" and "-p" parameters for username and password or preferably -N for .netrc usage.

--organization -o (required) The organization to target.
--email (required) Email for an existing User in Edge.
--roleName (required) The name for the role.

SDK Reference

You could use apigeeutils as an SDK to orchestrate tasks that you want to perform with Edge, for eg, deploying an api proxy or running tests etc.

Usage Example

var apigeeutils = require('volos-util-apigee')
var sdk = apigeeutils.getPromiseSDK()
var opts = {
    organization: 'edge-org',
    username: 'edge-user',
    password: 'password',
    environments: 'environment',
}
opts.api = APIGEE_PROXY_NAME;
opts.directory = path.join(__dirname);

sdk.deployProxy(opts)
    .then(function(result){
        //deploy success
    },function(err){
        //deploy failed
    });

Create Developer

Creates a new Developer in Edge

Example

Create a developer.

    //see above for other required options
    opts.email = DEVELOPER_EMAIL
opts.firstName = 'Test'
opts.lastName = 'Test1'
opts.userName = 'runningFromTest123'
opts.attributes = [
    {
        name: "testAttribute",
        value: "newValue"
    }
]

sdk.createDeveloper(opts)
  .then(function(result){
    //developer created
  },function(err){
    //developer creation failed
  }) ;

Delete Developer

Delete a Developer in Edge

Example

    //see above for other required options
    opts.email = DEVELOPER_EMAIL

sdk.deleteDeveloper(opts)
  .then(function(result){
    //developer deleted
  },function(err){
    //developer delete failed
  }) ;

Create Product

Creates a new API Product in Edge

Example

opts.productName = APIGEE_PRODUCT_NAME
opts.productDesc = 'description'
opts.proxies = APIGEE_PROXY_NAME
opts.environments = 'test' //apigee env
opts.quota = '1', //quota amount
opts.quotaInterval = '1' //interval
opts.quotaTimeUnit = 'minute' //timeunit

sdk.createProduct(opts)
  .then(function(result){
    //product created
  },function(err){
    //product creation failed
  }) ;

Delete Product

Delete API Product in Edge

Example

opts.productName = APIGEE_PRODUCT_NAME

sdk.deleteProduct(opts)
  .then(function(result){
    //delete success
  },function(err){
    //delete failed
  }) ;

Create App

Create App in Edge

Example

  opts.name = APP_NAME
  opts.apiproducts = APIGEE_PRODUCT_NAME
  opts.email = DEVELOPER_EMAIL

  sdk.createApp(opts)
  .then(function(result){
    //create app done
  },function(err){
    //create app failed
  }) ;

Delete App

Delete App in Edge

Example

  opts.email = DEVELOPER_EMAIL
  opts.name = APP_NAME

  sdk.deleteApp(opts)
  .then(function(result){
    //delete app success
  },function(err){
    //delete app failed
  }) ;

Create App Key

Create App Key in Edge

Example

opts.key = APP_KEY;
opts.secret = APP_SECRET;
opts.developerId = DEVELOPER_EMAIL;
opts.appName = APP_NAME;
opts.apiProducts = PRODUCT_NAME;

sdk.createAppKey(opts)
.then(function(result){
  //create key/secret success
},function(err){
  //create key/secret failed
}) ;

Create Cache

Create Cache in Edge

Example

opts.cache = CACHE_RESOURCE_NAME;
sdk.createcache(opts)
.then(function(result){
    //cache create success
  },function(err){
    //cache create failed
  }) ;

Delete Cache

Delete Cache in Edge

Example

opts.cache = CACHE_RESOURCE_NAME;
sdk.deletecache(opts)
.then(function(result){
    //delete create success
  },function(err){
    //delete create failed
  }) ;

Some History

This module replaces the original "apigeetool" circa 2013, which was written in Python. It is also called "apigeeutils" and resides here.

Running Remote Tests

To run tests that actually tickle and Apigee Edge organization, provide your Edge creds, org, env details in remotetest/testconfig.js similar to 'remotetest/testconfig-sample.js'

Contributing

See Contributing

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

apigeeutils

This is not an official Google product

This tool does not support Apigee X or hybrid

Contents

Installation

What you need to know about apigeeutils

Common Parameters

Command reference and examples

deploynodeapp

Examples

Required parameters

Optional parameters

deployhostedtarget

Examples

Required parameters

Optional parameters

deployproxy

Example

Required parameters

Optional parameters

deployExistingRevision

Example

Required parameters

undeploy

Example

Required parameters

Optional parameters

listdeployments

Examples

Required parameters

Required, mutually exclusive parameters

Optional parameters

fetchproxy

Example

Required parameters

Optional parameters

delete

Example

Required parameters

getlogs

Required Parameters

Optional Parameters

deploySharedflow

Example

Required parameters

Optional parameters

undeploySharedflow

Example

Required parameters

Optional parameters

listSharedflows

Example

listSharedflowDeployments

Examples

Required parameters

Required, mutually exclusive parameters

Optional parameters

fetchSharedFlow

Example

Required parameters

Optional parameters

deleteSharedflow

Example

Required parameters

KVM Operations

createKVMmap

Example

Required parameters

Optional parameters

addEntryToKVM

Example

Required parameters

Optional parameters

updateKVMEntry