/api/2.0/fo/vault/?action=list
[POST]
List authentication vaults in your account.
Permissions - Managers, Unit Managers and Scanners can view vaults and their settings.
Parameter |
Description |
action=list |
(Required) |
echo_request={0|1} |
(Optional) Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
title={value} |
(Optional) Show vaults matching this title. |
type={value} |
(Optional) List a certain vault type only. A valid value is: BeyondTrust PBPS CA Access Control CyberArk AIM CyberArk PIM Suite Hitachi ID PAM Lieberman ERPM Quest Vault Thycotic Secret Server |
modified={date} |
(Optional) Include vaults modified on or after a certain date/time, in this format: YYYY-MM-DD[THH:MM:SSZ] (UTC/GMT). |
orderby={value} |
(Optional) Sort the vaults list by certain data. One of: “id”, “title”, “system_name”, “last_modified", “last_modified_by". A date must be specified in YYYYMM-DD[THH:MM:SSZ] format (UTC/GMT). |
sortorder={asc|desc} |
(Optional) The sort order, used when the request includes the orderby parameter. One of: asc (for ascending order) or desc (for descending order). |
limit={value} |
(Optional) The maximum number of vault records processed for the request, starting at the record number specified by the offset parameter. These parameters must be specified together: limit and offset. When not specified, default limit is set to 1,000 vault records. You can specify a value less than or greater than the default. It’s possible to specify “limit=0” for no limit. In this case the output is not paginated and all records are returned in a single output. Warning: This is not recommended since it may generate a very large output and processing large XML files can consume a lot of resources on the client side. |
offset={value} |
(Optional) The starting vault record number, used only when the request includes the limit parameter. |
API request
curl -u "USERNAME:PASSWD" -H "X-Requested-With: curl" -d "action=list" "https://qualysapi.qualys.com/api/2.0/fo/vault/"
XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_VAULT_LIST_OUTPUT SYSTEM
"https://qualysapi.qualys.com/api/2.0/fo/vault/vault_output.dtd">
<AUTH_VAULT_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2018-03-12T13:55:57Z</DATETIME>
<STATUS>Success</STATUS>
<COUNT>13</COUNT>
<AUTH_VAULTS>
<AUTH_VAULT>
<TITLE>
<![CDATA[added failover ip]]>
</TITLE>
<VAULT_TYPE>
<![CDATA[CyberArk PIM Suite]]>
</VAULT_TYPE>
<LAST_MODIFIED>
<DATETIME>2018-03-12:05:21Z</DATETIME>
<BY>quays_rn1</BY>
</LAST_MODIFIED>
<ID>1421</ID>
</AUTH_VAULT>
<AUTH_VAULT>
<TITLE>
<![CDATA[added failover ip1]]>
</TITLE>
<VAULT_TYPE>
<![CDATA[CyberArk PIM Suite]]>
</VAULT_TYPE>
<LAST_MODIFIED>
<DATETIME>2017-12-129T06:43:44Z</DATETIME>
<BY>quays_rn1</BY>
</LAST_MODIFIED>
<ID>1441</ID>
</AUTH_VAULT>
<AUTH_VAULT>
<TITLE>
<![CDATA[Blue]]>
</TITLE>
<VAULT_TYPE>
<![CDATA[CA Access Control]]>
</VAULT_TYPE>
<LAST_MODIFIED>
<DATETIME>2018-01-15T05:26:32Z</DATETIME>
<BY>quays_rn1</BY>
</LAST_MODIFIED>
<ID>1406</ID>
</AUTH_VAULT>
</AUTH_VAULTS>
</RESPONSE>
</AUTH_VAULT_LIST_OUTPUT>
API request
curl -H "X-Requested-With:API" -u "USERNAME:PASSWD" -d "action=list&orderby=system_name"
"https://qualysapi.qualys.com/api/2.0/fo/vault/index.php/?"
API request
curl -H "X-Requested-With:API" -u "USERNAME:PASSWD" -d "action=list&sortorder=desc&title"
"https://qualysapi.eng.qualys.com/api/2.0/fo/vault/index.php/?"
API request
curl -H "X-Requested-With:API" -u "USERNAME:PASSWD" -d "action=list&limit=2&offset=9"
"https://qualysapi.qualys.com/api/2.0/fo/vault/index.php/?"
<platform API server>/api/2.0/fo/vault/vault_output.dtd