v1

latestOpenAPI 3.0.0Apache 2.02026-07-17143274803.9 KB

ark

Enable ARK service

post/api/v1/orgs/{orgId}/clusters/{id}/backupservice/enable

Path parameters

orgIdinteger required

Organization identifier

idinteger required

Cluster identifier

Request body

cloudstring required

bucketNamestring required

schedulestring required

ttlstring required

secretIdstring required

locationstring

useClusterSecretboolean

relevant only in case of Amazon clusters. By default set to false in which case you must add snapshot permissions to your node instance role. Should you set to true Pipeline will deploy your cluster secret to the cluster.

serviceAccountRoleARNstring

relevant only in case of Amazon clusters. This a third option to give permissions for volume snapshots to Velero, besides the default NodeInstance role or cluster secret deployment.

useProviderSecretboolean

relevant only in case of Amazon clusters. This a fourth option to give permissions for volume snapshots to Velero. Should you set to true Pipeline will configure your provider secret (specified in secretId) for volume snapshot.

storageAccountstring

required only case of Azure

resourceGroupstring

required only case of Azure

Example request

{
  "cloud": "google",
  "bucketName": "ark-backup-bucket-123",
  "schedule": "0 */6 * * *",
  "ttl": "1h",
  "secretId": "62bc3c75-91fb-4670-bad4-24b401a9deac",
  "location": "us-east",
  "serviceAccountRoleARN": "arn:aws:iam::AWS_ACCOUNT_ID:role/IAM_ROLE_NAME",
  "storageAccount": "my-storage-account",
  "resourceGroup": "my-resource-group",
  "labels": {
    "backup-type": "full"
  },
  "options": {
    "includedNamespaces": [
      "*"
    ],
    "includedResources": [
      "*"
    ],
    "excludedNamespaces": [],
    "excludedResources": [],
    "snapshotVolumes": true,
    "includeClusterResources": true
  }
}

Response

ARK service deployed successfully

statusinteger

Example response

{
  "status": 200
}