Get all SSL key configuration (GET)
The GET command returns the configuration properties and mappings for all SSL keys. This command does not return material.
Request parameters
Parameter | Description | Example |
---|---|---|
{{code language="none"}} | User name that initiates the request. The specified user must have security-level access. | usr=secuity |
pwd 1 | Password of the security user that initiates the request. | pwd=ytiruces |
1 This parameter is required.
Request syntax
https://<ipAddress>/rest/configurationapi/sslkeysapi/1.0/keys/config?usr=<userName>&pwd=<password>
Sample successful response
<?xml version="1.0" encoding="utf-8"?>
<response>
<status result="success" />
<result>
<sslKeysConfiguration>
<key name="key1_pfx" server-ip="10.160.." server-port="*" />
<key name="key2_pfx_serverA" server-ip="172.10.1.1" server-port="8443" />
<key name="03_pfx_des3_password" server-ip="172.10.1.1" server-port="8443" />
<key name="08_pfx_plain_nopassword" server-ip="10.160.." server-port="*">
<description><![CDATA[Key managed manually]]></description>
</key>
<key name="19_pk12util_export_nopass" server-ip="172.10.1.1" server-port="8443">
<description><![CDATA[Key managed by Venafi]]></description>
</key>
</sslKeysConfiguration>
</result>
</response>
<response>
<status result="success" />
<result>
<sslKeysConfiguration>
<key name="key1_pfx" server-ip="10.160.." server-port="*" />
<key name="key2_pfx_serverA" server-ip="172.10.1.1" server-port="8443" />
<key name="03_pfx_des3_password" server-ip="172.10.1.1" server-port="8443" />
<key name="08_pfx_plain_nopassword" server-ip="10.160.." server-port="*">
<description><![CDATA[Key managed manually]]></description>
</key>
<key name="19_pk12util_export_nopass" server-ip="172.10.1.1" server-port="8443">
<description><![CDATA[Key managed by Venafi]]></description>
</key>
</sslKeysConfiguration>
</result>
</response>
Sample unsuccessful response
<?xml version="1.0" encoding="utf-8"?>
<response>
<status result="failure">
<msg code="1105" severity="ERROR"><![CDATA[Resource does not exist.]]></msg>
</status>
</response>
<response>
<status result="failure">
<msg code="1105" severity="ERROR"><![CDATA[Resource does not exist.]]></msg>
</status>
</response>
Related topics
Composing-requests-in-configuration-APIs
SSL-Key-Management-API-commands
SSL-Key-Management-API-error-messages
Configuration-API-error-code-reference
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*