apigeecli

README

apigeecli

This is a tool to interact with Apigee APIs. The tool lets you manage (get, list) environments, proxies, etc. The tools also helps you create Service Accounts in Google IAM to operate Apigee hybrid runtime.

Installation

apigeecli is a binary and you can download the appropriate one for your platform from here

NOTE: Supported platforms are:

• Darwin
• Windows
• Linux

What you need to know about apigeecli

You must have an account on Apigee Hybrid to perform any apigeecli functions. These functions include: proxies, API Products, Environments, Org details etc.

You need to be familiar with basic concepts and features of Apigee Edge such as API proxies, organizations, and environments.

For more information, refer to the Apigee Hybrid API Reference.

Service Account

Create a service account with appropriate persmissions. Refer to this link for more details on how to download the JSON file.

Access Token

apigeecli can use the service account directly and obtain an access token.

apigeecli token gen -a serviceaccount.json 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --account -a (required) Service Account in json format

Use this access token for all subsequent calls (token expires in 1 hour)

Command Reference

The following options are available for security

Pass the access token

apigeecli <flags> -t $TOKEN

Pass the service account

apigeecli <flags> -a orgadmin.json

Access Token Caching

apigeecli caches the OAuth Access token for subsequent calls (until the token expires). The access token is stored in $HOME/.access_token. This path must be readable/writeable by the apigeecli process.

apigeecli token cache -a serviceaccount.json

Subsequent commands do not need the token flag

---

Supported entites

• apis
• apps
• cache
• developers
• envs
• flowhooks
• iam
• keystores
• keyaliases
• kvms
• org
• projects
• products
• resources
• sharedflows
• sync
• targetservers
• token

---

apis

• create
• delete
• deploy
• fetch
• import
• get
• export
• list
• listdeploy
• trace
• undeploy

create

Import or create an API Proxy. If a bundle (zip) is supplied, it is imported else, it creates an empty proxy in the Org

apigeecli apis create -o org -n proxy

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) API proxy name
• --proxy -p (required) API proxy bundle (zip)

delete

Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it.

apigeecli apis delete -o org -n proxy

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) API proxy name

deploy

Deploys a revision of an existing API proxy to an environment in an organization.

apigeecli apis deploy -o org -e env -n proxy -v 1

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) API proxy name
• --revision -v (required) API proxy revision
• --ovr -r (optional) Forces deployment of the new revision.

fetch

Returns a zip-formatted proxy bundle of code and config files.

apigeecli apis fetch -o org -e env -n proxy -v 1

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) API proxy name
• --rev -v (required) API proxy revision
• --ovr -r (optional) Forces deployment of the new revision.

get

Get API Proxy information

apigeecli apis get -o org -n proxy

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) API proxy name

import

Upload a folder containing API proxy bundles

apigeecli apis import -o org -f /tmp

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --folder -f (required) path containing API proxy bundles

export

Export latest revisions of API proxy bundles from an org

apigeecli apis export -o org

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name

list

List APIs in an Apigee Org

apigeecli apis list -o org

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (optional) Apigee environment name
• --incl -i (optional) Include proxy revisions

If the environment name is passed, lists the deployed proxies in the environment If the revision flag is enabled, lists all the revisions for the proxy

listdeploy

Lists all deployments of an API proxy

apigeecli org listdeploy -o org -n name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (optional) Apigee environment name
• --name -n (required) API proxy name
• --rev -r (optional) API Proxy revision

trace

Manage debug sessions/trace for API Proxy revisions

• create
• get
• list

create

Create a new trace/debug session

apigeecli apis trace create -o org -e env -n name -v 1 -f "name1=value1,name2=value2"

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) API proxy name
• --rev -v (required) API proxy revision
• --filter -f (optional) Trace filter; format is: name1=value1,name2=value2

get

Get details for trace/debug session

apigeecli apis trace create -o org -e env -n name -v 1 -s uuid

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) API proxy name
• --rev -v (required) API proxy revision
• --ses -s (required) Trace session ID
• --msg -m (optional) Message ID

list

List all trace/debug session for a proxy revision in the last 24 hours

apigeecli apis trace create -o org -e env -n name -v 1

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) API proxy name
• --rev -v (required) API proxy revision

undeploy

Undeploys a revision of an existing API proxy to an environment in an organization.

apigeecli apis undeploy -o org -e env -n proxy -v 1

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) API proxy name
• --rev -v (required) API proxy revision

---

apps

Supported alias applications

• create
• delete
• genkey
• get
• list
• import
• export

create

Create a developer app

apigeecli apps create -o org -n name -e test,prod -p proxy1 --attrs "foo1=bar1,foo2=bar2"

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) Developer App name
• --email -e (required) Developer's email
• --expires -x (optional) Lifetime of the consumer's key
• --callabck -c (optional) OAuth callback url
• --prods -p (optional) A comma separated list of products
• --scopes -s (optional) OAuthe scopes
• --attrs (optional) Custom Attributes

delete

Delete a developer app

apigeecli apps delete -o org -n name 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) Developer App name

genkey

Create new developer KeyPairs Generates a new consumer key and consumer secret for the named developer app

apigeecli apps genkey -o org -n name -p proxy1

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) Developer App name
• --expires -x (optional) Lifetime of the consumer's key
• --callabck -c (optional) OAuth callback url
• --prods -p (required) A comma separated list of products
• --scopes -s (optional) OAuthe scopes

get

Get details of a developer app

apigeecli apps get -o org -n name 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --appId -i (optional) Developer App Id
• --name -n (optional) Developer App Name

NOTE: Either appId or Name must be passed

list

List all developer apps in an org

apigeecli apps list -o org 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --expand -x (optional) Returns an expanded list of apps for the organization.
• --count -c (optional) Number of app ids to return. Default is 10000
• --inclCred -i (optional) Include Credentials; Default is false

import

Import Developer app entities into an org

apigeecli apps import -o org -f filepath.json

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --file -f (required) A json file containing apps

A sample file format can be found here

export

Export Developer app entities from an org

apigeecli apps export -o org 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name

---

<name ="cache"/> cache

• delete
• list

delete

Delete a cache resource from an environment

apigeecli cache delete -o org -e env -n name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Cache name

list

List cache resources in an environment

apigeecli cache list -o org -e env

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name

---

developers

Supported alias developers

• create
• delete
• get
• getapps
• list
• import
• export

create

Create a new App Developer

apigeecli devs create -o org -n email -f firstname -s lastname -u username --attrs "foo1=bar1,foo2=bar2"

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --email -n (required) Developer email
• --first -f (required) Developer firstname
• --last -s (required) Developer lastname
• --user -u (required) Developer username
• --attrs (optional) Custom Attributes

delete

Delete an App Developer

apigeecli devs get -o org -n name 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) Developer email

get

Get details of an App Developer

apigeecli devs get -o org -n name 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) Developer email

list

List all App Developers in an org

apigeecli devs list -o org 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name

import

Import Developer entities into an org

apigeecli devs import -o org -f filepath.json

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --file -f (required) A json file containing developers

export

Import Developer entities into an org

apigeecli devs export -o org 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name

---

envs

Supported alias environments

• [debugmask] (#debugmask)
• get
• iam
• list

debugmask

• get
• set

get

Get debugmask settings for an environment

apigeecli envs debugmask get -o org -e env 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name

set

Set debugmask settings for an environment

apigeecli envs debugmask set -o org -e env -m "mask_settings_in_json"

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --mask -m (required) Mask settings in JSON format

iam

• get
• setax
• setdeploy
• setsync
• test

get

Get IAM settings for an environment

apigeecli envs iam get -o org -e env 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name

setax

Set Analytics Viewer permission for an SA on an Apigee environment

apigeecli envs iam setax -o org -e env -n service_account_name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Service Account Name

setdeploy

Set API Deployer permission for an SA on an Apigee environment

apigeecli envs iam setdeploy -o org -e env -n service_account_name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Service Account Name

setsync

Set Synchronization Manager permission for an SA on an Apigee environment

apigeecli envs iam setsync -o org -e env -n service_account_name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Service Account Name

get

Get details of an environment

apigeecli envs get -o org -e env 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) environment name
• --config -c (optional) If set, returns environment configuration

list

List all environments in an org

apigeecli envs list -o org 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name

---

flowhooks

• attach
• detach
• get
• list

attach

Attach a Flowhook

apigeecli flowhooks attach -o org -e env -n PreFlow -n proxy 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Name of the flowhook
• --desc -d (optional) Description the flowhook
• --sharedflow -s (required) Name of the shared flow
• --continue -c (optional) Continue on error

detach

Detach a Flowhook

apigeecli flowhooks detach -o org -e env -n PreFlow

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Name of the flowhook

get

Get a details of a configured Flowhook

apigeecli flowhooks get -o org -e env -n PreFlow

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Name of the flowhook

list

List of configured Flowhooks

apigeecli flowhooks list -o org -e env

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name

---

iam

• createall
• createax
• createcass
• createcass
• createmetric
• createsync

createall

Create a Google IAM Service Account with all the necessary roles to operate the hybrid runtime

apigeecli iam createall -p gcp-project-id -n service-account-name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --prj -p (required) GCP Project ID
• --name -n (required) Service Account Name

createax

Create a Google IAM Service Account for Apigee Analytics Agent

apigeecli iam createax -p gcp-project-id -n service-account-name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --prj -p (required) GCP Project ID
• --name -n (required) Service Account Name

createcass

Create a Google IAM Service Account for Apigee hybrid Cassandra backup

apigeecli iam createcass -p gcp-project-id -n service-account-name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --prj -p (required) GCP Project ID
• --name -n (required) Service Account Name

createlogger

Create a Google IAM Service Account for StackDriver logger

apigeecli iam createlogger -p gcp-project-id -n service-account-name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --prj -p (required) GCP Project ID
• --name -n (required) Service Account Name

createmart

Create a Google IAM Service Account for Apigee MART

apigeecli iam createmart -p gcp-project-id -n service-account-name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --prj -p (required) GCP Project ID
• --name -n (required) Service Account Name

createmetrics

Create a Google IAM Service Account for StackDriver Metrics

apigeecli iam createmetrics -p gcp-project-id -n service-account-name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --prj -p (required) GCP Project ID
• --name -n (required) Service Account Name

createsync

Create a Google IAM Service Account for Apigee Sync

apigeecli iam createsync -p gcp-project-id -n service-account-name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --prj -p (required) GCP Project ID
• --name -n (required) Service Account Name

---

keystores

• create
• delete
• get
• list

create

Create a new key store

apigeecli keystores create -o org -e env -n name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Key Store name

delete

Delete a key store

apigeecli keystores delete -o org -e env -n name 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Key store name

get

Get details of a key store

apigeecli keystores get -o org -e env -n name 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Key store name

list

List key stores in an environment

apigeecli keystores get -o org -e env

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name

---

keyaliases

• create
• create-self-signed
• csr
• delete
• get
• getcert
• list

create

Create a new key aliases from PEM or PKCS 12 file

apigeecli keyaliases create -o org -e env -n name -s alias -f format

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Key Store name
• --alias -s (required) Key Alias name
• --format -f (required) Format; pkcs12 or keycertfile
• --exp -x (optional) Ignore expiry error
• --nl -w (optional) Ignore new line between cert chains
• --passsword -p (optional) Password for pkcs12 file

delete

Delete a key aliases

apigeecli keyaliases delete -o org -e env -n name -s alias

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Key store name
• --alias -s (required) Key Alias name

get

Get details of a key aliases

apigeecli keyaliases get -o org -e env -n name -s alias

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Key store name
• --alias -s (required) Key Alias name

list

List key aliases in a key store

apigeecli keyaliases get -o org -e env -n name

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Key store name

---

kvms

• create
• delete
• list

create

Create a new KV Map

apigeecli kvms create -o org -e env -n kvm1 -c true 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) KVM Map name
• --encrypt -c (required) encrypted true or false

delete

Delete a new KV Map

apigeecli kvms delete -o org -e env -n kvm1 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) KVM Map name

list

List KVMs in an environment

apigeecli kvms list -o org -e env 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name

---

org

• create
• enable-apigee-connect
• enable-mart-whitelist
• list
• get
• setmart

create

Create a new Apigee Org

apigeecli orgs create -o org -p gcp-project-id -r ax-region 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --prj -p (required) GCP Project Id
• --reg -r (required) Apigee analytics region

enable-apigee-connect

Enable Apigee Connect for an Apigee Org

apigeecli orgs enable-apigee-connect -o org 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name

enable-mart-whitelist

Enable IP whitelisting for MART

apigeecli orgs enable-mart-whitelist -o org 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name

list

List all the orgs available to the identity (service account)

apigeecli orgs list

get

Get org details for an Apigee Org

apigeecli orgs get -o org 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name

setmart

Configure MART endpoint for an Apigee Org

apigeecli orgs get -o org -m http://endpoint

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --mart -m (required) MART endpoint
• --whitelist -w (optional) Enable/disable whitelisting of GCP IP for source connections to MART

---

projects

• testiam

testiam

Test IAM permissions for a project

apigeecli projects testiam -p gcp-project-id

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --prj -p (required) GCP Project ID

---

products

Supported alias prods

• create
• delete
• get
• list
• import

create

Create an API product

apigeecli prods create -o org -n name -e test,prod -p proxy1,proxy2 -f auto --attrs "foo1=bar1,foo2=bar2"

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) API product name
• --displayName -m (optional) Display name for API product
• --approval -f (required) Approval type for API product
• --desc -d (optional) Description for API product
• --envs -e (required) A comma separated list of environments to enable
• --proxies -p (required) A comma separated list of API proxies
• --scopes -s (optional) A comma separated list of OAuth scopes
• --quota -q (optional) Quota Amount
• --interval -i (optional) Quota Time Interval
• --unit -u (optional) Quota Time Unit
• --attrs (optional) Custom Attributes

delete

Delete an API Product

Get details of an API product

apigeecli prods delete -o org -n name 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) API product name

get

Get details of an API product

apigeecli prods list -o org -n name 

Required parameters The following parameters are required. See Common Reference for a list of additional parameters.

--org -o (required) Apigee organization name --name -n (required) API product name

import

Import API products from a configuration file

apigeecli prods list -o org -f file -c connections 

Required parameters The following parameters are required. See Common Reference for a list of additional parameters.

--org -o (required) Apigee organization name --file -f (required) File containing API products --conn -c (optional) Number of connections to establish; default is 4

A sample file format can be found here

export

Export API products to a file

apigeecli prods export -o org -c connections 

Required parameters The following parameters are required. See Common Reference for a list of additional parameters.

--org -o (required) Apigee organization name --conn -c (optional) Number of connections to establish; default is 4

---

resources

• [create] (#crtres)
• [delete] (#delres)
• [get] (#getres)
• [list] (#listres)

create

Create a resource to an environment

apigeecli resources create -o org -e env -n test.js -p jsc -r /tmp/test.js 

Required parameters The following parameters are required. See Common Reference for a list of additional parameters.

--org -o (required) Apigee organization name --env -e (required) Apigee environment name --name -n (required) Resource name --respath -r (required) Resource path --type -p (required) Resource type

delete

Delete a resource from an environment

apigeecli resources create -o org -e env -n test.js -p jsc

Required parameters The following parameters are required. See Common Reference for a list of additional parameters.

--org -o (required) Apigee organization name --env -e (required) Apigee environment name --name -n (required) Resource name --type -p (required) Resource type

get

Download a resource from an environment

apigeecli resources create -o org -e env -n test.js -p jsc

Required parameters The following parameters are required. See Common Reference for a list of additional parameters.

--org -o (required) Apigee organization name --env -e (required) Apigee environment name --name -n (required) Resource name --type -p (required) Resource type

<a name="listres> list

List resources in an environment

apigeecli prods list -o org -e env 

Required parameters The following parameters are required. See Common Reference for a list of additional parameters.

--org -o (required) Apigee organization name --env -e (required) Apigee environment name --type -p (optional) Filter by resource type

---

sharedflows

• create
• delete
• deploy
• export
• fetch
• import
• get
• list
• undeploy

create

Import or create a sharedflow. If a bundle (zip) is supplied, it is imported else, it creates an empty proxy in the Org

apigeecli apis create -o org -n proxy

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) sharedflow name
• --proxy -p (required) sharedflow bundle (zip)

delete

Deletes a sharedflow and all policies, resources, and revisions. The sharedflow must be undeployed before you can delete it.

apigeecli sharedflows delete -o org -n proxy

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) sharedflow name

deploy

Deploys a revision of an existing sharedflow to an environment in an organization.

apigeecli sharedflows deploy -o org -e env -n sharedflow1 -v 1

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) sharedflow name
• --rev -v (required) sharedflow revision
• --ovr -r (optional) Forces deployment of the new revision.

export

Export sharedflows as bundles from an organization.

apigeecli sharedflows export -o org

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name

fetch

Returns a zip-formatted proxy bundle of code and config files.

apigeecli apis fetch -o org -e env -n sharedflow -v 1

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) sharedflow name
• --rev -v (required) API proxy revision

get

Get a sharedflow's details

apigeecli apis get -o org -e env -n sharedflow

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) sharedflow name

import

Import sharedflows from dir to an organization.

apigeecli sharedflows import -o org -f /tmp

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --folder -f (required) Folder containing sharedflow bundles

list

List all sharedflows in an org

apigeecli apis get -o org -e env -n sharedflow

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (optional) Apigee environment name
• --rev -r (optional) Include shared flow revisions

undeploy

Undeploys a revision of an existing API proxy to an environment in an organization.

apigeecli apis undeploy -o org -e env -n proxy -v 1

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --name -n (required) sharedflow name
• --rev -v (required) sharedflow revision

---

sync

• set
• get

get

List all the orgs available to the identity (service account)

apigeecli sync get -o org

set

Set identity with access to control plane resources

apigeecli sync set -o org -i identity 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --ity -i (required) IAM Identity

---

targetservers

Supported alias ts

• create
• delete
• export
• import
• get
• list

create

Create a new target server

apigeecli targetservers create -o org -e env -h hostname -p 80 -n ts1

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Target server name
• --desc -d (optional) Description
• --host -s (required) Hostname
• --port -p (optional) Port number
• --enable -b (optional) Enable or disable

delete

Delete a target server

apigeecli targetservers delete -o org -e env -n name 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Target server name

export

Export a target servers from an environment

apigeecli targetservers export -o org -e env

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name

get

Get details of a target server

apigeecli targetservers get -o org -e env -n name 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name
• --name -n (required) Target server name

list

List target servers in an environment

apigeecli targetservers list -o org -e env 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --org -o (required) Apigee organization name
• --env -e (required) Apigee environment name

---

token

• gen
• cache

gen

Generate a new access token

apigeecli token gen -a serviceaccount.json 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --account -a (required) Service Account in json format

cache

Caches a new access token. Writes the access token to $HOME/.access_token for use by subsequent calls

apigeecli token cache -a serviceaccount.json 

Parameters The following parameters are supported. See Common Reference for a list of additional parameters.

• --account -a (required) Service Account in json format

---