Register (Backup Store)—ArcGIS REST APIs

URL:https://<root>/system/disasterrecovery/stores/register
Required Capability:Default administrator role | Security and infrastructure
Version Introduced:10.9

Description

The register operation registers a backup store. The backup store is created and managed by the deployment.

Request parameters


Parameter	Details
storeName (Required)	The backup store name.
settings (Required)	The JSON describing the storage configuration for the backup store. The configuration can use either label selectors (be statically provisioned) or be dynamically provisioned. For more information, see the storageConfig properties section below.
isDefault (Required)	Determines whether the store will be the default backup store (true). The default value is false. Values: true \| false
async	Introduced at 11.0. This parameter specifies whether the operation will run synchronously or asynchronously. If false, the operation is run synchronously. If true, the operation is run asynchronously and the response returns a JSON object containing job information that can be used to track the job's status. 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 table outlines the properties for using the label selectors or for having storageConfig be dynamically or statically provisioned.


Property	Details
provisioningType	The provisioning type. Values: STATIC \| DYNAMIC
storageClass	The storage class.
size	The size for the persistent volume. The minimum size requirement is 16 GB.
labels	A key:value pair to identify and bind to a persistent volume.

STATIC JSON examples

The following example demonstrates the storageConfig syntax when using a STATIC provisioning type:

{
  "provisioningType": "STATIC",
  "storageClass": "backups",
  "size": "64Gi",
  "labels": {
    "arcgis/purpose": "backups"
  }
}

The following example demonstrates the full JSON for STATIC provisioning using label selectors:

{
  "type": "HOSTED",
  "storageConfig": {
    "provisioningType": "STATIC",
    "storageClass": "backups",
    "size": "64Gi",
    "labels": {
      "arcgis/purpose": "backups"
    }
  }
}

DYNAMIC JSON examples

The following example demonstrates the storageConfig syntax when using a DYNAMIC provisioning type:

{
  "size": "64Gi",
  "provisioningType": "DYNAMIC",
  "storageClass": "backups"
}

The following example demonstrates the full JSON for DYNAMIC provisioning:

{
  "type": "HOSTED",
  "storageConfig": {
    "size": "64Gi",
    "provisioningType": "DYNAMIC",
    "storageClass": "backups"
  }
}

Example usage

The following is a sample POST request for the register operation that demonstrates registering a dynamically provisioned backup store:

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&settings={"type": "HOSTED","storageConfig": {"size": "64Gi","provisioningType": "DYNAMIC","storageClass": "backups"}}&isDefault=true&async=false&f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-

JSON Response example

The following response is returned, if async is false, when a backup store has been registered successfully:

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

If async is true, the response returns a JSON object containing job information. The value returned for the jobsUrl property can be used to access the job resource, which can be polled to return updated job status information. For more information, see the Job resource topic.

{
  "jobsUrl": "https://organization.domain.com/context/admin/jobs/j7c8820d0-ea2f-427a-ab6f-a8cc2c927fe4",
  "jobid": "j7c8820d0-ea2f-427a-ab6f-a8cc2c927fe4",
  "status": "SUBMITTED"
}

ArcGIS REST APIs