List the Vaults (External Targets) registered on the Cohesity Cluster filtered by the specified parameters.

get

https://cluster.ip.address/irisservices/api/v1/public/vaults

Privileges: CLUSTER_EXTERNAL_TARGET_VIEW

If no parameters are specified, all Vaults (External Targets) currently
registered on the Cohesity Cluster are returned.
Specifying parameters filters the results that are returned.
A Vault is equivalent to an External Target in the Cohesity Dashboard.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

int64

Specifies the id of Vault to return. If empty, all Vaults are returned.

name

string

Specifies the name of the Vault to return. If empty, all Vaults are
returned.

globalId

string

Specifies the global Identifier of the vault to be returned. If empty,
all Vaults are returned.

includeFortKnoxVault

boolean

Specifies if Vaults that are RPaaS vaults should be returned.

includeMarkedForRemoval

boolean

Specifies if Vaults that are marked for removal should be returned.

tenantIds

array of strings

Specifies a list of tenant ids. Only vaults assigned to these tenants
will be returned.

tenantIds

targetType

string

enum

Specifies the target type of the Vault to be queried.
default: KTargetTypePrimary
'kPrimary' indicates the Vault serves as primary target on the cluster.
'kSecondary' indicates the Vault serves as secondary target archiving data
to secondary region.
'kRecovery' indicates the Vault serves as recovery target used for restoring
purpose.
UnmarshalJSON implements the encoding.Unmarshaler interface. Converts
proto enum string to vault usage proto enum value.

Allowed:

usageType

array of strings

Specifies the usage types to filter vaults by.
Valid values: "archival", "cloudspill", "logbackup"
If nil, logbackup vaults are excluded by default.

usageType

includeOnlyVaultsOwnedByTenant

boolean

Specifies if only vaults owned by the tenant should be returned.
This is specific to IBM BaaS.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError