Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-17143274803.9 KB
ark-buckets

Create backup bucket

Create backup bucket

post/api/v1/orgs/{orgId}/backupbuckets

Path parameters

orgIdinteger required

Organization identifier

Request body

cloudstring required
bucketNamestring required
secretIdstring required
prefixstring

Optional, if not provided will be set to the name of the cluster

locationstring
storageAccountstring

required only in case of Azure

resourceGroupstring

required only case of Azure

Example request

{
  "cloud": "google",
  "bucketName": "ark-backup-bucket-123",
  "resourceGroup": "my-resource-group",
  "prefix": "my-backup-prefix",
  "secretId": "61b9707ca463cad79188bb0ddfa1345e41fc01b651feddf06eea58a25c56d717",
  "location": "us-east",
  "storageAccount": "my-storage-account"
}

Response

Backup bucket added successfully

idinteger
namestring
cloudstring
secretIdstring
statusstring
inUseboolean

Example response

{
  "cloud": "google",
  "name": "ark-backup-bucket-123",
  "inUse": false,
  "secretId": "61b9707ca463cad79188bb0ddfa1345e41fc01b651feddf06eea58a25c56d717",
  "id": 5,
  "status": "available"
}