Skip To Content
ArcGIS Developers
Dashboard

Register Backup Store

Description

This operation registers a backup store. At 10.9, the backup store is created and managed by the deployment.

Request parameters

ParameterDetails
storeName

The backup store name.

credentials

The credentials used to configure the store.

rootDirectory

The root directory for the store.

storageConfig

The JSON describing the storage configuration for the backup store. The configuration can use either label selectors or be dynamically provisioned. For more information, see the storageConfig properties section below.

isDefault

Determines whether the store will be the default backup store (true). The default value is false.

Values: true | false

f

The response format. The default format is html.

Values: html | json | pjson

storageConfig properties

The following sections outlines the properties for the using label selectors or for having storageConfig be dynamically provisioned.

Label selectors

The table below outlines the properties for label selectors:

ParameterDetails
size

The size for the persistent volume.

labels

A key:value pair to identify and bind to a persistent volume.

accessModes

The access mode, determining whether to read or read/write from one or multiple nodes.

The following example demonstrates using label selectors and a pre-created persistent volume:

{
  "size": "16Gi",
  "labels": {
    "key":"value"
  }
}

Dynamically provisioned

The table outlines the properties for having the storage configuration be dynamically provisioned.

ParameterDetails
storageClass

The storage class.

size

The size for the persistent volume.

accessModes

The access mode, determining whether to read or read/write from one or multiple nodes.

The following demonstrates using a storage class name to dynamically provision a persistent volume:

{
  "storageClass": "staging",
  "size": "16Gi",
  "accessModes": "ReadWriteOnce"
}​​​​​​​

Example usage

The following is a sample POST request for the register operation:

POST /context/admin/system/disasterrecovery/stores/register HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

storeName=backupDefault&credentials=&rootDirectory=&storageConfig={"storageClass": "staging","size": "16Gi","accessModes": "ReadWriteOnce"}​​​​​​​&isDefault=true&f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-

JSON Response example

{ 
  "default": true,
  "storageConfig": {"storageClassName": "backups"},
  "identity": "uh1rxq3x6x2zk1cxwtli",
  "name": "backups2",
  "identityKey": "zNUgyzzhuA6L6rSuD1RQUth/PWeg87/RVaGjDFpv2Ic=",
  "rootDir": "rootdir",
  "type": "HOSTED",
  "autoShutdown": true,
  "status": "success"
}