DMS API 1.4.0 TO-BE-DEFINED

Server

dms.example.com

Authentication

basic BasicAuth

Clone Service

/api/v1/clusters/refresh

DELETE

/api/v1/clusters/{cid}

GET

/api/v1/service-credentials

POST

/api/v1/snapshots/thickclone

POST

/api/v1/volumes/thickclone

GET

/api/v1/workflows

GET

/api/v1/workflows/{workflowId}

POST

/api/v1/workflows/{workflowId}/cancel

POST

/login

List Lightbits clusters

List the Lightbits clusters connected to the DMS service.

Auth

Headers

Authorization

string

Bearer id-token

GET /api/v1/clusters

xxxxxxxxxx
 
curl --get \ --url 'https://dms.example.com/api/v1/clusters' \ --header 'Authorization: {Authorization}'
Copy

Responses application/json

200

A successful response.

List Clusters Response	object	The response to list the Lightbits clusters connected to the DMS service.
clusters	array[object]
id	string	The UUID of the cluster. Must be a valid UUID.
name	string	The name of the cluster.
version	string	The minimum version of the Lightbits release on the cluster.
subsystemNqn	string	The NQN of the subsystem of the cluster.
apiEndpoints	array[string]	The list of API endpoints of the cluster.
discoveryEndpoints	array[string]	The list of discovery endpoints of the cluster.
clusterConnectionStatus	object	The connection status of the cluster.
accessConnectionStatus	string	The connection status of the cluster. Enum: `Connected`,`Disconnected`,`Unauthorized` Default: Connected
dataConnectionStatus	string	The connection status of the cluster. Enum: `Connected`,`Disconnected`,`Unauthorized` Default: Connected

401

Authentication required / Authentication failed

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "clusters": [  {   "id": "{string}",   "name": "{string}",   "version": "{string}",   "subsystemNqn": "{string}",   "apiEndpoints": [    "{array[string]...}"   ],   "discoveryEndpoints": [    "{array[string]...}"   ],   "clusterConnectionStatus": {    "accessConnectionStatus": "{string}",    "dataConnectionStatus": "{string}"   }  } ]}
Copy

Attach Lightbits cluster

Attach a Lightbits cluster to the DMS service.

Attaching a Lightbits cluster is a multi-step process:

Get the service credentials (GetServiceCredentials).
Import the public key into the Lightbits cluster. Save the decoded DMS pubKey to a file, and upload it to the Lightbits server: echo "" | base64 -d > /tmp/pub-key.pem scp /tmp/pub-key.pem @:/tmp/ rm -rf /tmp/pub-key.pem
Add the credentials to the Lightbits cluster. SSH to the Lightbits server that the credentials were uploaded to, and execute the following (requires system-admin privileges): lbcli create credential --project-name=system --type=rsa256pubkey --id= /tmp/pub-key.pem
Invoke the attach cluster API (this API).

Auth

Headers

Authorization

string

Bearer id-token

Request Body application/json

Attach Cluster Request	object	Request to attach a cluster to the DMS service.
apiEndpoint	string	Management API endpoint of the cluster to connect to. Any one of the API endpoints can be used must be of the form `<host>:<port>`, e.g.: `10.0.0.1:443`, `foo.bar.com:443`.

POST /api/v1/clusters

xxxxxxxxxx
 
curl --request POST \ --url 'https://dms.example.com/api/v1/clusters' \ --header 'Authorization: {Authorization}' \ --data '{  "apiEndpoint": "{string}"}'
Copy

Responses application/json

200

A successful response.

Attach Cluster Response	object	Response to attach a Lightbits cluster to the DMS service. ListWorkflows API and the returned workflow ID can be used to track the status of this operation.
workflowId	string

400

Invalid argument.

401

Authentication required / Authentication failed

500

Internal error in the DMS service.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "workflowId": "{string}"}
Copy

Refresh Lightbits clusters information

This API will trigger a refresh of the Lightbits clusters information.

Lightbits clusters information is cached in the DMS service, and this API will trigger a refresh of the information. Changed information examples can be:

A server was added to the cluster
A server was removed from the cluster
etc...

Auth

Headers

Authorization

string

Bearer id-token

POST /api/v1/clusters/refresh

xxxxxxxxxx
 
curl --request POST \ --url 'https://dms.example.com/api/v1/clusters/refresh' \ --header 'Authorization: {Authorization}'
Copy

Responses application/json

200

A successful response.

Refresh Clusters Response	object	Refresh Lightbits clusters information response, return an ID of the refresh workflow.
workflowId	string

401

Authentication required / Authentication failed

500

Internal error in the DMS service.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "workflowId": "{string}"}
Copy

Detach Lightbits cluster

Detach a Lightbits cluster from the DMS service.

Auth

Headers

Authorization

string

Bearer id-token

Path Params

cid

string

UUID of the cluster to detach from the DMS service (must be a valid UUID).

DELETE /api/v1/clusters/{cid}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://dms.example.com/api/v1/clusters/%7Bcid%7D' \ --header 'Authorization: {Authorization}'
Copy

Responses application/json

200

A successful response.

object

Response to detach a Lightbits cluster from the DMS service.

400

Invalid argument.

401

Authentication required / Authentication failed

500

Internal error in the DMS service.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Get DMS service credentials

Get the service credentials to enable attaching a cluster. The public key returned in the response should be imported into the Lightbits cluster.

Attaching a Lightbits cluster is a multi-step process:

Get the service credentials (this API).
Import the public key into the Lightbits cluster. Save the decoded DMS pubKey to a file, and upload them to the Lightbits server: echo "" | base64 -d > /tmp/pub-key.pem scp /tmp/pub-key.pem @:/tmp/ rm -rf /tmp/pub-key.pem
Add the credentials to the Lightbits cluster. SSH to the Lightbits server that the credentials were uploaded to, and execute the following (requires system-admin privileges): lbcli create credential --project-name=system --type=rsa256pubkey --id= /tmp/pub-key.pem
Invoke the attach cluster API (AttachCluster).

Auth

Headers

Authorization

string

Bearer id-token

GET /api/v1/service-credentials

xxxxxxxxxx
 
curl --get \ --url 'https://dms.example.com/api/v1/service-credentials' \ --header 'Authorization: {Authorization}'
Copy

Responses application/json

200

A successful response.

Get Service Credentials Response

object

The response to get the service credentials for the DMS service.

pubKeyId

string

The key ID to be used while importing the public key into the Lightbits cluster.

pubKey

string

The base64-encoded public key to be imported into the Lightbits cluster.

After Base64 decoding, the contents should be saved as a file (e.g. into ) and passed as an argument to the following command to the corresponding Lightbits cluster, with and substituted as appropriate. lbcli create credential --project-name=system --id= --type=rsa256pubkey

401

Authentication required / Authentication failed

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "pubKeyId": "{string}", "pubKey": "{string}"}
Copy

Create a thick clone snapshot

Create a thick clone snapshot from a source snapshot.

Auth

Headers

Authorization

string

Bearer id-token

Request Body application/json

object	object	The request to create a thick clone snapshot from a source snapshot. Note: This operation is subject to rate limiting. If the maximum number of running workflows (configured via maxRunningWorkflows) is reached, the request will be rejected with a ResourceExhausted (429) error. The limit prevents API denial-of-service by throttling workflow creation when the system is at capacity.
src	object	The source snapshot identification information for thick clone snapshot operation.
snapId	string	The UUID of the snapshot to be cloned (must be a valid UUID).
projectName	string	The name of the project source that the snapshot belongs to. Must conform to valid Lightbits resource naming conventions up to 256 alpha-numeric characters, and must be either a letter, digit, hyphen, underscore, or period.
clusterId	string	The UUID of the cluster where the source snapshot is located (must be a valid UUID).
dst	object	The destination (cloned) snapshot information for thick clone snapshot operation.
name	string	The name to assign to the destination (cloned) snapshot, must conform to valid Lightbits resource naming conventions up to 256 alpha-numeric characters, and must be either a letter, digit, hyphen, underscore or period.
projectName	string	Optional. The name of the project destination that the snapshot will reside on. Must conform to a valid Lightbits resource naming conventions up to 256 alpha numeric-characters, and must be either a letter, digit, hyphen, underscore or period. If not specified, the destination snapshot will be created in the same project as the source snapshot.
clusterId	string	The UUID of the cluster where the destination snapshot will be created (must be a valid UUID).
size	string	Optional. The size of the destination snapshot in bytes. If the size is not specified, the size of the source snapshot's volume will be used. If specified, the size must be equal or larger than the source snapshot's volume size.
replica	int32	Optional. The number of replicas to create for the destination snapshot. If not specified, the value will be taken from the source snapshot's volume. If specified, the value must be between 1 and 3.
description	string	Optional. The description of the destination snapshot (limited to up to 256 characters).
qosPolicyName	string	Optional. The name of an existing QoS policy to assign to the destination snapshot. The QoS policy can be used to limit write late to the destination volume.
sectorSize	int64	Optional. The sector size to create for the destination snapshot. If not specified, the value will be taken from the source snapshot's volume. If specified, the value must be either 512 or 4096.
compression	boolean	Optional. Determines whether compression is enabled for the destination snapshot. If set to true, data stored in the volume will be compressed. If not specified, compression settings will be inherited from the source snapshot.
verifyClone	boolean	Optional. If set to true, the clone operation will be verified by reading the destination volume.

Expand

POST /api/v1/snapshots/thickclone

xxxxxxxxxx
 
curl --request POST \ --url 'https://dms.example.com/api/v1/snapshots/thickclone' \ --header 'Authorization: {Authorization}' \ --data '{  "src": {    "snapId": "{string}",    "projectName": "{string}",    "clusterId": "{string}"  },  "dst": {    "name": "{string}",    "projectName": "{string}",    "clusterId": "{string}",    "size": "{string}",    "replica": "{int32}",    "description": "{string}",    "qosPolicyName": "{string}",    "sectorSize": "{int64}",    "compression": "{boolean}"  },  "verifyClone": "{boolean}"}'
Copy

Responses application/json

200

A successful response.

Thick Clone Snapshot Response	object	The response to create a thick clone snapshot from a source snapshot. ListWorkflows API and the returned workflow ID can be used to track the status of this operation.
workflowId	string

400

Invalid argument.

401

Authentication required / Authentication failed

429

Resource exhausted. The maximum number of running workflows has been reached. This limit (configurable via maxRunningWorkflows) prevents API denial-of-service. The request is throttled to avoid overwhelming the system. Please retry after some workflows complete.

500

Internal error in the DMS service.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "workflowId": "{string}"}
Copy

Create a thick clone volume

Create a thick clone volume from a source snapshot.

Auth

Headers

Authorization

string

Bearer id-token

Request Body application/json

Thick Clone Volume Request	object	Request to create a thick clone volume from a source snapshot. Note: This operation is subject to rate limiting. If the maximum number of running workflows (configured via maxRunningWorkflows) is reached, the request will be rejected with a ResourceExhausted (429) error. The limit prevents API denial-of-service by throttling workflow creation when the system is at capacity.
src	object	The source snapshot identification information for thick clone volume operation.
snapId	string	The UUID of the snapshot to be cloned (must be a valid UUID).
projectName	string	The name of the project source that the snapshot belongs to. Must conform to valid Lightbits resource naming conventions up to 256 alpha-numeric characters, and must be either a letter, digit, hyphen, underscore, or period.
clusterId	string	The UUID of the cluster where the source snapshot is located (must be a valid UUID).
dst	object	The destination (cloned) volume information for thick clone volume operation.
name	string	The name to assign to the destination (cloned) volume. Must conform to valid Lightbits resource naming conventions up to 256 alpha numeric characters, and must be either a letter, digit, hyphen, underscore or dot.
projectName	string	Optional. The name of the project destination volume will reside on. Must conform to valid Lightbits resource naming conventions up to 256 alpha-numeric characters, and must be either a letter, digit, hyphen, underscore or a period. If not specified, the destination volume will be created in the same project as the source snapshot.
clusterId	string	The UUID of the cluster where the destination volume will be created (must be a valid UUID).
size	string	Optional. The size of the destination volume in bytes. If the size is not specified, the size of the source snapshot's volume will be used. If specified, the size must be equal or larger than the source snapshot's volume size.
replica	int32	Optional. The number of replicas to create for the destination volume. If not specified the value will be taken from the source snapshot's volume. If specified, the value must be between 1 and 3.
qosPolicyName	string	Optional. The name of an existing QoS policy to assign to the destination volume. The QoS policy can be used to limit write late to the destination volume.
sectorSize	int64	Optional. The sector size to create for the destination volume. If not specified, the value will be taken from the source snapshot's volume. If specified, the value must be either 512 or 4096.
compression	boolean	Optional. Determines whether compression is enabled for the destination volume. If set to true, data stored in the volume will be compressed. If not specified, compression settings will be inherited from the source snapshot.
verifyClone	boolean	Optional. If set to true, the clone operation will be verified by reading the destination volume.

Expand

POST /api/v1/volumes/thickclone

xxxxxxxxxx
 
curl --request POST \ --url 'https://dms.example.com/api/v1/volumes/thickclone' \ --header 'Authorization: {Authorization}' \ --data '{  "src": {    "snapId": "{string}",    "projectName": "{string}",    "clusterId": "{string}"  },  "dst": {    "name": "{string}",    "projectName": "{string}",    "clusterId": "{string}",    "size": "{string}",    "replica": "{int32}",    "qosPolicyName": "{string}",    "sectorSize": "{int64}",    "compression": "{boolean}"  },  "verifyClone": "{boolean}"}'
Copy

Responses application/json

200

A successful response.

Thick Clone Volume Response	object	Response to create a thick clone volume from a source snapshot. ListWorkflows API and the returned workflow ID can be used to track the status of this operation.
workflowId	string

400

Invalid argument.

401

Authentication required / Authentication failed

429

500

Internal error in the DMS service.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "workflowId": "{string}"}
Copy

List workflows

List the running and completed workflows.

Auth

Headers

Authorization

string

Bearer id-token

Query String

pageSize	integer
nextPageToken	string

GET /api/v1/workflows

xxxxxxxxxx
 
curl --get \ --url 'https://dms.example.com/api/v1/workflows' \ --header 'Authorization: {Authorization}' \ --data pageSize={pageSize} \ --data nextPageToken={nextPageToken}
Copy

Responses application/json

200

A successful response.

List Workflows Response	object	The response to list the workflows. Note that the initial DMS service will only return the last 100 workflows.
workflows	array[object]
id	string	The UUID of the workflow.
createdAt	date-time	The time the workflow was created.
startedAt	date-time	The time the workflow started.
endedAt	date-time	The time the workflow completed.
type	string	The type of workflow (i.e., attach cluster, thick clone volume, thick clone snapshot).
state	string	The state of the workflow.
msg	string	A detailed message providing additional information on the workflow state. This is mainly used in case of failure.
progress	object	Progress information of the workflow.
percent	int32	The percentage of the workflow that has been completed.
stage	string	The current stage of the workflow.
thickCloneVolumeRequest	object	Request to create a thick clone volume from a source snapshot. Note: This operation is subject to rate limiting. If the maximum number of running workflows (configured via maxRunningWorkflows) is reached, the request will be rejected with a ResourceExhausted (429) error. The limit prevents API denial-of-service by throttling workflow creation when the system is at capacity.
src	object	The source snapshot identification information for thick clone volume operation.
snapId	string	The UUID of the snapshot to be cloned (must be a valid UUID).
projectName	string	The name of the project source that the snapshot belongs to. Must conform to valid Lightbits resource naming conventions up to 256 alpha-numeric characters, and must be either a letter, digit, hyphen, underscore, or period.
clusterId	string	The UUID of the cluster where the source snapshot is located (must be a valid UUID).
dst	object	The destination (cloned) volume information for thick clone volume operation.
name	string	The name to assign to the destination (cloned) volume. Must conform to valid Lightbits resource naming conventions up to 256 alpha numeric characters, and must be either a letter, digit, hyphen, underscore or dot.
projectName	string	Optional. The name of the project destination volume will reside on. Must conform to valid Lightbits resource naming conventions up to 256 alpha-numeric characters, and must be either a letter, digit, hyphen, underscore or a period. If not specified, the destination volume will be created in the same project as the source snapshot.
clusterId	string	The UUID of the cluster where the destination volume will be created (must be a valid UUID).
size	string	Optional. The size of the destination volume in bytes. If the size is not specified, the size of the source snapshot's volume will be used. If specified, the size must be equal or larger than the source snapshot's volume size.
replica	int32	Optional. The number of replicas to create for the destination volume. If not specified the value will be taken from the source snapshot's volume. If specified, the value must be between 1 and 3.
qosPolicyName	string	Optional. The name of an existing QoS policy to assign to the destination volume. The QoS policy can be used to limit write late to the destination volume.
sectorSize	int64	Optional. The sector size to create for the destination volume. If not specified, the value will be taken from the source snapshot's volume. If specified, the value must be either 512 or 4096.
compression	boolean	Optional. Determines whether compression is enabled for the destination volume. If set to true, data stored in the volume will be compressed. If not specified, compression settings will be inherited from the source snapshot.
verifyClone	boolean	Optional. If set to true, the clone operation will be verified by reading the destination volume.
snapshotCloneRequest	object	The request to create a thick clone snapshot from a source snapshot. Note: This operation is subject to rate limiting. If the maximum number of running workflows (configured via maxRunningWorkflows) is reached, the request will be rejected with a ResourceExhausted (429) error. The limit prevents API denial-of-service by throttling workflow creation when the system is at capacity.
src	object	The source snapshot identification information for thick clone snapshot operation.
snapId	string	The UUID of the snapshot to be cloned (must be a valid UUID).
projectName	string	The name of the project source that the snapshot belongs to. Must conform to valid Lightbits resource naming conventions up to 256 alpha-numeric characters, and must be either a letter, digit, hyphen, underscore, or period.
clusterId	string	The UUID of the cluster where the source snapshot is located (must be a valid UUID).
dst	object	The destination (cloned) snapshot information for thick clone snapshot operation.
name	string	The name to assign to the destination (cloned) snapshot, must conform to valid Lightbits resource naming conventions up to 256 alpha-numeric characters, and must be either a letter, digit, hyphen, underscore or period.
projectName	string	Optional. The name of the project destination that the snapshot will reside on. Must conform to a valid Lightbits resource naming conventions up to 256 alpha numeric-characters, and must be either a letter, digit, hyphen, underscore or period. If not specified, the destination snapshot will be created in the same project as the source snapshot.
clusterId	string	The UUID of the cluster where the destination snapshot will be created (must be a valid UUID).
size	string	Optional. The size of the destination snapshot in bytes. If the size is not specified, the size of the source snapshot's volume will be used. If specified, the size must be equal or larger than the source snapshot's volume size.
replica	int32	Optional. The number of replicas to create for the destination snapshot. If not specified, the value will be taken from the source snapshot's volume. If specified, the value must be between 1 and 3.
description	string	Optional. The description of the destination snapshot (limited to up to 256 characters).
qosPolicyName	string	Optional. The name of an existing QoS policy to assign to the destination snapshot. The QoS policy can be used to limit write late to the destination volume.
sectorSize	int64	Optional. The sector size to create for the destination snapshot. If not specified, the value will be taken from the source snapshot's volume. If specified, the value must be either 512 or 4096.
compression	boolean	Optional. Determines whether compression is enabled for the destination snapshot. If set to true, data stored in the volume will be compressed. If not specified, compression settings will be inherited from the source snapshot.
verifyClone	boolean	Optional. If set to true, the clone operation will be verified by reading the destination volume.
attachClusterRequest	object	Request to attach a cluster to the DMS service.
apiEndpoint	string	Management API endpoint of the cluster to connect to. Any one of the API endpoints can be used must be of the form `<host>:<port>`, e.g.: `10.0.0.1:443`, `foo.bar.com:443`.
details	object
nextPageToken	string

Expand

400

Invalid argument.

401

Authentication required / Authentication failed

500

Internal error in the DMS service.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "workflows": [  {   "id": "{string}",   "createdAt": "{date-time}",   "startedAt": "{date-time}",   "endedAt": "{date-time}",   "type": "{string}",   "state": "{string}",   "msg": "{string}",   "progress": {    "percent": "{int32}",    "stage": "{string}"   },   "thickCloneVolumeRequest": {    "src": {     "snapId": "{string}",     "projectName": "{string}",     "clusterId": "{string}"    },    "dst": {     "name": "{string}",     "projectName": "{string}",     "clusterId": "{string}",     "size": "{string}",     "replica": "{int32}",     "qosPolicyName": "{string}",     "sectorSize": "{int64}",     "compression": "{boolean}"    },    "verifyClone": "{boolean}"   },   "snapshotCloneRequest": {    "src": {     "snapId": "{string}",     "projectName": "{string}",     "clusterId": "{string}"    },    "dst": {     "name": "{string}",     "projectName": "{string}",     "clusterId": "{string}",     "size": "{string}",     "replica": "{int32}",     "description": "{string}",     "qosPolicyName": "{string}",     "sectorSize": "{int64}",     "compression": "{boolean}"    },    "verifyClone": "{boolean}"   },   "attachClusterRequest": {    "apiEndpoint": "{string}"   },   "details": {}  } ], "nextPageToken": "{string}"}
Copy

Expand

Get a specific workflow by its ID

Get a specific workflow by its ID.

Auth

Headers

Authorization

string

Bearer id-token

Path Params

workflowId

string

The ID of the workflow.

GET /api/v1/workflows/{workflowId}

xxxxxxxxxx
 
curl --get \ --url 'https://dms.example.com/api/v1/workflows/%7BworkflowId%7D' \ --header 'Authorization: {Authorization}'
Copy

Responses application/json

200

A successful response.

Get Workflow Response	object	The response to get a workflow by its ID.
workflow	object	The workflow information.
id	string	The UUID of the workflow.
createdAt	date-time	The time the workflow was created.
startedAt	date-time	The time the workflow started.
endedAt	date-time	The time the workflow completed.
type	string	The type of workflow (i.e., attach cluster, thick clone volume, thick clone snapshot).
state	string	The state of the workflow.
msg	string	A detailed message providing additional information on the workflow state. This is mainly used in case of failure.
progress	object	Progress information of the workflow.
percent	int32	The percentage of the workflow that has been completed.
stage	string	The current stage of the workflow.
thickCloneVolumeRequest	object	Request to create a thick clone volume from a source snapshot. Note: This operation is subject to rate limiting. If the maximum number of running workflows (configured via maxRunningWorkflows) is reached, the request will be rejected with a ResourceExhausted (429) error. The limit prevents API denial-of-service by throttling workflow creation when the system is at capacity.
src	object	The source snapshot identification information for thick clone volume operation.
snapId	string	The UUID of the snapshot to be cloned (must be a valid UUID).
projectName	string	The name of the project source that the snapshot belongs to. Must conform to valid Lightbits resource naming conventions up to 256 alpha-numeric characters, and must be either a letter, digit, hyphen, underscore, or period.
clusterId	string	The UUID of the cluster where the source snapshot is located (must be a valid UUID).
dst	object	The destination (cloned) volume information for thick clone volume operation.
name	string	The name to assign to the destination (cloned) volume. Must conform to valid Lightbits resource naming conventions up to 256 alpha numeric characters, and must be either a letter, digit, hyphen, underscore or dot.
projectName	string	Optional. The name of the project destination volume will reside on. Must conform to valid Lightbits resource naming conventions up to 256 alpha-numeric characters, and must be either a letter, digit, hyphen, underscore or a period. If not specified, the destination volume will be created in the same project as the source snapshot.
clusterId	string	The UUID of the cluster where the destination volume will be created (must be a valid UUID).
size	string	Optional. The size of the destination volume in bytes. If the size is not specified, the size of the source snapshot's volume will be used. If specified, the size must be equal or larger than the source snapshot's volume size.
replica	int32	Optional. The number of replicas to create for the destination volume. If not specified the value will be taken from the source snapshot's volume. If specified, the value must be between 1 and 3.
qosPolicyName	string	Optional. The name of an existing QoS policy to assign to the destination volume. The QoS policy can be used to limit write late to the destination volume.
sectorSize	int64	Optional. The sector size to create for the destination volume. If not specified, the value will be taken from the source snapshot's volume. If specified, the value must be either 512 or 4096.
compression	boolean	Optional. Determines whether compression is enabled for the destination volume. If set to true, data stored in the volume will be compressed. If not specified, compression settings will be inherited from the source snapshot.
verifyClone	boolean	Optional. If set to true, the clone operation will be verified by reading the destination volume.
snapshotCloneRequest	object	The request to create a thick clone snapshot from a source snapshot. Note: This operation is subject to rate limiting. If the maximum number of running workflows (configured via maxRunningWorkflows) is reached, the request will be rejected with a ResourceExhausted (429) error. The limit prevents API denial-of-service by throttling workflow creation when the system is at capacity.
src	object	The source snapshot identification information for thick clone snapshot operation.
snapId	string	The UUID of the snapshot to be cloned (must be a valid UUID).
projectName	string	The name of the project source that the snapshot belongs to. Must conform to valid Lightbits resource naming conventions up to 256 alpha-numeric characters, and must be either a letter, digit, hyphen, underscore, or period.
clusterId	string	The UUID of the cluster where the source snapshot is located (must be a valid UUID).
dst	object	The destination (cloned) snapshot information for thick clone snapshot operation.
name	string	The name to assign to the destination (cloned) snapshot, must conform to valid Lightbits resource naming conventions up to 256 alpha-numeric characters, and must be either a letter, digit, hyphen, underscore or period.
projectName	string	Optional. The name of the project destination that the snapshot will reside on. Must conform to a valid Lightbits resource naming conventions up to 256 alpha numeric-characters, and must be either a letter, digit, hyphen, underscore or period. If not specified, the destination snapshot will be created in the same project as the source snapshot.
clusterId	string	The UUID of the cluster where the destination snapshot will be created (must be a valid UUID).
size	string	Optional. The size of the destination snapshot in bytes. If the size is not specified, the size of the source snapshot's volume will be used. If specified, the size must be equal or larger than the source snapshot's volume size.
replica	int32	Optional. The number of replicas to create for the destination snapshot. If not specified, the value will be taken from the source snapshot's volume. If specified, the value must be between 1 and 3.
description	string	Optional. The description of the destination snapshot (limited to up to 256 characters).
qosPolicyName	string	Optional. The name of an existing QoS policy to assign to the destination snapshot. The QoS policy can be used to limit write late to the destination volume.
sectorSize	int64	Optional. The sector size to create for the destination snapshot. If not specified, the value will be taken from the source snapshot's volume. If specified, the value must be either 512 or 4096.
compression	boolean	Optional. Determines whether compression is enabled for the destination snapshot. If set to true, data stored in the volume will be compressed. If not specified, compression settings will be inherited from the source snapshot.
verifyClone	boolean	Optional. If set to true, the clone operation will be verified by reading the destination volume.
attachClusterRequest	object	Request to attach a cluster to the DMS service.
apiEndpoint	string	Management API endpoint of the cluster to connect to. Any one of the API endpoints can be used must be of the form `<host>:<port>`, e.g.: `10.0.0.1:443`, `foo.bar.com:443`.
details	object

Expand

400

Invalid argument.

401

Authentication required / Authentication failed

500

Internal error in the DMS service.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "workflow": {  "id": "{string}",  "createdAt": "{date-time}",  "startedAt": "{date-time}",  "endedAt": "{date-time}",  "type": "{string}",  "state": "{string}",  "msg": "{string}",  "progress": {   "percent": "{int32}",   "stage": "{string}"  },  "thickCloneVolumeRequest": {   "src": {    "snapId": "{string}",    "projectName": "{string}",    "clusterId": "{string}"   },   "dst": {    "name": "{string}",    "projectName": "{string}",    "clusterId": "{string}",    "size": "{string}",    "replica": "{int32}",    "qosPolicyName": "{string}",    "sectorSize": "{int64}",    "compression": "{boolean}"   },   "verifyClone": "{boolean}"  },  "snapshotCloneRequest": {   "src": {    "snapId": "{string}",    "projectName": "{string}",    "clusterId": "{string}"   },   "dst": {    "name": "{string}",    "projectName": "{string}",    "clusterId": "{string}",    "size": "{string}",    "replica": "{int32}",    "description": "{string}",    "qosPolicyName": "{string}",    "sectorSize": "{int64}",    "compression": "{boolean}"   },   "verifyClone": "{boolean}"  },  "attachClusterRequest": {   "apiEndpoint": "{string}"  },  "details": {} }}
Copy

Expand

Cancel a workflow by its ID

Cancel a specific workflow by its ID.

Auth

Headers

Authorization

string

Bearer id-token

Path Params

workflowId

string

The ID of the workflow (Optional - specify either the runID or workflowID).

Query String

runId

string

The ID of the workflow (Optional - specify either the runID or workflowID).

POST /api/v1/workflows/{workflowId}/cancel

xxxxxxxxxx
 
curl --request POST \ --url 'https://dms.example.com/api/v1/workflows/%7BworkflowId%7D/cancel' \ --header 'Authorization: {Authorization}' \ --data runId={runId}
Copy

Responses application/json

200

A successful response.

Cancel Workflow Response

object

Response of cancel a workflow by its ID.

400

Invalid argument.

401

Authentication required / Authentication failed

500

Internal error in the DMS service.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Login to the DMS service

If successful, the response will contain a token that should be used in the Authorization header for all subsequent requests.

Auth

Headers

Authorization

string

Basic authentication header base64 encoded user:password

POST /login

xxxxxxxxxx
 
curl --request POST \ --url 'https://dms.example.com/login' \ --header 'Authorization: {Authorization}'
Copy

Responses application/json

200

A successful response.

Login Response	object	The response to the login to the DMS service.
tokenType	string	The type of token.
expiresIn	string	The time in seconds when the token will expire.
idToken	string	The ID of the token.

401

Authentication required / Authentication failed

500

Internal error in the DMS service.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "tokenType": "{string}", "expiresIn": "{string}", "idToken": "{string}"}
Copy

DMS API 1.4.0TO-BE-DEFINED

Authentication

Clone Service

List Lightbits clusters

Attach Lightbits cluster

Refresh Lightbits clusters information

Detach Lightbits cluster

Get DMS service credentials

Create a thick clone snapshot

Create a thick clone volume

List workflows

Get a specific workflow by its ID

Cancel a workflow by its ID

Login to the DMS service

DMS API 1.4.0 TO-BE-DEFINED