Tips on using generic-object API

PhoneBoy — Wed, 13 Sep 2023 17:42:33 GMT

While we have made a number of improvements with respect to API support for Quantum Security Management, there are still a number of object types that are currently not supported with the API.
In some cases, you may be able to manipulate these objects using the generic-object API calls.
These API endpoints are NOT DOCUMENTED as they are not officially supported (through TAC or other mechanisms).
You should always use supported API endpoints where possible.

Having said that, there are a few tips for working with these objects.
First of all, you'll need the UID of the object in question.
This can be obtained using the following command from your management server: mgmt_cli -r true show-generic-objects name "ObjectName" --format json

From here, you can use the generic-object API to list the details of said object.
For example: mgmt_cli -r true show-generic-object uid xxxx --format json

Some example threads where folks have successfully used the Generic API to either make changes or programmatically get certain information:

Happy for folks to share their own tips for using this API!

topic Tips on using generic-object API in API / CLI Discussion

Tips on using generic-object API