Apigee X Resources Download

Use this tool to download configuration, information and entities from Apigee X Organization.

Note : The tool supports only bearer tokens when authenticating with your Apigee X Orgs.

Data Download

With the tool, you can download below information and entities:

• developers
• proxies (latest revision)
• shared flows
• products
• apps
• app keys
• KVMs (only env)
• Target Servers

What data cannot be Downloaded

Please note that the following entities won't be downloaded as part of this tool.

• Cache resources and cached values.
• Environment resources such as virtualhosts, and keystores.
• KVM entries for "encrypted" key-value maps. Encrypted values can't be retrieved using the management API. Get the values you're using in your old org, then add these values manually to the new org.

Prerequisites

1. Download and install Python at https://www.python.org/downloads.
2. Configure Below Environment Variable for Python.
3. C:\Users\Administrator\AppData\Local\Programs\Python\Python39\Scripts\
4. C:\Users\Administrator\AppData\Local\Programs\Python\Python39\
5. C:\Users\Administrator\AppData\Local\Programs\Python\Python39\Lib\site-packages

Before you get started

Before you start downloading data, be sure to do the following to ensure that your org is in a stable state when downloading.

• Freeze revisions on proxies in the Apigee X org you're downloading data from.
• Pause the process of adding new proxies or features.

Needed Configuration

There is no configuration for this tool except for the Python Configuration.

You will need Apigee X Org Name and a fresh Bearer Token Generated on GCP Console.

Property	Description
Apigee X Org Name	eg. favarity-wings-768733
Bearer Token	eg. ya29.A0ARrdaM9_Vyd3snc9yml_JwPYr6oohyFs23gKj7Po60Uwu3PL_T9oI9lJKODSXgPNuZpvFLbEI59uHJZQrN4EUQDtT8HE6KKwgcatsAU3W5MomV9_EEWoFemHhUUUbtKOAys_TW8bju-nwo8C7Yt1dqLj2rdqbuCq5LvkdwCo6HchtXvSWgAUOIISY1yg25PZLiJ2sGQSV_X_wZ1jmAURdA3zKAzbLihA5THpQfNKmzKJfpZ64d8fIbL4JnXWsZ8ONXtuPjmPpw

How to Use the tool

Method 1:

• By Cloning the Repository Code
• To use the tool, open a command prompt and change to the root directory of the repository you cloned.

Method 2:

• By Downloading the Repository as a zip file
• Extract the contents of the zip file.
• Open a command prompt and change to the root directory to the extracted folder.

Once we are at the root directory in the command prompt use below command to start downloading the resources

• python apigeex_tool.py

You will presented with several options to download information,resources and entities based on your use-case.

There are 8 Available Options:

1. Download All Resources
2. Download Only Proxies
3. Download Only SharedFlows
4. Download Only Products
5. Download Only Apps
6. Download Only KVM
7. Download Only Target Servers
8. Download Only Developers

Download Only Proxies

To download only Proxies from the Apigee X Org.

• Type Proxy ( Case Insensitive ) in the command prompt.

Below is the sample Screenshot.

Download Only Shared Flows

To download only Shared Flows from the Apigee X Org.

• Type SF ( Case Insensitive ) in the command prompt.

Below is the sample Screenshot.

Download Only Products

To download only Product from the Apigee X Org.

• Type Product ( Case Insensitive ) in the command prompt.

Below is the sample Screenshot.

Download Only Apps

To download only Apps from the Apigee X Org.

• Type APP ( Case Insensitive ) in the command prompt.

Below is the sample Screenshot.

Download Only KVMs

To download only KVMs from the Apigee X Org.

• Type KVM ( Case Insensitive ) in the command prompt.

Below is the sample Screenshot.

Download Only Target Servers

To download only Target Servers from the Apigee X Org.

• Type TS ( Case Insensitive ) in the command prompt.

Below is the sample Screenshot.

Download Only Developers

To download only Developers from the Apigee X Org.

• Type DEV ( Case Insensitive ) in the command prompt.

Below is the sample Screenshot.

Download All Resources

To download all Resources from the Apigee X Org.

• Type ALL ( Case Insensitive ) in the command prompt.

Below is the sample Screenshot.

The following folder structure with data will be created in your current directory.

Errors !!!

Only 2 errors might occur while using the tool.

1. Invalid Credentials

This error occurs if the user provided Apigee X Org Name or the Bearer Token is Invalid.

Below is the sample Screenshot.

2. Python is not recognized as an internal or external

This error occurs if either python is not installed or the system environment variable for python is not set.

Below is the sample Screenshot.