Broadcom API Gateway - Delete Stored Password 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. Before deleting a stored password, you will need to get the ID of the stored password. Following is an example of how to list every Stored Password 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/passwords'
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/passwords'
Here is an example of the output that should be returned. In this example, the ID of the stored password named foo is da698409abc96df215cf2f80b2175a41.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<l7:List xmlns:l7="http://ns.l7tech.com/2010/04/gateway-management">
<l7:Name>SECURE_PASSWORD List</l7:Name>
<l7:Type>List</l7:Type>
<l7:TimeStamp>2020-09-15T06:58:08.958-05:00</l7:TimeStamp>
<l7:Link rel="self" uri="https://api.example.com:8443/restman/1.0/passwords?name=foo"/>
<l7:Link rel="template" uri="https://api.example.com:8443/restman/1.0/passwords/template"/>
<l7:Item>
<l7:Name>foo</l7:Name>
<l7:Id>da698409abc96df215cf2f80b2175a41</l7:Id>
<l7:Type>SECURE_PASSWORD</l7:Type>
<l7:TimeStamp>2020-09-15T06:58:08.958-05:00</l7:TimeStamp>
<l7:Link rel="self" uri="https://api.example.com:8443/restman/1.0/passwords/da698409abc96df215cf2f80b2175a41"/>
<l7:Resource>
<l7:StoredPassword id="da698409abc96df215cf2f80b2175a41" version="1">
<l7:Name>foo</l7:Name>
<l7:Properties>
<l7:Property key="description">
<l7:StringValue>my foo stored password</l7:StringValue>
</l7:Property>
<l7:Property key="lastUpdated">
<l7:DateValue>2019-07-25T14:39:50.934-05:00</l7:DateValue>
</l7:Property>
<l7:Property key="type">
<l7:StringValue>Password</l7:StringValue>
</l7:Property>
<l7:Property key="usageFromVariable">
<l7:BooleanValue>true</l7:BooleanValue>
</l7:Property>
</l7:Properties>
</l7:StoredPassword>
</l7:Resource>
</l7:Item>
</l7:List>
With the ID in hand, you can now delete the stored password, like this.
/path/to/GatewayMigrationUtility.sh restman
-argFile example.properties
-method DELETE
-path '1.0/passwords/da698409abc96df215cf2f80b2175a41'
If the delete is successful, the following should be returned.
Status: 204 No Content
Did you find this article helpful?
If so, consider buying me a coffee over at