Broadcom API Gateway - List Folders using the Gateway Migration Utility

by
Jeremy Canfield |
Updated: February 23 2022
| Broadcom API Gateway articles
This assumes you are familiar with the basic usage of the Gateway Migration Utility. Following is an example of how to list every folder in an API Gateway.
/path/to/GatewayMigrationUtility.sh restman
-host apig.example.com
-port 8443
-username john.doe
-password f5VPX0yUJPg.m4BrjdgMv84UgktddJD3xA
-method GET
-path '1.0/folders'
Or the -argFile option can be used, to reduce the number of options that are used on the command line.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/folders'
Or, a single folder can be returned by including the folder ID.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/folder/ed470defe8384b2fdfcb701c3623de7a'
Or, you can use the -query option to return a single folder by including the name of the folder.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/folders'
-query 'name=example'
The -response option can be used to output the XML to a file.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method GET
-path '1.0/folders/ed470defe8384b2fdfcb701c3623de7a'
-response /path/to/myFolder.xml
Something like this should be returned.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<l7:List xmlns:l7="http://ns.l7tech.com/2010/04/gateway-management">
<l7:Name>FOLDER List</l7:Name>
<l7:Type>List</l7:Type>
<l7:TimeStamp>2020-11-03T22:34:41.599-06:00</l7:TimeStamp>
<l7:Link rel="self" uri="https://apig.example.com:8443/restman/1.0/folders"/>
<l7:Link rel="template" uri="https://apig.example.com:8443/restman/1.0/folders/template"/>
<l7:Item>
<l7:Name>my Folder</l7:Name>
<l7:Id>fc3df4d7f82f3a659657c2a70287bec6</l7:Id>
<l7:Type>FOLDER</l7:Type>
<l7:TimeStamp>2020-11-03T22:34:41.599-06:00</l7:TimeStamp>
<l7:Link rel="self" uri="https://apig.example.com:8443/restman/1.0/folders/fc3df4d7f82f3a659657c2a70287bec6"/>
<l7:Resource>
<l7:Folder folderId="8bae51330510d965be8eb9217530ff08" id="fc3df4d7f82f3a659657c2a70287bec6" version="0">
<l7:Name>my Folder</l7:Name>
</l7:Folder>
</l7:Resource>
</l7:Item>
</l7:List>
Did you find this article helpful?
If so, consider buying me a coffee over at