Sign in
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"
}

Changes

Changed in 2 of the 50 revisions of this API.44

  • f8e0d7efa9de4See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

  • 5186ea64aa564See the full diff
    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog