Getting StartedAPI ReferenceRecipesGitHub
API Reference

Create a new Vault (External Target).

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

Privileges: CLUSTER_EXTERNAL_TARGET_MODIFY

Returns the created Vault.
A Vault is equivalent to an External Target in the Cohesity Dashboard.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to create a new Vault.

Specifies an external storage location and is equivalent to
an External Target in the Cohesity Dashboard.
A Vault can provide an additional Cloud Tier where cold data of the
Cohesity Cluster can be stored in the Cloud.
A Vault can also provide archive storage for backup data. This archive data
is stored on Tapes and in Cloud Vaults.

string | null

Specifies the CA (certificate authority) trusted certificate.

string | null

Specifies the client CA certificate. This certificate is in pem format.

string | null

Specifies the client private key. This certificate is in pem format.

cloudArchivalDirectConfig
object | null

Specifies the vault config used for Cloud Archival Direct.

cloudDomainList
array of objects | null

Specifies the cloud domain information.

cloudDomainList
string | null
enum

Specifies whether to send data to the Vault in a
compressed format.
'kCompressionNone' indicates that data is not compressed.
'kCompressionLow' indicates that data is compressed using LZ4 or Snappy.
'kCompressionHigh' indicates that data is compressed in Gzip.

Allowed:
config
object | null

Specifies the settings required to connect to the Vault (External Target).

boolean | null

Specifies whether to manage the encryption key manually or let the
Cohesity Cluster manage it. If true, you must get the encryption key
store it outside the Cluster, before disaster strikes such as the
source local Cohesity Cluster being down.
You can get the encryption key by downloading it
using the Cohesity Dashboard or by calling the
GET /public/vaults/encryptionKey/{id} operation.

boolean | null

Specifies whether to deduplicate data before sending it to the Vault.

boolean | null

Specifies whether DEK(Data Encryption Key) rotation is enabled for this
vault. This is applicable only when the viewbox uses AWS or similar KMS
in which the KEK (Key Encryption Key) is not created and maintained by
Cohesity. For Internal KMS and keys stored in Safenet servers, DEK
rotation will not be performed.

string | null

Specifies the error message when deleting a vault.

string | null

Specifies a description about the Vault.

string | null
enum

Desired location for write ahead logs(wal).
'kHomePartition' indicates desired wal location to be the home partition.
'kDisk' indicates desired wal location to be the same disk as chunk repo.
'kScribe' indicates desired wal location to be scribe.
'kScribeTable' indicates chunk repository state is kept as key-value
pairs in scribe.

Allowed:
boolean | null

Specifies whether object lock is enabled or not on the vault.

boolean | null

Specifies if the encryption key file has been downloaded using the
Cohesity Dashboard (Cohesity UI).
If true, the encryption key has been downloaded using the Cohesity
Dashboard. An encryption key can only be downloaded once using the
Cohesity Dashboard.

string | null
enum

Specifies whether to send and store data in an encrypted format.
'kEncryptionNone' indicates the data is not encrypted.
'kEncryptionStrong' indicates the data is encrypted.

Allowed:
string | null
enum

Specifies the type of Vault.
'kNearline' indicates a Google Nearline Vault.
'kGlacier' indicates an AWS Glacier Vault.
'kS3' indicates an AWS S3 Vault.
'kAzureStandard' indicates a Microsoft Azure Standard Vault.
'kS3Compatible' indicates an S3 Compatible Vault.
(See the online help for supported types.)
'kQStarTape' indicates a QStar Tape Vault.
'kGoogleStandard' indicates a Google Standard Vault.
'kGoogleDRA' indicates a Google DRA Vault.
'kAmazonS3StandardIA' indicates an Amazon S3 Standard-IA Vault.
'kAWSGovCloud' indicates an AWS Gov Cloud Vault.
'kNAS' indicates a NAS Vault.
'kColdline' indicates a Google Coldline Vault.
'kAzureGovCloud' indicates a Microsoft Azure Gov Cloud Vault.
'kAzureArchive' indicates an Azure Archive Vault.
'kAzure' indicates an Azure Vault.
'kGoogle' indicates a Google Vault.
'kAmazon' indicates an Amazon Vault.
'kOracle' indicates an Oracle Vault.
'kOracleTierStandard' indicates an Oracle Tier Standard Vault.
'kOracleTierArchive' indicates an Oracle Tier Archive Vault.
'kAmazonC2S' indicates an Amazon Commercial Cloud Services Vault.

int64 | null

Specifies the number days between full archives to the Vault.
The current default is 90 days.
This is only meaningful when incrementalArchivesEnabled is true and
the Vault usage type is kArchival.

string | null

Specifies the global identifier of the Vault.

int64 | null

Specifies an id that identifies the Vault.

boolean | null

Specifies whether to perform incremental archival when sending data
to the Vault.
If false, only full backups are performed.
If true, incremental backups are performed between the full backups.

boolean | null

Specifies whether the vault is aws snowball or not.

boolean | null

Specifies whether forever incremental archival is enabled on this vault.

boolean | null

Specifies if given password is not encrypted or not in the cluster config.

int64 | null

Specifies the time (in microseconds) when the encryption key file was
downloaded from the Cohesity Dashboard (Cohesity UI).
An encryption key can only be downloaded once
using the Cohesity Dashboard.

string | null

Specifies the user who downloaded the encryption key from the
Cohesity Dashboard (Cohesity UI). This field
is only populated if encryption is enabled for the Vault and
customerManagingEncryptionKeys is true.

int64 | null

Specifies the associated KMS Server ID.

string | null

Specifies the name of the Vault.

string | null
enum

Specifies the state of the vault to be removed.
'kDontRemove' means the state of object is functional and
it is not being removed.
'kMarkedForRemoval' means the object is being removed.
'kOkToRemove' means the object has been removed on the Cohesity Cluster and
if the object is physical, it can be removed from the Cohesity Cluster.

Allowed:
string | null
enum

Specifies the target type of the Vault.
'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:
tenantIds
array of strings | null

Specifies the list of tenants which will have a access to current vault.

tenantIds
string | null
enum

Specifies the type of Vault.
This field is deprecated. This field is split into ExternalTargetType in
and TierType in respective credentials. Initialize those
fields instead.
deprecated: true
'kNearline' indicates a Google Nearline Vault.
'kGlacier' indicates an AWS Glacier Vault.
'kS3' indicates an AWS S3 Vault.
'kAzureStandard' indicates a Microsoft Azure Standard Vault.
'kS3Compatible' indicates an S3 Compatible Vault.
(See the online help for supported types.)
'kQStarTape' indicates a QStar Tape Vault.
'kGoogleStandard' indicates a Google Standard Vault.
'kGoogleDRA' indicates a Google DRA Vault.
'kAmazonS3StandardIA' indicates an Amazon S3 Standard-IA Vault.
'kAWSGovCloud' indicates an AWS Gov Cloud Vault.
'kNAS' indicates a NAS Vault.
'kColdline' indicates a Google Coldline Vault.
'kAzureGovCloud' indicates a Microsoft Azure Gov Cloud Vault.
'kAzureArchive' indicates an Azure Archive Vault.
'kAzure' indicates an Azure Vault.
'kGoogle' indicates a Google Vault.
'kAmazon' indicates an Amazon Vault.
'kOracle' indicates an Oracle Vault.
'kOracleTierStandard' indicates an Oracle Tier Standard Vault.
'kOracleTierArchive' indicates an Oracle Tier Archive Vault.
'kAmazonC2S' indicates an Amazon Commercial Cloud Services Vault.

string | null
enum

Specifies the usage type of the Vault.
'kArchival' indicates the Vault provides archive storage for backup data.
'kCloudSpill' indicates the Vault provides additional storage for cold data.
'kRpaasArchival' indicates the Vault is for RPaaS.
'kLogbackup' indicates the Vault is for logbackup.

Allowed:
boolean | null

Specifies whether the vault should use rolling object lock.

vaultBandwidthLimits
object | null

Specifies bandwidth limit.

string | null
enum

Specifies the ownership context for consumption.
'kOwnershipContextLocal' indicates the Vault is used for local consumption
'kOwnershipContextFortKnox' indicates the Vault is used for Fortknox
consumption
'kOwnershipContextNBU' indicates the Vault is used for NetBackup
consumption

Allowed:
vaultTagMap
array of objects | null

Specifies the vault tag map containing tags relevant to the external target.

vaultTagMap
string | null

Specifies the name of the associated viewbox that is to be created while
registering vault in NextGen CE.

boolean | null

Specifies the mode of object lock (governance/compliance)

Responses

Updated about 5 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago

Did this page help you?