Gets the cluster-federation service credentials. This API is currently unavailable. It is reserved for future support of cluster federation functionality.

Auth

GET /api/v2/cf-service-credentials

 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/cf-service-credentials' \ --header 'api_key: {api_key}'
Copy

Responses application/json

200

A successful response.

Get Service Credentials Response

object

The response to get the service credentials for the CF 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

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

Login to the cluster federation.

Login to the cluster federation service. This API is currently unavailable. It is reserved for future support of cluster federation functionality.

Auth

POST /api/v2/cflogin

 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/cflogin'
Copy

Responses application/json

200

A successful response.

Login Response	object	The response to the login to the CF 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 cluster-federation service.

default

An unexpected error response.

Response

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

List clusters.

List clusters attached to the cluster-federation. This API is currently unavailable. It is reserved for future support of cluster federation functionality.

Auth

GET /api/v2/clusters

 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/clusters' \ --header 'api_key: {api_key}'
Copy

Responses application/json

200

A successful response.

List Clusters Response	object	The response to list the Lightbits clusters connected to the CF 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
provisionedToEffectiveStorageRatio	string

401

Authentication required / Authentication failed

default

An unexpected error response.

Response

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

Attach a new cluster.

Attaches a new cluster to the system. This API is currently unavailable. It is reserved for future support of cluster federation functionality.

Auth

Request Body application/json

Attach Cluster Request	object	Request to attach a cluster to the CF 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/v2/clusters

 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/clusters' \ --header 'api_key: {api_key}' \ --data '{  "apiEndpoint": "{string}"}'
Copy

Responses application/json

200

A successful response.

Attach Cluster Response	object	Response to attach a Lightbits cluster to the CF 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 cluster-federation service.

default

An unexpected error response.

Response

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

Detach an existing cluster.

Detaches an existing cluster from the system. This API is currently unavailable. It is reserved for future support of cluster federation functionality.

Auth

Path Params

cid

string

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

DELETE /api/v2/clusters/{cid}

 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/clusters/{cid}' \ --header 'api_key: {api_key}'
Copy

Responses application/json

200

A successful response.

object

Response to detach a Lightbits cluster from the CF service.

400

Invalid argument.

401

Authentication required / Authentication failed

500

Internal error in the cluster-federation service.

default

An unexpected error response.

Response

 
{}
Copy

List workflows

List the running and completed workflows. This API is currently unavailable. It is reserved for future support of cluster federation functionality.

Auth

Query String

pageSize	integer
nextPageToken	string

GET /api/v2/workflows

 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/workflows' \ --header 'api_key: {api_key}' \ --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 CF 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 (e.g. attach cluster).
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.
attachClusterRequest	object	Request to attach a cluster to the CF 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`.
nextPageToken	string

400

Invalid argument.

401

Authentication required / Authentication failed

500

Internal error in the cluster-federation service.

default

An unexpected error response.

Response

 
{ "workflows": [  {   "id": "{string}",   "createdAt": "{date-time}",   "startedAt": "{date-time}",   "endedAt": "{date-time}",   "type": "{string}",   "state": "{string}",   "msg": "{string}",   "progress": {    "percent": "{int32}",    "stage": "{string}"   },   "attachClusterRequest": {    "apiEndpoint": "{string}"   }  } ], "nextPageToken": "{string}"}
Copy

Get a specific workflow

Gets a specific workflow by its ID. This API is currently unavailable. It is reserved for future support of cluster federation functionality.

Auth

Path Params

workflowId

string

Workflow ID to get

GET /api/v2/workflows/{workflowId}

 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/workflows/{workflowId}' \ --header 'api_key: {api_key}'
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 (e.g. attach cluster).
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.
attachClusterRequest	object	Request to attach a cluster to the CF 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`.

400

Invalid argument.

401

Authentication required / Authentication failed

500

Internal error in the cluster-federation service.

default

An unexpected error response.

Response

 
{ "workflow": {  "id": "{string}",  "createdAt": "{date-time}",  "startedAt": "{date-time}",  "endedAt": "{date-time}",  "type": "{string}",  "state": "{string}",  "msg": "{string}",  "progress": {   "percent": "{int32}",   "stage": "{string}"  },  "attachClusterRequest": {   "apiEndpoint": "{string}"  } }}
Copy

Cluster Operations

GET

/api/v2/cluster

Retrieve cluster information.

Cluster information - e.g., cluster UUID and SubsystemNQN - is exposed via this API.

Auth

GET /api/v2/cluster

 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster' \ --header 'api_key: {api_key}'
Copy

Responses application/json

200

A successful response.

object	object
UUID	string	UUID of cluster
subsystemNQN	string	Subsystem NQN that should be used by the hosts to connect to volumes on this cluster.
currentMaxReplicas	int64	A maximal number of replicas that a new volume can have, given the current state of the nodes. This value depends on the healthiness of the nodes.
supportedMaxReplicas	int64	Maximum number of replicas per volume supported by cluster. A maximal number of replicas that a volume can have, given cluster installation parameters (Number of Servers, Failure Domains...).
statistics	object	Cluster statistics (storage capacity, used storage, compression ration...)
installedPhysicalStorage	string	All installed SSDs capacities over all servers in a cluster, given in bytes.
managedPhysicalStorage	string	Sum of all managed and healthy SSDs capacities, given in bytes.
effectivePhysicalStorage	string	Effective Physical storage excluding overhead of OVP and Parity, given in bytes.
logicalStorage	string	Sum of capacities of all allocated volumes, given in bytes.
logicalUsedStorage	string	Logical storage space used by all volumes (n of LBAs x 4096), given in bytes.
physicalUsedStorage	string	Physical storage space occupied by all volumes (data only), given in bytes.
physicalUsedStorageIncludingParity	string	Physical storage space occupied by all data including Parity overhead when EC enabled (physical ndisks/(ndisks -1)), given in bytes.
freePhysicalStorage	string	Free storage before entering to read-only mode , given in bytes.
estimatedFreeLogicalStorage	string	Estimated free storage before entering to read-only mode assuming current compression ratio, given in bytes.
estimatedLogicalStorage	string	Estimate of total available logical storage based on current compression ratio (effective * compression)
compressionRatio	number	compression ratio logicalUsedStorage/physicalUsedStorage
ETag	string	Identifier for a specific version of a resource.
health	object	Cluster health: OK- cluster healthy, Warning - Inactive node(s) and/or degraded volumes in cluster, Error - ReadOnly/Unavailable volumes in cluster.
state	string	Enum: `None`,`OK`,`Warning`,`Error` Default: None
numDegradedVolumes	int64
numReadOnlyVolumes	int64
numNotAvailableVolumes	int64
numInactiveNodes	int64
numHealthyVolumes	int64
MinVersionInCluster	string	Lowest version of Lightbits running on one of the servers in the cluster.
MinAllowedVersion	string	For Lightbits internal use.
MaxAllowedVersion	string	Lightbits version this cluster can be upgraded to.
apiEndpoints	array[string]	A list of REST/gRPC endpoints - : pairs that the API listen on. Example entries: 192.168.16.16:443 192.168.16.17:443
discoveryEndpoints	array[string]	A list of TCP endpoints - : pairs that the Discovery Service listen on. Example entries: 192.168.16.16:8009 192.168.16.17:8009
clusterName	string	Cluster name.
lastUpgrade	object	Parameters of the last (or active) cluster upgrade process.
Status	string	The status of the upgrade operation Enum: `Unknown`,`None`,`UpgradeFailed`,`Upgrading` Default: Unknown
StartTime	date-time	The time of the upgrade task start
EndTime	date-time	The time of closing the upgrade task (completed or failed). Reset when the next upgrade starts.
TargetVersion	string	The version that should be installed by the end of the process.
ErrorMessage	string	Free formatted text, describes the error if such an error occurred.
ProgressStep	int64	Current upgrade step. You can use ProgressTotal to calculate percentage as ProgressStep/ProgressTotal.
ProgressTotal	int64	Total possible upgrade progress steps.
inBandAuthMode	string	Defines whether In-Band Authentication is enabled for the cluster(Enabled/Disabled). When enabled, authentication is required for hosts to connect to the Lightbits cluster. Enum: `UnKnown`,`Enabled`,`Disabled` Default: UnKnown
encryptionStatus	object	Information about the state of Cluster Level Encryption.
encryptionState	string	Indicates the encryption state of the cluster encryption status Enum: `Disabled`,`Enabling`,`Enabled`,`Unknown` Default: Disabled
kekGeneration	string	The current generation of the KEK
kekUpdateDate	date-time	The date of the last KEK update
previousKekGenerations	array[string]	The previous generations of the KEK
rotationState	string	Indicates the rotation state of the cluster encryption encryption status Enum: `NoRotation`,`DistributingKEK`,`EncryptyingDEKs` Default: NoRotation
federatedAuthenticationStatus	object	Information about the state of Federated Authentication
federatedAuthenticationEnabled	boolean
idpHealthInfos	array[object]
serverName	string
idpHealthStatus	string	Enum: `IdpHealthStatus_Healthy`,`IdpHealthStatus_UnHealthy`,`IdpHealthStatus_Unknown` Default: IdpHealthStatus_Healthy
timestamp	date-time
healthErrorMessage	string

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

 
{ "UUID": "{string}", "subsystemNQN": "{string}", "currentMaxReplicas": "{int64}", "supportedMaxReplicas": "{int64}", "statistics": {  "installedPhysicalStorage": "{string}",  "managedPhysicalStorage": "{string}",  "effectivePhysicalStorage": "{string}",  "logicalStorage": "{string}",  "logicalUsedStorage": "{string}",  "physicalUsedStorage": "{string}",  "physicalUsedStorageIncludingParity": "{string}",  "freePhysicalStorage": "{string}",  "estimatedFreeLogicalStorage": "{string}",  "estimatedLogicalStorage": "{string}",  "compressionRatio": "{number}" }, "ETag": "{string}", "health": {  "state": "{string}",  "numDegradedVolumes": "{int64}",  "numReadOnlyVolumes": "{int64}",  "numNotAvailableVolumes": "{int64}",  "numInactiveNodes": "{int64}",  "numHealthyVolumes": "{int64}" }, "MinVersionInCluster": "{string}", "MinAllowedVersion": "{string}", "MaxAllowedVersion": "{string}", "apiEndpoints": [  "{array[string]...}" ], "discoveryEndpoints": [  "{array[string]...}" ], "clusterName": "{string}", "lastUpgrade": {  "Status": "{string}",  "StartTime": "{date-time}",  "EndTime": "{date-time}",  "TargetVersion": "{string}",  "ErrorMessage": "{string}",  "ProgressStep": "{int64}",  "ProgressTotal": "{int64}" }, "inBandAuthMode": "{string}", "encryptionStatus": {  "encryptionState": "{string}",  "kekGeneration": "{string}",  "kekUpdateDate": "{date-time}",  "previousKekGenerations": [   "{array[string]...}"  ],  "rotationState": "{string}" }, "federatedAuthenticationStatus": {  "federatedAuthenticationEnabled": "{boolean}",  "idpHealthInfos": [   {    "serverName": "{string}",    "idpHealthStatus": "{string}",    "timestamp": "{date-time}",    "healthErrorMessage": "{string}"   }  ] }}
Copy

Volume Operations

/api/v2/volumes/{UUID}

DELETE

/api/v2/volumes/{UUID}

PUT

/api/v2/volumes/{UUID}

List volumes.

List can be filtered by failure domain. List can be partially returned by given offset UUID and size of the list. If offset is not provided, list is returned from the start. If offset UUID is provided, list starts from the next volume after the provided offset UUID. If limit is provided, length of the returned list is bounded by the limit. If limit is not provided, list is returned until the end. projectName is mandatory unless you are the admin. List can also be filtered by a specific source snapshot.

Auth

Query String

UUID	string	UUID. List only volume with matching UUID.
name	string	Name. List only volumes with specified name.
failureDomain	string	failureDomain. List volumes according to failureDomains volumes replicas are placed on.
offsetUUID	string	offsetUUID. When provided, returned list starts with next to offsetUUID volume.
limit	string	limit. Limits the number of volumes in the response (default/maximum value is 1000 volumes).
projectName	string	projectName. Optional. Return only volumes of the given project.
snapshotUUID	string	source snapshot UUID. Return only volumes created from this source snapshot.
showAll	boolean	showAll. Optional. Show also volumes in Deleting state (the default is false).

GET /api/v2/volumes

 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/volumes' \ --header 'api_key: {api_key}' \ --data UUID={UUID} \ --data name={name} \ --data failureDomain={failureDomain} \ --data offsetUUID={offsetUUID} \ --data limit={limit} \ --data projectName={projectName} \ --data snapshotUUID={snapshotUUID} \ --data showAll={showAll}
Copy

Responses application/json

200

A successful response.

object	object
volumes	array[object]
state	string	Indicates the current state of the volume in its creation/update/delete lifetime. It will reflect the state of execution of a user invoked API (CreateVolume, UpdateVolume..) or an internal operation (Volume migration). Enum: `Unknown`,`Creating`,`Available`,`Deleting`,`Deleted`,`Failed`,`Updating`,`Rollback`,`Migrating` Default: Unknown
protectionState	string	Indicates volume's data availability derived from the health of each of the replica's it resides on. Enum: `Unknown`,`FullyProtected`,`Degraded`,`ReadOnly`,`NotAvailable` Default: Unknown
replicaCount	int64	The number of replicas a volume can have. Valid values are 1, 2, and 3.
nodeList	array[string]	List of node UUIDs this volume is placed over.
UUID	string
nsid	int64	Volume's Namespace ID
acl	object	Access control list of strings (host NQN). Valid values: list of strings/ALLOW_ANY/ALLOW_NONE
values	array[string]
compression	string	valid values: true/enable/enabled or false/disable/disabled
size	string
name	string	A volume's name is unique at the project level. Name length must be between 1 and 253 characters and can contain any of: alphanumeric characters (a-z, A-Z, 0-9) ,hyphen (-), underscore (_) and period (.).
rebuildProgress	string	Progress of the volume's replica rebuild operation in percent.
statistics	object	Volume statistics. Contains information about the physical used capacity, used memory, compression ratio, and more.
logicalUsedStorage	string	Logical storage space used by volume, given in bytes.
physicalUsedStorage	string	Physical storage space used by volume excluding parity, given in bytes.
compressionRatio	number	compression ratio userWritten/physicalCapacity.
totalCompressionRatio	number	compression ratio sum(userWritten) / sum(physical capacity).
physicalCapacity	string	The physical capacity that exists in this volume layer.
physicalOwnedCapacity	string	The capacity that would be freed when the volume is deleted.
physicalOwnedMemory	string
physicalMemory	string
userWritten	string
unrecoverableDataIntegrityErrors	int64	Number of data integrity errors that could not be recovered by the system.
recoverableDataIntegrityErrors	int64	Number of data integrity errors that were recovered by the system.
IPAcl	object	Access control list of IP addresses. Valid values: list of valid IP addresses/ALLOW_ANY/ALLOW_NONE (optional, default: ALLOW_ANY).
values	array[string]
ETag	string	Identifier for a specific version of a resource.
connectedHosts	array[string]
sectorSize	int64	Volume sector size. Valid values: 4K (default), 512B.
projectName	string	Project name.
sourceSnapshotUUID	string	For a cloned volume, specify the source snapshot of this clone.
sourceSnapshotName	string	For a cloned volume, specify the source snapshot of this clone.
placementRestrictions	array[object]
operator	string	Volume affinity operator. Specifies that placement logic will match nodes that have labels in labelValueKeyPairs list. Enum: `Unknown`,`In` Default: Unknown
labelValueKeyPairs	array[object]	Volume affinity KeyPairs. Key currently must be one of: fd (failure domain). Value should specify the failure domains we want to match. PrimaryFd (primary failure domain). Value should specify the primary failure domain we want to match. ClusterId (cluster ID - cluster federation only). Value should specify the cluster ID we want to match.
key	string	Enum: `Unknown`,`FD`,`PrimaryFD`,`ClusterID` Default: Unknown
value	string
qosPolicyUUID	string	Optional volume's QoS policy UUID (if not specified the QoS policy defined in volume's project is used).
qosPolicyName	string	Optional volume's QoS policy name (if not specified the QoS policy defined in volume's project is used)
primaryNodeUUID	string	UUID of the primary node data is Read/Written for this volume.
creationTime	date-time	Time of volume creation (UTC).
labels	array[object]	Optionally add labels to a volume.
key	string
value	string
clusterId	string	The ID of the cluster where the volume resides.

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

 
{ "volumes": [  {   "state": "{string}",   "protectionState": "{string}",   "replicaCount": "{int64}",   "nodeList": [    "{array[string]...}"   ],   "UUID": "{string}",   "nsid": "{int64}",   "acl": {    "values": [     "{array[string]...}"    ]   },   "compression": "{string}",   "size": "{string}",   "name": "{string}",   "rebuildProgress": "{string}",   "statistics": {    "logicalUsedStorage": "{string}",    "physicalUsedStorage": "{string}",    "compressionRatio": "{number}",    "totalCompressionRatio": "{number}",    "physicalCapacity": "{string}",    "physicalOwnedCapacity": "{string}",    "physicalOwnedMemory": "{string}",    "physicalMemory": "{string}",    "userWritten": "{string}",    "unrecoverableDataIntegrityErrors": "{int64}",    "recoverableDataIntegrityErrors": "{int64}"   },   "IPAcl": {    "values": [     "{array[string]...}"    ]   },   "ETag": "{string}",   "connectedHosts": [    "{array[string]...}"   ],   "sectorSize": "{int64}",   "projectName": "{string}",   "sourceSnapshotUUID": "{string}",   "sourceSnapshotName": "{string}",   "placementRestrictions": [    {     "operator": "{string}",     "labelValueKeyPairs": [      {       "key": "{string}",       "value": "{string}"      }     ]    }   ],   "qosPolicyUUID": "{string}",   "qosPolicyName": "{string}",   "primaryNodeUUID": "{string}",   "creationTime": "{date-time}",   "labels": [    {     "key": "{string}",     "value": "{string}"    }   ],   "clusterId": "{string}"  } ]}
Copy

Create volume.

A volume has a user-defined name, capacity, and a string-based Access Control List (ACL). User can also select to enable compression and define IP-ACL (IP address-based control list).

Auth

Request Body application/json

object	object
name	string	A volume's name is unique at the project level. Name length must be between 1 and 253 characters and can contain any of: alphanumeric characters (a-z, A-Z, 0-9) ,hyphen (-), underscore (_) and period (.). pattern: `^[a-zA-Z0-9-_\.]{1,253}$`
size	string	Volume size.
acl	object	Access control list of strings (host NQN). Valid values: list of strings/ALLOW_ANY/ALLOW_NONE.
values	array[string]
compression	string	Volume compression. Valid values: true/enable/enabled/false/disable/disabled (default value is disable compression).
replicaCount	int64	The number of replicas a volume can have. Valid values are 1, 2, and 3.
IPAcl	object	Access control list of IP addresses. Valid values: list of valid IP addresses/ALLOW_ANY/ALLOW_NONE (optional, default: ALLOW_ANY).
values	array[string]
minReplicas	int64	not used.
sectorSize	string	Volume sector size. Valid values: 4K (default), 512B. Enum: `sectorSize_Default`,`sectorSize_512B`,`sectorSize_4K` Default: sectorSize_Default
projectName	string	Name of the project the volume belongs to.
sourceSnapshotUUID	string	Optionally specify a source snapshot to create a clone from (specify either sourceSnapshotUUID or sourceSnapshotName).
sourceSnapshotName	string	Optionally specify a source snapshot to create a clone from (specify either sourceSnapshotUUID or sourceSnapshotName).
placementRestrictions	array[object]	Specify volume affinity labels for placement restrictions This may only be specified for volumes of single replication (replicaCount=1), and where Dynamic Rebalance is disabled (feature flags FailInPlace and ProactiveRebalance, lbcli get feature-flag are false).
operator	string	Volume affinity operator. Specifies that placement logic will match nodes that have labels in labelValueKeyPairs list. Enum: `Unknown`,`In` Default: Unknown
labelValueKeyPairs	array[object]	Volume affinity KeyPairs. Key currently must be one of: fd (failure domain). Value should specify the failure domains we want to match. PrimaryFd (primary failure domain). Value should specify the primary failure domain we want to match. ClusterId (cluster ID - cluster federation only). Value should specify the cluster ID we want to match.
key	string	Enum: `Unknown`,`FD`,`PrimaryFD`,`ClusterID` Default: Unknown
value	string
qosPolicyUUID	string
qosPolicyName	string
labels	array[object]	User-defined labels are optional for a volume. Labels are key-value pairs. A volume can have up to 16 labels. label-key and label-value length must be between 1 and 253 characters and can contain any of: alphanumeric characters (a-z, A-Z, 0-9), hyphen (-), underscore (_), and period (.). When creating a clone, if labels are passed, the clone will be created with them. Otherwise, the labels are copied from the snapshot used for the clone.
key	string
value	string

POST /api/v2/volumes

 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/volumes' \ --header 'api_key: {api_key}' \ --data '{  "name": "{string}",  "size": "{string}",  "acl": {    "values": [      "{array[string]...}"    ]  },  "compression": "{string}",  "replicaCount": "{int64}",  "IPAcl": {    "values": [      "{array[string]...}"    ]  },  "minReplicas": "{int64}",  "sectorSize": "{string}",  "projectName": "{string}",  "sourceSnapshotUUID": "{string}",  "sourceSnapshotName": "{string}",  "placementRestrictions": [    {      "operator": "{string}",      "labelValueKeyPairs": [        {          "key": "{string}",          "value": "{string}"        }      ]    }  ],  "qosPolicyUUID": "{string}",  "qosPolicyName": "{string}",  "labels": [    {      "key": "{string}",      "value": "{string}"    }  ]}'
Copy

Responses application/json

200

A successful response.

object	object
state	string	Indicates the current state of the volume in its creation/update/delete lifetime. It will reflect the state of execution of a user invoked API (CreateVolume, UpdateVolume..) or an internal operation (Volume migration). Enum: `Unknown`,`Creating`,`Available`,`Deleting`,`Deleted`,`Failed`,`Updating`,`Rollback`,`Migrating` Default: Unknown
protectionState	string	Indicates volume's data availability derived from the health of each of the replica's it resides on. Enum: `Unknown`,`FullyProtected`,`Degraded`,`ReadOnly`,`NotAvailable` Default: Unknown
replicaCount	int64	The number of replicas a volume can have. Valid values are 1, 2, and 3.
nodeList	array[string]	List of node UUIDs this volume is placed over.
UUID	string
nsid	int64	Volume's Namespace ID
acl	object	Access control list of strings (host NQN). Valid values: list of strings/ALLOW_ANY/ALLOW_NONE
values	array[string]
compression	string	valid values: true/enable/enabled or false/disable/disabled
size	string
name	string	A volume's name is unique at the project level. Name length must be between 1 and 253 characters and can contain any of: alphanumeric characters (a-z, A-Z, 0-9) ,hyphen (-), underscore (_) and period (.).
rebuildProgress	string	Progress of the volume's replica rebuild operation in percent.
statistics	object	Volume statistics. Contains information about the physical used capacity, used memory, compression ratio, and more.
logicalUsedStorage	string	Logical storage space used by volume, given in bytes.
physicalUsedStorage	string	Physical storage space used by volume excluding parity, given in bytes.
compressionRatio	number	compression ratio userWritten/physicalCapacity.
totalCompressionRatio	number	compression ratio sum(userWritten) / sum(physical capacity).
physicalCapacity	string	The physical capacity that exists in this volume layer.
physicalOwnedCapacity	string	The capacity that would be freed when the volume is deleted.
physicalOwnedMemory	string
physicalMemory	string
userWritten	string
unrecoverableDataIntegrityErrors	int64	Number of data integrity errors that could not be recovered by the system.
recoverableDataIntegrityErrors	int64	Number of data integrity errors that were recovered by the system.
IPAcl	object	Access control list of IP addresses. Valid values: list of valid IP addresses/ALLOW_ANY/ALLOW_NONE (optional, default: ALLOW_ANY).
values	array[string]
ETag	string	Identifier for a specific version of a resource.
connectedHosts	array[string]
sectorSize	int64	Volume sector size. Valid values: 4K (default), 512B.
projectName	string	Project name.
sourceSnapshotUUID	string	For a cloned volume, specify the source snapshot of this clone.
sourceSnapshotName	string	For a cloned volume, specify the source snapshot of this clone.
placementRestrictions	array[object]
operator	string	Volume affinity operator. Specifies that placement logic will match nodes that have labels in labelValueKeyPairs list. Enum: `Unknown`,`In` Default: Unknown
labelValueKeyPairs	array[object]	Volume affinity KeyPairs. Key currently must be one of: fd (failure domain). Value should specify the failure domains we want to match. PrimaryFd (primary failure domain). Value should specify the primary failure domain we want to match. ClusterId (cluster ID - cluster federation only). Value should specify the cluster ID we want to match.
key	string	Enum: `Unknown`,`FD`,`PrimaryFD`,`ClusterID` Default: Unknown
value	string
qosPolicyUUID	string	Optional volume's QoS policy UUID (if not specified the QoS policy defined in volume's project is used).
qosPolicyName	string	Optional volume's QoS policy name (if not specified the QoS policy defined in volume's project is used)
primaryNodeUUID	string	UUID of the primary node data is Read/Written for this volume.
creationTime	date-time	Time of volume creation (UTC).
labels	array[object]	Optionally add labels to a volume.
key	string
value	string
clusterId	string	The ID of the cluster where the volume resides.

400

An invalid argument was provided, due to one of the following reasons: a mandatory argument is missing, name contains illegal characters, size is not a positive integer, replica count is outside of a valid range, ACL or IP-ACL are invalid.

401

Unauthorized: authentication failed.

403

Permission denied.

409

A volume with the provided name already exists.

500

Internal Lightbits error.

default

An unexpected error response.

Response

 
{ "state": "{string}", "protectionState": "{string}", "replicaCount": "{int64}", "nodeList": [  "{array[string]...}" ], "UUID": "{string}", "nsid": "{int64}", "acl": {  "values": [   "{array[string]...}"  ] }, "compression": "{string}", "size": "{string}", "name": "{string}", "rebuildProgress": "{string}", "statistics": {  "logicalUsedStorage": "{string}",  "physicalUsedStorage": "{string}",  "compressionRatio": "{number}",  "totalCompressionRatio": "{number}",  "physicalCapacity": "{string}",  "physicalOwnedCapacity": "{string}",  "physicalOwnedMemory": "{string}",  "physicalMemory": "{string}",  "userWritten": "{string}",  "unrecoverableDataIntegrityErrors": "{int64}",  "recoverableDataIntegrityErrors": "{int64}" }, "IPAcl": {  "values": [   "{array[string]...}"  ] }, "ETag": "{string}", "connectedHosts": [  "{array[string]...}" ], "sectorSize": "{int64}", "projectName": "{string}", "sourceSnapshotUUID": "{string}", "sourceSnapshotName": "{string}", "placementRestrictions": [  {   "operator": "{string}",   "labelValueKeyPairs": [    {     "key": "{string}",     "value": "{string}"    }   ]  } ], "qosPolicyUUID": "{string}", "qosPolicyName": "{string}", "primaryNodeUUID": "{string}", "creationTime": "{date-time}", "labels": [  {   "key": "{string}",   "value": "{string}"  } ], "clusterId": "{string}"}
Copy

Get volume information.

Get volume information by provided UUID

Auth

Path Params

UUID

string

UUID

Optional. The volume's UUID. Either UUID or Name must be provided to identify the volume to get.

Query String

name	string	Name. Optional. The volume's name. Either UUID or Name must be provided to identify the volume to get.
projectName	string	projectName. Name of project volume belongs to.

GET /api/v2/volumes/{UUID}

 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/volumes/{UUID}' \ --header 'api_key: {api_key}' \ --data name={name} \ --data projectName={projectName}
Copy

Responses application/json

200

A successful response.

object	object
state	string	Indicates the current state of the volume in its creation/update/delete lifetime. It will reflect the state of execution of a user invoked API (CreateVolume, UpdateVolume..) or an internal operation (Volume migration). Enum: `Unknown`,`Creating`,`Available`,`Deleting`,`Deleted`,`Failed`,`Updating`,`Rollback`,`Migrating` Default: Unknown
protectionState	string	Indicates volume's data availability derived from the health of each of the replica's it resides on. Enum: `Unknown`,`FullyProtected`,`Degraded`,`ReadOnly`,`NotAvailable` Default: Unknown
replicaCount	int64	The number of replicas a volume can have. Valid values are 1, 2, and 3.
nodeList	array[string]	List of node UUIDs this volume is placed over.
UUID	string
nsid	int64	Volume's Namespace ID
acl	object	Access control list of strings (host NQN). Valid values: list of strings/ALLOW_ANY/ALLOW_NONE
values	array[string]
compression	string	valid values: true/enable/enabled or false/disable/disabled
size	string
name	string	A volume's name is unique at the project level. Name length must be between 1 and 253 characters and can contain any of: alphanumeric characters (a-z, A-Z, 0-9) ,hyphen (-), underscore (_) and period (.).
rebuildProgress	string	Progress of the volume's replica rebuild operation in percent.
statistics	object	Volume statistics. Contains information about the physical used capacity, used memory, compression ratio, and more.
logicalUsedStorage	string	Logical storage space used by volume, given in bytes.
physicalUsedStorage	string	Physical storage space used by volume excluding parity, given in bytes.
compressionRatio	number	compression ratio userWritten/physicalCapacity.
totalCompressionRatio	number	compression ratio sum(userWritten) / sum(physical capacity).
physicalCapacity	string	The physical capacity that exists in this volume layer.
physicalOwnedCapacity	string	The capacity that would be freed when the volume is deleted.
physicalOwnedMemory	string
physicalMemory	string
userWritten	string
unrecoverableDataIntegrityErrors	int64	Number of data integrity errors that could not be recovered by the system.
recoverableDataIntegrityErrors	int64	Number of data integrity errors that were recovered by the system.
IPAcl	object	Access control list of IP addresses. Valid values: list of valid IP addresses/ALLOW_ANY/ALLOW_NONE (optional, default: ALLOW_ANY).
values	array[string]
ETag	string	Identifier for a specific version of a resource.
connectedHosts	array[string]
sectorSize	int64	Volume sector size. Valid values: 4K (default), 512B.
projectName	string	Project name.
sourceSnapshotUUID	string	For a cloned volume, specify the source snapshot of this clone.
sourceSnapshotName	string	For a cloned volume, specify the source snapshot of this clone.
placementRestrictions	array[object]
operator	string	Volume affinity operator. Specifies that placement logic will match nodes that have labels in labelValueKeyPairs list. Enum: `Unknown`,`In` Default: Unknown
labelValueKeyPairs	array[object]	Volume affinity KeyPairs. Key currently must be one of: fd (failure domain). Value should specify the failure domains we want to match. PrimaryFd (primary failure domain). Value should specify the primary failure domain we want to match. ClusterId (cluster ID - cluster federation only). Value should specify the cluster ID we want to match.
key	string	Enum: `Unknown`,`FD`,`PrimaryFD`,`ClusterID` Default: Unknown
value	string
qosPolicyUUID	string	Optional volume's QoS policy UUID (if not specified the QoS policy defined in volume's project is used).
qosPolicyName	string	Optional volume's QoS policy name (if not specified the QoS policy defined in volume's project is used)
primaryNodeUUID	string	UUID of the primary node data is Read/Written for this volume.
creationTime	date-time	Time of volume creation (UTC).
labels	array[object]	Optionally add labels to a volume.
key	string
value	string
clusterId	string	The ID of the cluster where the volume resides.

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Provided volume UUID is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

 
{ "state": "{string}", "protectionState": "{string}", "replicaCount": "{int64}", "nodeList": [  "{array[string]...}" ], "UUID": "{string}", "nsid": "{int64}", "acl": {  "values": [   "{array[string]...}"  ] }, "compression": "{string}", "size": "{string}", "name": "{string}", "rebuildProgress": "{string}", "statistics": {  "logicalUsedStorage": "{string}",  "physicalUsedStorage": "{string}",  "compressionRatio": "{number}",  "totalCompressionRatio": "{number}",  "physicalCapacity": "{string}",  "physicalOwnedCapacity": "{string}",  "physicalOwnedMemory": "{string}",  "physicalMemory": "{string}",  "userWritten": "{string}",  "unrecoverableDataIntegrityErrors": "{int64}",  "recoverableDataIntegrityErrors": "{int64}" }, "IPAcl": {  "values": [   "{array[string]...}"  ] }, "ETag": "{string}", "connectedHosts": [  "{array[string]...}" ], "sectorSize": "{int64}", "projectName": "{string}", "sourceSnapshotUUID": "{string}", "sourceSnapshotName": "{string}", "placementRestrictions": [  {   "operator": "{string}",   "labelValueKeyPairs": [    {     "key": "{string}",     "value": "{string}"    }   ]  } ], "qosPolicyUUID": "{string}", "qosPolicyName": "{string}", "primaryNodeUUID": "{string}", "creationTime": "{date-time}", "labels": [  {   "key": "{string}",   "value": "{string}"  } ], "clusterId": "{string}"}
Copy

Delete volume.

Deletes a volume according to the provided UUID or Name. Deletion of a volume is a long operation. The status of deletion can be queried by a GET operation on the volume. As long as the operation runs, the volume state is Deleting. Once the operation has completed, GET volume returns a NotFound error response.

Auth

Path Params

UUID

string

UUID

The volume's UUID for the delete volume request (optional; either UUID or Name must be provided to identify the volume to delete).

Query String

name	string	name. The volume's name for the delete volume request (optional; either UUID or Name must be provided to identify the volume to delete).
projectName	string	projectName. The project name of the volume to delete.

DELETE /api/v2/volumes/{UUID}

 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/volumes/{UUID}' \ --header 'api_key: {api_key}' \ --data name={name} \ --data projectName={projectName}
Copy

Responses application/json

200

A successful response.

object object

400

Provided invalid UUID, Name, or volume state does not allow deletion (Deleting/Failed).

401

Unauthorized: authentication failed.

403

Permission denied.

404

Volume with provided UUID or Name is not found.

409

There is a user operation in progress on the volume

412

Etag mismatch.

500

Internal Lightbits error.

503

Volume is in a temporary state that does not currently allow deletion (Creating/Updating).

default

An unexpected error response.

Response

 
{}
Copy

Update volume.

Update volume enables the change of the following attributes: size compression ACL list IP-ACL list QoS labels.

Auth

Path Params

UUID

string

UUID

Optional identifier of the volume to update (command must use either name or UUID fields to identify volume).

Request Body application/json

object	object
UUID	string	Optional identifier of the volume to update (command must use either name or UUID fields to identify volume).
acl	object	Access control list of strings (host NQN). Valid values: list of strings/ALLOW_ANY/ALLOW_NONE
values	array[string]
IPAcl	object	Access control list of IP addresses. Valid values: list of valid IP addresses/ALLOW_ANY/ALLOW_NONE
values	array[string]
size	string
compression	string	valid values: true/enable/enabled or false/disable/disabled
projectName	string	Name of the project the volume belongs to.
qosPolicyUUID	string
qosPolicyName	string
Force	boolean	To intentionally shrink volume size, provide updated volume size and set force to true.
name	string	Optional identifier of the volume to update (command must use either name or UUID fields to identify volume).
labels	array[object]	User-defined labels are optional for a volume. Labels are key-value pairs. A volume can have up to 16 labels. label-key and label-value length must be between 1 and 253 characters and can contain any of: alphanumeric characters (a-z, A-Z, 0-9) ,hyphen (-), underscore (_) and period (.). If labels are passed during volume update, the existing volume's labels are replaced with the new ones. Otherwise, the labels are untouched.
key	string
value	string
newName	string	Volume new name. A volume's name is unique on the project level. Name length must be between 1 and 253 characters and can contain any of: alphanumeric characters (a-z, A-Z, 0-9) ,hyphen (-), underscore (_) and period (.).

PUT /api/v2/volumes/{UUID}

 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/volumes/{UUID}' \ --header 'api_key: {api_key}' \ --data '{  "UUID": "{string}",  "acl": {    "values": [      "{array[string]...}"    ]  },  "IPAcl": {    "values": [      "{array[string]...}"    ]  },  "size": "{string}",  "compression": "{string}",  "projectName": "{string}",  "qosPolicyUUID": "{string}",  "qosPolicyName": "{string}",  "Force": "{boolean}",  "name": "{string}",  "labels": [    {      "key": "{string}",      "value": "{string}"    }  ],  "newName": "{string}"}'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid argument or a volume is in a state that cannot be updated (Deleting/Failed).

401

Unauthorized: authentication failed.

403

Permission denied.

404

Returned when the volume with given UUID is not found.

409

There is a user operation in progress on the volume.

412

Etag mismatch.

500

Internal Lightbits error.

501

Unimplemented capability (updating capacity).

503

Volume is in temporary state and cannot be updated now (Creating/Updating).

default

An unexpected error response.

Response

 
{}
Copy

durosapiv2.proto version not setProprietary

Authentication

Cluster Federation

Get cluster-federation service credentials

Login to the cluster federation.

List clusters.

Attach a new cluster.

Detach an existing cluster.

List workflows

Get a specific workflow

Cluster Operations

Retrieve cluster information.

Volume Operations

List volumes.

Create volume.

Get volume information.

Delete volume.

Update volume.

durosapiv2.proto version not set Proprietary