ark-buckets

Create backup bucket

Changed on

Create backup bucket

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

Request

  • Base URL: http://localhost:9090
  • URL: http://localhost:9090/api/v1/orgs/{orgId}/backupbuckets
  • Auth: HTTP bearer

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

  • f8e0d7efa9deRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • 5186ea64aa56Revision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property