async-tasks

GET /async-tasks
Returns information about the current running async tasks linked to the user

Query Parameters

Name Type Description
storeFilter string Filter async tasks by store ID
ageFilter integer Filter async tasks by age in days

Responses

200 An async task

Response Attributes

Name Type Description Object Structure
tasks array {'type': 'string', 'description': 'description of the task'}

400 Invalid filter

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

GET /async-tasks/{taskID}
Returns an object containing information about the current status of an asynchronous task

Query Parameters

Name Type Description
taskID string id of the task that should be retrieved

Responses

200 An async task

Response Attributes

Name Type Description Object Structure
taskId string ID of the task
storeId string ID of the store the task relates to
description string description of the task
status string the current status of the task
taskType string the type of this task this id is tracking
started string when the task started
ended string when the task started
restoreParams object N/A {'blockVolumeId': {'type': 'integer', 'format': 'int32', 'description': 'Block volume ID of a given restore job'}, 'snapshotId': {'type': 'string', 'description': 'ID of snapshot used for a given restore job'}, 'type': 'object'}

400 Invalid task ID

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 Task not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

secure-client

GET /stores/{storeID}/secure-client
Redirects to the URL of the secure client binary

Query Parameters

Name Type Description
storeID string The ID of the store

Responses

303 store secure client binary returned

400 Invalid Request

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 store not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

GET /stores/{storeID}/secure-client/config
Redirects to the URL of the secure client config file

Query Parameters

Name Type Description
storeID string The ID of the store

Responses

303 store secure client config returned

400 Invalid Request

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 store not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

status

GET /status
Health check for rest server

Responses

204 Server is up

store-certs

POST /stores/{storeID}/certs
This endpoint will create the certificate required to connect to the store. If a certificate already exists, this endpoint will revoke the old one and generate a new one.

Query Parameters

Name Type Description
storeID string The ID of the store

Responses

201 Return details of the created certificate. NOTE: certificate and key information is only returned from this endpoint. If the information is lost then it will have to be regenerated.

Response Attributes

Name Type Description Object Structure
caCert string The certificate authority certificate
cert string The secure tunnel certificate
key string The certificate key
serialNumber string The certificate serial number
commonName string The common name of the certificate

400 Invalid input

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 store not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

409 Operation cannot be performed on store in its current state

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

GET /stores/{storeID}/certs
Returns metadata about the certificate for a store. Whilst the information returned is a collection, only 1 certificate is currently supported for each store. NOTE: this endpoint does not return the certificate itself or its key.

Query Parameters

Name Type Description
storeID string The ID of the store

Responses

200 Return metadata of the currently valid certificate related to this store. NOTE: certifiacte and key information is only returned from this endpoint. If the information is lost then it will have to be regenerated.

Response Attributes

Name Type Description Object Structure
certificates array N/A

400 Invalid input

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 Store not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

DELETE /stores/{storeID}/certs/{serialNumber}
Revokes the certificate identified by the serial number than can be retrieved from the GET request.

Query Parameters

Name Type Description
storeID string The ID of the store
serialNumber string The serial number of the certificate

Responses

204 Certificate revoked successfully

400 Invalid input

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 Store or Certificate not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

409 Operation cannot be performed on store in its current state

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

stores

GET /stores
Returns a list of the user's stores

Query Parameters

Name Type Description
sort string Sort the results by name ascending or descending
nameFilter string Filter stores by name
statusFilter string Filter stores by status

Responses

200 Return collection of store with status and configuration info

Response Attributes

Name Type Description Object Structure
stores array {'type': 'string', 'description': 'Description of the purpose of the store'}

400 Invalid input

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

POST /stores
Creates a new store and deploys it

Responses

201 Store Creation task started successfully

Response Attributes

Name Type Description Object Structure
id string ID of the store deployment
name string Name of the store deployment
description string Description of the purpose of the store
region string The region the backup store exists in
status string The status of the store
clientUsername string Name of the client created to interact with the store
clientPassword string Password of the client created to interact with the store

400 Invalid input

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 Forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

409 Currently unable to deploy store, either due to a name conflict or resource constraints

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

GET /stores/{storeID}
Return a single store by name, with general info

Query Parameters

Name Type Description
storeID string The ID of the store

Responses

200 Get completed successfully.

Response Attributes

Name Type Description Object Structure
id string ID of the store deployment
name string Name of the store deployment
status string The status of the store
description string Description of the purpose of the store
createdDate string Date the store was created
protocolVersion integer Protocol version of the store
userBytes integer The logical data stored
diskBytes integer The physical data stored
numItems integer The number of items associated with the store
numDataJobs integer The number of datajobs associated with the store
numInboundCopyJobs integer The number of inbound copyjobs associated with the store
numOutboundCopyJobs integer The number of outbound copyjobs associated with the store
modifiedDate string The date the store was last modified
region string The region the backup store has been deployed to
storeReachable boolean If false, some store info may be temporarily unavailable, the store may still be active but certain fields may not be populated through this interface
clientUsernames array Name of the client details used to connect to this store
isRestorable boolean Indicates whether the store contains RMC volumes which can be restored to a block volume

400 Invalid Request

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 store not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

PATCH /stores/{storeID}
Updates details about a store

Query Parameters

Name Type Description
storeID string The ID of the store

Responses

200 store updated successfully

Response Attributes

Name Type Description Object Structure
id string ID of the store deployment
name string Name of the store deployment
status string The status of the store
description string Description of the purpose of the store
createdDate string Date the store was created
protocolVersion integer Protocol version of the store
userBytes integer The logical data stored
diskBytes integer The physical data stored
numItems integer The number of items associated with the store
numDataJobs integer The number of datajobs associated with the store
numInboundCopyJobs integer The number of inbound copyjobs associated with the store
numOutboundCopyJobs integer The number of outbound copyjobs associated with the store
modifiedDate string The date the store was last modified
region string The region the backup store has been deployed to
storeReachable boolean If false, some store info may be temporarily unavailable, the store may still be active but certain fields may not be populated through this interface
clientUsernames array Name of the client details used to connect to this store
isRestorable boolean Indicates whether the store contains RMC volumes which can be restored to a block volume

400 Invalid input

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 store not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

409 Operation cannot be performed on store in its current state

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

DELETE /stores/{storeID}

Query Parameters

Name Type Description
storeID string The ID of the store

Responses

202 Store marked for deletion

Response Attributes

Name Type Description Object Structure

400 Invalid input

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 store not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

409 Store not in deletable status

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

POST /stores/{storeID}/client-credentials

Query Parameters

Name Type Description
storeID string The ID of the store

Responses

201 Store client credentials updated, new values returned

Response Attributes

Name Type Description Object Structure
userName string username of the client for this store
newPassword string the new password for the client

400 Invalid input

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 Store not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

409 Operation cannot be performed on store in its current state

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

volume-restore

POST /stores/{storeID}/restore
Perform a restore of a snapshot of a volume held on a Store to a Clould Volume via RMC in the cloud

Query Parameters

Name Type Description
storeID string The ID of the store

Responses

202 Restore started successfully

Response Attributes

Name Type Description Object Structure
taskId string ID of the task
storeId string ID of the store the task relates to
description string description of the task
status string the current status of the task
taskType string the type of this task this id is tracking
started string when the task started
ended string when the task started
restoreParams object N/A {'blockVolumeId': {'type': 'integer', 'format': 'int32', 'description': 'Block volume ID of a given restore job'}, 'snapshotId': {'type': 'string', 'description': 'ID of snapshot used for a given restore job'}, 'type': 'object'}

400 Bad Request

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 Store / Catalyst store / Volume / Snapshot not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

409 Cloud Volume not in restorable status

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

GET /stores/{storeID}/volumes
Get collection of the available volumes to restore in a store

Query Parameters

Name Type Description
storeID string The ID of the store

Responses

200 Volumes returned successfully

Response Attributes

Name Type Description Object Structure
scanned string When the metadata cache was last updated
volumes array List of the block volumes available for restore on the store

400 Invalid input

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 store or store not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

PUT /stores/{storeID}/volumes
Rescan the store's metadata

Query Parameters

Name Type Description
storeID string The Name of the store

Responses

202 Cache rescan initiated.

Response Attributes

Name Type Description Object Structure

400 Invalid input

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 store or store not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

GET /stores/{storeID}/volumes/{volumeID}/snapshots
Get collection of the available volume snapshots to restore in a store

Query Parameters

Name Type Description
storeID string The ID of the store
volumeID string The ID of the BlockVolume

Responses

200 Volumes returned successfully.

Response Attributes

Name Type Description Object Structure
snapshots array List of the block volume snapshots available for restore on the store

400 Invalid input

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

403 forbidden - either lacking permissions or account has been deactivated/suspended

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

404 store, store or volume not found

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging

500 Internal / unexpected error

Response Attributes

Name Type Description Object Structure
httpcode integer HTTP response code
message string Description of the error
uniqueid string Unique identifier for error instance, for debugging