Fetch Vaults

GET {{base_url}}/api/vault_manager/v1/vaults?includeStats=true&count=true&order=desc(last_seen_at)

Request Params

KeyDatatypeRequiredDescription
hostnamenullFilter vaults by hostname. Supports matching any number of characters using asterisk wildcard character.
storageNodeIdnullID of Storage node to search vaults for.
managednullShow only managed or unmanaged vaults.

If not specified, all types of vaults are listed. | | name | null | | Filter vaults ny name. Supports matching any number of characters using asterisk wildcard character. | | resourceId | null | | Show only vaults which contain archives of specified resource ID. | | uri | null | | Filter vaults by URI. Supports matching any numbers using asterisk wildcard character. | | type | null | | Show only vaults of specified storage types. | | storageId | null | | Show only vaults in the storage with specified ID. | | accessibleForAgent | null | | Show only vaults that satisfy one of following conditions:

1 - The vault is local to the specified agent (its storage_type is local_folder, cd, tape, asz or removable_drive AND managing_agent_id=accessibleForAgent).

2 - The vault is not local to any agent (for storage_type that are not listed in first condition). | | tenantId | null | | Show only vaults in specific Tenant ID (do not include its subtenants). | | includeStats | boolean | | Calculate and include vault stats. | | includeLastBackupTime | null | | Calculate and include vault's last backup time. | | includeActions | null | | Calculate and include possible actions in the response. | | before | null | | Base64-encoded token obtained from the previous response. Points to the end of the page. | | after | null | | Base64-encoded token obtained from the previous response. Points to the start of the page. | | offset | null | | The number of elements to skip before beginning to return elements. | | limit | null | | Limit the number of elements to return in one page. | | count | boolean | | Show total count in the response. | | order | string | | An ordering filter that orders the results by column name.

Available operators:

asc - ascending desc - descending |

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"items":[{"access_address":"","actions":["changeAgent","refresh","rename"],"archive_count":null,"backed_up_data_size":null,"backups_count":null,"consistent":false,"free_space":null,"hostname":"","id":"8fc26d5b-68eb-39d9-1801-177115c45018","last_seen_at":"2023-01-11T21:40:07Z","logical_archive_size":null,"managed_storage_type":null,"managing_agent_id":null,"name":"oliver_carson_storage_admin","occupied_data_size":null,"organizational":false,"original_data_size":null,"settings":{"storage_uri":"avfs:/online?account%3doliver_carson_storage_admin%26provider%3dAcronis"},"status":{"status":"ok","status_error":"{}\n"},"storage_id":null,"storage_type":"online","storage_uri":"avfs:/online?account%3doliver_carson_storage_admin%26provider%3dAcronis","tenant_id":"3389560","tenant_locator":"/1/3389557/3389560/","tenant_name":"oliver_carson_test_acb_admin","total_space":null,"uri":"avfs:/online?account%3doliver_carson_storage_admin%26provider%3dAcronis","version":"LOCATION_VERSION_ABR12"},{"access_address":"","actions":["changeAgent","refresh","rename"],"archive_count":null,"backed_up_data_size":null,"backups_count":null,"consistent":true,"free_space":0,"hostname":"","id":"907f7498-997e-d2c0-8e37-0f7d5e578dd2","last_seen_at":"2023-01-13T01:26:52Z","logical_archive_size":null,"managed_storage_type":null,"managing_agent_id":"276deb3b-9317-44c7-9b2d-be332f9fe85c","name":"oliver_carson_test_acb_admin","occupied_data_size":null,"organizational":false,"original_data_size":null,"settings":{"storage_uri":"avfs:/online?account%3doliver_carson_test_acb_admin%26provider%3dAcronis"},"status":{"status":"ok","status_error":"{}\n"},"storage_id":null,"storage_type":"online","storage_uri":"avfs:/online?account%3doliver_carson_test_acb_admin%26provider%3dAcronis","tenant_id":"3389560","tenant_locator":"/1/3389557/3389560/","tenant_name":"oliver_carson_test_acb_admin","total_space":0,"uri":"avfs:/online?account%3doliver_carson_test_acb_admin%26provider%3dAcronis","version":"LOCATION_VERSION_ABR12"}],"paging":{"cursors":{}},"_links":[{"rel":"ListVaults","href":"/api/vault_manager/v1/vaults"},{"rel":"CreateVault","href":"/api/vault_manager/v1/vaults"},{"rel":"RefreshVaults","href":"/api/vault_manager/v1/vaults/refresh"}]}