durosapiv2.proto version not set

/api/v2/cf-service-credentials

/api/v2/clusters/{cid}

/api/v2/workflows

/api/v2/workflows/{workflowId}

/api/v2/projects/{projectName}/events

/cflogin

Get cluster-federation service credentials

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

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/cf-service-credentials'
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

xxxxxxxxxx
 
{ "pubKeyId": "{string}", "pubKey": "{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

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/clusters'
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

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}"   }  } ]}
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

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/clusters' \ --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

xxxxxxxxxx
 
{ "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}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/clusters/%7Bcid%7D'
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

xxxxxxxxxx
 
{}
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

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/workflows' \ --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

xxxxxxxxxx
 
{ "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}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/workflows/%7BworkflowId%7D'
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

xxxxxxxxxx
 
{ "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

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 /cflogin

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/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

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

Cluster Operations

/api/v2/version

Retrieve cluster information.

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

Auth

GET /api/v2/cluster

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster'
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

Expand

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "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

Expand

Retrieve cluster information.

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

Auth

GET /api/v2/clusterinfo

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/clusterinfo'
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 server.
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	A maximal number of replicas that a volume can have, given the cluster installation parameters.
ETag	string	identifier for a specific version of a resource.
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
nvmeEndpoints	array[string]	A list of TCP endpoints - : pairs that the NVMe targets listen on. Example entries: 192.168.16.16:4420 192.168.16.17:4420
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.
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

Expand

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "subsystemNQN": "{string}", "currentMaxReplicas": "{int64}", "supportedMaxReplicas": "{int64}", "ETag": "{string}", "apiEndpoints": [  "{array[string]...}" ], "discoveryEndpoints": [  "{array[string]...}" ], "nvmeEndpoints": [  "{array[string]...}" ], "clusterName": "{string}", "lastUpgrade": {  "Status": "{string}",  "StartTime": "{date-time}",  "EndTime": "{date-time}",  "TargetVersion": "{string}",  "ErrorMessage": "{string}",  "ProgressStep": "{int64}",  "ProgressTotal": "{int64}" }, "encryptionStatus": {  "encryptionState": "{string}",  "kekGeneration": "{string}",  "kekUpdateDate": "{date-time}",  "previousKekGenerations": [   "{array[string]...}"  ],  "rotationState": "{string}" }}
Copy

Get all Lightbits events from cluster.

API to pull the events from the aggregated cluster event log.

Auth

Query String

projectName	string	projectName. List only events that are associated with the specified project.
nextToken	string	nextToken. Optional. Specifies the first event to return when using consecutive paginated requests. Use the nextToken returned in the response of the previous request as the indication for the first event the new request should fetch. The value of nextToken is an event ID.
since	string	since. Optional. Return a list of events with a timestamp not earlier than the given timestamp. The timestamp format must be given in UTC time in ISO-8601, e.g.: 2000-01-01T12:00:00.000Z.
until	string	until. Optional. Return a list of events with a timestamp not later than the given timestamp. The timestamp format must be given in UTC time in ISO-8601, e.g.: 2000-01-01T12:00:00.000Z.
limit	string	limit. Optional. Set a limit for the maximum number of events that can be returned in this response.
severity	array	severity. Optional. Return only events of the given severity.
componentType	string	component type. Optional. Return only events of the given component type.

GET /api/v2/events

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/events' \ --data projectName={projectName} \ --data nextToken={nextToken} \ --data since={since} \ --data until={until} \ --data limit={limit} \ --data severity={severity} \ --data componentType={componentType}
Copy

Responses application/json

200

A successful response.

object	object
events	array[object]
ID	string
Time	date-time
Type	string	Enum: `UnknownType`,`Cluster`,`Node`,`Volume`,`NVMeSSD`,`Server`,`DataIntegrity`,`ClusterEncryption` Default: UnknownType
Severity	string	Enum: `UnkownSeverity`,`Info`,`Low`,`Medium`,`High`,`Critical` Default: UnkownSeverity
EventName	string
EventCode	int64
ReportingService	string	Enum: `UnkownReportingService`,`CM`,`NM`,`API`,`UM` Default: UnkownReportingService
AssociatedEventID	string	The event ID related to this event.
Status	string
CauseCode	int64
Description	string
ComponentVolumesInfo	object
ProjectVolumesMap	object
*	object
VolumeComponentInfoList	array[object]
ID	string
Name	string
ComponentNVMeSSDInfo	object
ID	string
Name	string
ComponentNodeInfo	object
ID	string
Name	string
ComponentServerInfo	object
ID	string
Name	string
ComponentClusterInfo	object
ID	string
Name	string
ComponentDataIntegrityInfo	object
NodeUUID	string
ServerUUID	string
SSDs	array[string]
nextToken	string

Expand

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Project not found.

500

Internal Lightbits error.

501

Unimplemented capability. Specify only a single parameter to filter events: componentType, ProjectName, or Severity.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "events": [  {   "ID": "{string}",   "Time": "{date-time}",   "Type": "{string}",   "Severity": "{string}",   "EventName": "{string}",   "EventCode": "{int64}",   "ReportingService": "{string}",   "AssociatedEventID": "{string}",   "Status": "{string}",   "CauseCode": "{int64}",   "Description": "{string}",   "ComponentVolumesInfo": {    "ProjectVolumesMap": {}   },   "ComponentNVMeSSDInfo": {    "ID": "{string}",    "Name": "{string}"   },   "ComponentNodeInfo": {    "ID": "{string}",    "Name": "{string}"   },   "ComponentServerInfo": {    "ID": "{string}",    "Name": "{string}"   },   "ComponentClusterInfo": {    "ID": "{string}",    "Name": "{string}"   },   "ComponentDataIntegrityInfo": {    "NodeUUID": "{string}",    "ServerUUID": "{string}",    "SSDs": [     "{array[string]...}"    ]   }  } ], "nextToken": "{string}"}
Copy

Retrieve server logs and other information.

Retrieve all server logs. This command will trigger a dedicated Lightbits script that will package all server logs and information them into a tarball file then fetch the tarball file.

Auth

Query String

SkipStatistics	boolean	SkipStatistics. The fetch log operation will download by default all of the statistics from the relevant server By passing this parameter fetch logs will skip the statistics collection.
CaptureCpuAndTcpDump	boolean	CaptureCpuAndTcpDump. Capture CPU and tcpdump stats for five seconds to tcpdump.cap + sar.log in network/
NumOfDaysToCollectLogs	integer	NumOfDaysToCollectLogs. Number of days back to collect the logs (the default is two days).
CollectServicesLbcliEtcd	boolean	CollectServicesLbcliEtcd. Collect services information - lbcli and etcd dump only (the default will also collect all relevant logs).
IntervalBetweenBEReadCycles	integer	IntervalBetweenBEReadCycles. The interval in seconds between FE/BE statistics captures (the default is five seconds).
DontCollectlogs	boolean	DontCollectlogs. Do not collect /var/log.
LogFilename	string	LogFilename. Log filename prefix for convenience (do not use spaces).
NumOfstatisticsToCapture	integer	NumOfstatisticsToCapture. The number of FE/BE statistics cycles to capture (the default is one).
DontCompressOutput	boolean	DontCompressOutput. Do not compress the output tar file. The default is gzip, but xz can be selected with the -x flag.
IoNice	boolean	IoNice. Set the nicest IO/CPU priority on most commands via 'ionice -c 2 -n 7 nice -n 19'. Default: 'ionice -c 2 -n 7'
UseHighCompression	boolean	UseHighCompression. If compressing, use stronger xz compression instead of gzip. The file extension will be txz instead of tgz

GET /api/v2/logs

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/logs' \ --data SkipStatistics={SkipStatistics} \ --data CaptureCpuAndTcpDump={CaptureCpuAndTcpDump} \ --data NumOfDaysToCollectLogs={NumOfDaysToCollectLogs} \ --data CollectServicesLbcliEtcd={CollectServicesLbcliEtcd} \ --data IntervalBetweenBEReadCycles={IntervalBetweenBEReadCycles} \ --data DontCollectlogs={DontCollectlogs} \ --data LogFilename={LogFilename} \ --data NumOfstatisticsToCapture={NumOfstatisticsToCapture} \ --data DontCompressOutput={DontCompressOutput} \ --data IoNice={IoNice} \ --data UseHighCompression={UseHighCompression}
Copy

Responses application/json

200

A successful response.(streaming responses)

Stream result of google.api.HttpBody	object
result	object	Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
content_type	string	The HTTP Content-Type header value specifying the content type of the body.
data	string	The HTTP request/response body as raw binary.
extensions	array[object]	Application specific response metadata. Must be set in the first response for streaming APIs.
type_url	string	A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: If no scheme is provided, `https` is assumed. An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
value	string	Must be a valid serialized protocol buffer of the above specified type.
error	object
grpc_code	int32
http_code	int32
message	string
http_status	string
details	array[object]
type_url	string	A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: If no scheme is provided, `https` is assumed. An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
value	string	Must be a valid serialized protocol buffer of the above specified type.

Expand

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "result": {  "content_type": "{string}",  "data": "{string}",  "extensions": [   {    "type_url": "{string}",    "value": "{string}"   }  ] }, "error": {  "grpc_code": "{int32}",  "http_code": "{int32}",  "message": "{string}",  "http_status": "{string}",  "details": [   {    "type_url": "{string}",    "value": "{string}"   }  ] }}
Copy

Get all Lightbits events from cluster.

API to pull the events from the aggregated cluster event log.

Auth

Path Params

projectName

string

projectName

List only events that are associated with the specified project.

Query String

nextToken	string	nextToken. Optional. Specifies the first event to return when using consecutive paginated requests. Use the nextToken returned in the response of the previous request as the indication for the first event the new request should fetch. The value of nextToken is an event ID.
since	string	since. Optional. Return a list of events with a timestamp not earlier than the given timestamp. The timestamp format must be given in UTC time in ISO-8601, e.g.: 2000-01-01T12:00:00.000Z.
until	string	until. Optional. Return a list of events with a timestamp not later than the given timestamp. The timestamp format must be given in UTC time in ISO-8601, e.g.: 2000-01-01T12:00:00.000Z.
limit	string	limit. Optional. Set a limit for the maximum number of events that can be returned in this response.
severity	array	severity. Optional. Return only events of the given severity.
componentType	string	component type. Optional. Return only events of the given component type.

GET /api/v2/projects/{projectName}/events

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/events' \ --data nextToken={nextToken} \ --data since={since} \ --data until={until} \ --data limit={limit} \ --data severity={severity} \ --data componentType={componentType}
Copy

Responses application/json

200

A successful response.

object	object
events	array[object]
ID	string
Time	date-time
Type	string	Enum: `UnknownType`,`Cluster`,`Node`,`Volume`,`NVMeSSD`,`Server`,`DataIntegrity`,`ClusterEncryption` Default: UnknownType
Severity	string	Enum: `UnkownSeverity`,`Info`,`Low`,`Medium`,`High`,`Critical` Default: UnkownSeverity
EventName	string
EventCode	int64
ReportingService	string	Enum: `UnkownReportingService`,`CM`,`NM`,`API`,`UM` Default: UnkownReportingService
AssociatedEventID	string	The event ID related to this event.
Status	string
CauseCode	int64
Description	string
ComponentVolumesInfo	object
ProjectVolumesMap	object
*	object
VolumeComponentInfoList	array[object]
ID	string
Name	string
ComponentNVMeSSDInfo	object
ID	string
Name	string
ComponentNodeInfo	object
ID	string
Name	string
ComponentServerInfo	object
ID	string
Name	string
ComponentClusterInfo	object
ID	string
Name	string
ComponentDataIntegrityInfo	object
NodeUUID	string
ServerUUID	string
SSDs	array[string]
nextToken	string

Expand

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Project not found.

500

Internal Lightbits error.

501

Unimplemented capability. Specify only a single parameter to filter events: componentType, ProjectName, or Severity.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "events": [  {   "ID": "{string}",   "Time": "{date-time}",   "Type": "{string}",   "Severity": "{string}",   "EventName": "{string}",   "EventCode": "{int64}",   "ReportingService": "{string}",   "AssociatedEventID": "{string}",   "Status": "{string}",   "CauseCode": "{int64}",   "Description": "{string}",   "ComponentVolumesInfo": {    "ProjectVolumesMap": {}   },   "ComponentNVMeSSDInfo": {    "ID": "{string}",    "Name": "{string}"   },   "ComponentNodeInfo": {    "ID": "{string}",    "Name": "{string}"   },   "ComponentServerInfo": {    "ID": "{string}",    "Name": "{string}"   },   "ComponentClusterInfo": {    "ID": "{string}",    "Name": "{string}"   },   "ComponentDataIntegrityInfo": {    "NodeUUID": "{string}",    "ServerUUID": "{string}",    "SSDs": [     "{array[string]...}"    ]   }  } ], "nextToken": "{string}"}
Copy

Product Version.

Get product version information.

Auth

GET /api/v2/version

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/version'
Copy

Responses application/json

200

A successful response.

object	object
apiVersion	string

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "apiVersion": "{string}"}
Copy

Federated Authentication Operations

/api/v2/cluster/IdpConfiguration

/api/v2/cluster/IdpConfiguration

/api/v2/cluster/IdpConfiguration

/api/v2/cluster/IdpConfiguration/{name}

/api/v2/cluster/IdpConfiguration/{name}

/api/v2/cluster/authMaps

/api/v2/cluster/authMaps

/api/v2/cluster/authMaps/{name}

/api/v2/cluster/authMaps/{name}

/api/v2/cluster/authMaps/{name}

/api/v2/cluster/federatedAuthentication/disable

/api/v2/cluster/federatedAuthentication/enable

/api/v2/cluster/idpClientConfs

/api/v2/cluster/idpClientConfs

/api/v2/cluster/idpClientConfs/{name}

/api/v2/cluster/idpClientConfs/{name}

/api/v2/cluster/idpClientConfs/{name}

Listing IdP configurations.

Auth

GET /api/v2/cluster/IdpConfiguration

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/IdpConfiguration'
Copy

Responses application/json

200

A successful response.

object	object
idpConfigurations	array[object]
name	string	Unique name identifying this IdP configuration.
idpIssuerURL	string	The URL of the Identity Provider (IdP) issuer.
state	string	The current state of the IdP configuration. Enum: `Unknown`,`Creating`,`Active`,`Updating`,`Failed` Default: Unknown
type	string	Type of an IdP (Identity Provider). Currently only ADFS is supported. Enum: `unknownIdp`,`ADFS` Default: unknownIdp
UUID	string	The UUID of this IdP configuration.
proxyInfo	object	Optional. Proxy server information for an IdP that is accessed via proxy.
URL	string	URL of the proxy server. Pattern: "http://:".
Username	string	Username for the proxy server.
Password	string	Password for the proxy server.

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "idpConfigurations": [  {   "name": "{string}",   "idpIssuerURL": "{string}",   "state": "{string}",   "type": "{string}",   "UUID": "{string}",   "proxyInfo": {    "URL": "{string}",    "Username": "{string}",    "Password": "{string}"   }  } ]}
Copy

Create an IdP configuration.

Create a configuration for a remote Identity Provider (IdP) that could be used to authorize access to the Lightbits cluster. Currently only a single IdP configuration is supported.

Auth

Request Body application/json

object	object
name	string	The unique name to assign to this IdP configuration.
idpIssuerURL	string	The URL of the Identity Provider (IdP) issuer.
type	string	Type of an IdP (Identity Provider). Currently only ADFS is supported. Enum: `unknownIdp`,`ADFS` Default: unknownIdp
proxyInfo	object	Optional. Proxy server information for an IdP that is accessed via proxy.
URL	string	URL of the proxy server. Pattern: "http://:".
Username	string	Username for the proxy server.
Password	string	Password for the proxy server.

POST /api/v2/cluster/IdpConfiguration

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/IdpConfiguration' \ --data '{  "name": "{string}",  "idpIssuerURL": "{string}",  "type": "{string}",  "proxyInfo": {    "URL": "{string}",    "Username": "{string}",    "Password": "{string}"  }}'
Copy

Responses application/json

200

A successful response.

object	object	IDPConfiguration represents the configuration for the Identity Provider (IdP) in the Lightbits cluster.
name	string	Unique name identifying this IdP configuration.
idpIssuerURL	string	The URL of the Identity Provider (IdP) issuer.
state	string	The current state of the IdP configuration. Enum: `Unknown`,`Creating`,`Active`,`Updating`,`Failed` Default: Unknown
type	string	Type of an IdP (Identity Provider). Currently only ADFS is supported. Enum: `unknownIdp`,`ADFS` Default: unknownIdp
UUID	string	The UUID of this IdP configuration.
proxyInfo	object	Optional. Proxy server information for an IdP that is accessed via proxy.
URL	string	URL of the proxy server. Pattern: "http://:".
Username	string	Username for the proxy server.
Password	string	Password for the proxy server.

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "name": "{string}", "idpIssuerURL": "{string}", "state": "{string}", "type": "{string}", "UUID": "{string}", "proxyInfo": {  "URL": "{string}",  "Username": "{string}",  "Password": "{string}" }}
Copy

Update an IdP configuration.

Auth

Request Body application/json

object	object
name	string	Specify name of the IdP configuration to update.
idpIssuerURL	string	The URL of the Identity Provider (IdP) issuer.
type	string	The type of an IdP (Identity Provider). Currently only ADFS is supported. Enum: `unknownIdp`,`ADFS` Default: unknownIdp
proxyInfo	object	Proxy server information for an IdP that is accessed via proxy.
URL	string	URL of the proxy server. Pattern: "http://:".
Username	string	Username for the proxy server.
Password	string	Password for the proxy server.

PUT /api/v2/cluster/IdpConfiguration

xxxxxxxxxx
 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/IdpConfiguration' \ --data '{  "name": "{string}",  "idpIssuerURL": "{string}",  "type": "{string}",  "proxyInfo": {    "URL": "{string}",    "Username": "{string}",    "Password": "{string}"  }}'
Copy

Responses application/json

200

A successful response.

object	object	IDPConfiguration represents the configuration for the Identity Provider (IdP) in the Lightbits cluster.
name	string	Unique name identifying this IdP configuration.
idpIssuerURL	string	The URL of the Identity Provider (IdP) issuer.
state	string	The current state of the IdP configuration. Enum: `Unknown`,`Creating`,`Active`,`Updating`,`Failed` Default: Unknown
type	string	Type of an IdP (Identity Provider). Currently only ADFS is supported. Enum: `unknownIdp`,`ADFS` Default: unknownIdp
UUID	string	The UUID of this IdP configuration.
proxyInfo	object	Optional. Proxy server information for an IdP that is accessed via proxy.
URL	string	URL of the proxy server. Pattern: "http://:".
Username	string	Username for the proxy server.
Password	string	Password for the proxy server.

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

IdP configuration with the specified name was not found.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "name": "{string}", "idpIssuerURL": "{string}", "state": "{string}", "type": "{string}", "UUID": "{string}", "proxyInfo": {  "URL": "{string}",  "Username": "{string}",  "Password": "{string}" }}
Copy

Get an IdP configuration.

Auth

Path Params

name

string

name

The name of the IdP configuration to get.

GET /api/v2/cluster/IdpConfiguration/{name}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/IdpConfiguration/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object	object	IDPConfiguration represents the configuration for the Identity Provider (IdP) in the Lightbits cluster.
name	string	Unique name identifying this IdP configuration.
idpIssuerURL	string	The URL of the Identity Provider (IdP) issuer.
state	string	The current state of the IdP configuration. Enum: `Unknown`,`Creating`,`Active`,`Updating`,`Failed` Default: Unknown
type	string	Type of an IdP (Identity Provider). Currently only ADFS is supported. Enum: `unknownIdp`,`ADFS` Default: unknownIdp
UUID	string	The UUID of this IdP configuration.
proxyInfo	object	Optional. Proxy server information for an IdP that is accessed via proxy.
URL	string	URL of the proxy server. Pattern: "http://:".
Username	string	Username for the proxy server.
Password	string	Password for the proxy server.

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

IdP configuration with the specified name was not found.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "name": "{string}", "idpIssuerURL": "{string}", "state": "{string}", "type": "{string}", "UUID": "{string}", "proxyInfo": {  "URL": "{string}",  "Username": "{string}",  "Password": "{string}" }}
Copy

Delete an IdP configuration.

Auth

Path Params

name

string

name

The name of the IdP configuration to delete.

DELETE /api/v2/cluster/IdpConfiguration/{name}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/IdpConfiguration/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

IdP configuration with the specified name was not found.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

List all authorization map entries.

List all map entries between a clientID/claim/group and an access right (scope and role).

Auth

GET /api/v2/cluster/authMaps

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/authMaps'
Copy

Responses application/json

200

A successful response.

object	object
authMapEntries	array[object]
UUID	string
name	string	Name of specific authorization mapping entry.
identifier	string	Identifier to map application or clientID/claim/group to Lightbits scope/role. This should either have the clientID of the relevant application (app mode), or an identifier of a specific claim/group extracted from the field specified by claimName (user or converge modes).
scope	string	Represents the scope assigned to this client/claim/group in the Lightbits cluster.
role	string	Represents the role assigned to this client/claim/group in the Lightbits cluster.
idpConfigurationName	string	IdP configuration that is associated with this authorization map entry.

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "authMapEntries": [  {   "UUID": "{string}",   "name": "{string}",   "identifier": "{string}",   "scope": "{string}",   "role": "{string}",   "idpConfigurationName": "{string}"  } ]}
Copy

Create an authorization map entry.

Create an authorization map entry that maps a clientID/claim/group to an access right (scope and role).

Auth

Request Body application/json

object	object
name	string	Name of a specific authorization mapping entry.
identifier	string	Identifier to map application or clientID/claim/group to Lightbits scope/role. This should either have the clientID of the relevant application (app mode) or an identifier of a specific claim/group extracted from the field specified by claimName (user or converge modes).
scope	string	Represents the scope assigned to this client/claim/group in the Lightbits cluster.
role	string	Represents the role assigned to this client/claim/group in the Lightbits cluster.
idpConfigurationName	string	Idp configuration that is associated with this authorization map entry.

POST /api/v2/cluster/authMaps

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/authMaps' \ --data '{  "name": "{string}",  "identifier": "{string}",  "scope": "{string}",  "role": "{string}",  "idpConfigurationName": "{string}"}'
Copy

Responses application/json

200

A successful response.

object	object
UUID	string
name	string	Name of specific authorization mapping entry.
identifier	string	Identifier to map application or clientID/claim/group to Lightbits scope/role. This should either have the clientID of the relevant application (app mode), or an identifier of a specific claim/group extracted from the field specified by claimName (user or converge modes).
scope	string	Represents the scope assigned to this client/claim/group in the Lightbits cluster.
role	string	Represents the role assigned to this client/claim/group in the Lightbits cluster.
idpConfigurationName	string	IdP configuration that is associated with this authorization map entry.

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "name": "{string}", "identifier": "{string}", "scope": "{string}", "role": "{string}", "idpConfigurationName": "{string}"}
Copy

Get an authorization map entry.

Get an authorization map entry that maps a clientID/claim/group to an access right (scope and role).

Auth

Path Params

name

string

name

Name of a specific authorization mapping entry.

GET /api/v2/cluster/authMaps/{name}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/authMaps/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object	object
UUID	string
name	string	Name of specific authorization mapping entry.
identifier	string	Identifier to map application or clientID/claim/group to Lightbits scope/role. This should either have the clientID of the relevant application (app mode), or an identifier of a specific claim/group extracted from the field specified by claimName (user or converge modes).
scope	string	Represents the scope assigned to this client/claim/group in the Lightbits cluster.
role	string	Represents the role assigned to this client/claim/group in the Lightbits cluster.
idpConfigurationName	string	IdP configuration that is associated with this authorization map entry.

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Auth map entry not found.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "name": "{string}", "identifier": "{string}", "scope": "{string}", "role": "{string}", "idpConfigurationName": "{string}"}
Copy

Delete an authorization map entry.

Delete an authorization map entry that maps a clientID/claim/group to an access right (scope and role).

Auth

Path Params

name

string

name

Name of a specific authorization mapping entry.

DELETE /api/v2/cluster/authMaps/{name}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/authMaps/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Auth map entry not found.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

update an authorization map entry.

Update an authorization map entry that maps a clientID/claim/group to an access right (scope and role).

Auth

Path Params

name

string

name

Name of a specific authorization mapping entry.

Request Body application/json

object	object
name	string	Name of a specific authorization mapping entry.
scope	string	The scope assigned to this client/claim/group in the Lightbits cluster.
role	string	The role assigned to this client/claim/group in the Lightbits cluster.
identifier	string	Identifier to map application or claim/group to a Lightbits scope/role. This should either have the clientID of the relevant application (app mode) or an identifier of a specific claim/group extracted from the field specified by claimName (user or converge modes).
idpConfigurationName	string	IdP configuration that is associated with this authorization map entry.

PUT /api/v2/cluster/authMaps/{name}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/authMaps/%7Bname%7D' \ --data '{  "name": "{string}",  "scope": "{string}",  "role": "{string}",  "identifier": "{string}",  "idpConfigurationName": "{string}"}'
Copy

Responses application/json

200

A successful response.

object	object
UUID	string
name	string	Name of specific authorization mapping entry.
identifier	string	Identifier to map application or clientID/claim/group to Lightbits scope/role. This should either have the clientID of the relevant application (app mode), or an identifier of a specific claim/group extracted from the field specified by claimName (user or converge modes).
scope	string	Represents the scope assigned to this client/claim/group in the Lightbits cluster.
role	string	Represents the role assigned to this client/claim/group in the Lightbits cluster.
idpConfigurationName	string	IdP configuration that is associated with this authorization map entry.

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Auth map entry not found.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "name": "{string}", "identifier": "{string}", "scope": "{string}", "role": "{string}", "idpConfigurationName": "{string}"}
Copy

Disable Federated Authentication.

Auth

Request Body application/json

object object

POST /api/v2/cluster/federatedAuthentication/disable

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/federatedAuthentication/disable' \ --data '{}'
Copy

Responses application/json

200

A successful response.

object object

401

Unauthorized: authentication failed.

403

Permission denied.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Enable Federated Authentication.

Auth

Request Body application/json

object object

POST /api/v2/cluster/federatedAuthentication/enable

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/federatedAuthentication/enable' \ --data '{}'
Copy

Responses application/json

200

A successful response.

object object

401

Unauthorized: authentication failed.

403

Permission denied.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Listing idp-client-configurations.

Auth

GET /api/v2/cluster/idpClientConfs

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/idpClientConfs'
Copy

Responses application/json

200

A successful response.

object	object
idpClientConfigurations	array[object]
UUID	string	The UUID of the idp-client-config entry.
name	string	A unique name of the idp-client-conf.
clientId	string	A unique client ID identifier registered in the IdP to identify a specific application (or a client) that wants to access resources from a Lightbits cluster. When using converge authorization mode, this field must be configured to: NOT_APPLICABLE.
idpConfigurationName	string	A reference to the IdP configuration that will use this client configuration.
claimName	string	When working in user authorization/converge mode, the claim name specifies the name of the field in JWT claim from which to extract the identifier value from. Note that this field is only required when authzMode is user or converge.
authzMode	string	The authorization mode will determine what information from access JWT will be mapped to a matching scope/role in the Lightbits cluster. The authorization mode can be one of the following: user, app, converge. Enum: `UnknownAuthzMode`,`App`,`User`,`Converge` Default: UnknownAuthzMode

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "idpClientConfigurations": [  {   "UUID": "{string}",   "name": "{string}",   "clientId": "{string}",   "idpConfigurationName": "{string}",   "claimName": "{string}",   "authzMode": "{string}"  } ]}
Copy

Create an idp-client-configuration.

Auth

Request Body application/json

object	object
name	string	A unique name of the idp-client-conf.
clientId	string	A unique client ID identifier registered in the IdP to identify a specific application (or a client) that wants to access resources from a Lightbits cluster. When using converge authorization mode, this field must be configured to: NOT_APPLICABLE.
idpConfigurationName	string	A reference to the IdP configuration that will use this client configuration.
claimName	string	When working in user authorization/converge mode, the claim name specifies the name of the field in the JWT claim from which to extract the identifier value from. Note that this field is only required when authzMode is user or converge.
authzMode	string	The authorization mode will determine what information from access JWT will be mapped to a matching scope/role in the Lightbits cluster. The authorization mode can be one of the following: user, app, converge. Enum: `UnknownAuthzMode`,`App`,`User`,`Converge` Default: UnknownAuthzMode

POST /api/v2/cluster/idpClientConfs

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/idpClientConfs' \ --data '{  "name": "{string}",  "clientId": "{string}",  "idpConfigurationName": "{string}",  "claimName": "{string}",  "authzMode": "{string}"}'
Copy

Responses application/json

200

A successful response.

object	object	idp-client-configuration represents a configuration of a client-specific IdP entry in the Lightbits cluster. The Lightbits cluster supports IdP client configurations with three types of authorization modes: App, User, and Converge. App authorization mode should be used when Lightbits should map a specific client to a scope and role. User authorization mode should be used when Lightbits should map according to both the client ID and a specific claim in the JWT. Converge mode is used when Lightbits should map only according to the claim in the JWT. In this mode the client ID is ignored. Only a single such entry can be created for each IdP configuration. Lightbits API service will first attempt to check for a dedicated IdP client configuration using this client ID, falling back to to an optional converge entry only if no direct client specific entry is found.
UUID	string	The UUID of the idp-client-config entry.
name	string	A unique name of the idp-client-conf.
clientId	string	A unique client ID identifier registered in the IdP to identify a specific application (or a client) that wants to access resources from a Lightbits cluster. When using converge authorization mode, this field must be configured to: NOT_APPLICABLE.
idpConfigurationName	string	A reference to the IdP configuration that will use this client configuration.
claimName	string	When working in user authorization/converge mode, the claim name specifies the name of the field in JWT claim from which to extract the identifier value from. Note that this field is only required when authzMode is user or converge.
authzMode	string	The authorization mode will determine what information from access JWT will be mapped to a matching scope/role in the Lightbits cluster. The authorization mode can be one of the following: user, app, converge. Enum: `UnknownAuthzMode`,`App`,`User`,`Converge` Default: UnknownAuthzMode

Expand

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "name": "{string}", "clientId": "{string}", "idpConfigurationName": "{string}", "claimName": "{string}", "authzMode": "{string}"}
Copy

Get an idp-client-configuration.

Auth

Path Params

name

string

name

The name of the idp-client-conf to get.

GET /api/v2/cluster/idpClientConfs/{name}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/idpClientConfs/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object	object	idp-client-configuration represents a configuration of a client-specific IdP entry in the Lightbits cluster. The Lightbits cluster supports IdP client configurations with three types of authorization modes: App, User, and Converge. App authorization mode should be used when Lightbits should map a specific client to a scope and role. User authorization mode should be used when Lightbits should map according to both the client ID and a specific claim in the JWT. Converge mode is used when Lightbits should map only according to the claim in the JWT. In this mode the client ID is ignored. Only a single such entry can be created for each IdP configuration. Lightbits API service will first attempt to check for a dedicated IdP client configuration using this client ID, falling back to to an optional converge entry only if no direct client specific entry is found.
UUID	string	The UUID of the idp-client-config entry.
name	string	A unique name of the idp-client-conf.
clientId	string	A unique client ID identifier registered in the IdP to identify a specific application (or a client) that wants to access resources from a Lightbits cluster. When using converge authorization mode, this field must be configured to: NOT_APPLICABLE.
idpConfigurationName	string	A reference to the IdP configuration that will use this client configuration.
claimName	string	When working in user authorization/converge mode, the claim name specifies the name of the field in JWT claim from which to extract the identifier value from. Note that this field is only required when authzMode is user or converge.
authzMode	string	The authorization mode will determine what information from access JWT will be mapped to a matching scope/role in the Lightbits cluster. The authorization mode can be one of the following: user, app, converge. Enum: `UnknownAuthzMode`,`App`,`User`,`Converge` Default: UnknownAuthzMode

Expand

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

idp-client-configuration with the specified name was not found.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "name": "{string}", "clientId": "{string}", "idpConfigurationName": "{string}", "claimName": "{string}", "authzMode": "{string}"}
Copy

Delete an idp-client-configuration.

Auth

Path Params

name

string

name

The name of the idp-client-conf to delete.

DELETE /api/v2/cluster/idpClientConfs/{name}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/idpClientConfs/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

idp-client-configuration with the specified name was not found.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Update an idp-client-configuration.

Auth

Path Params

name

string

name

The name of the idp-client-conf to update.

Request Body application/json

object	object
name	string	The name of the idp-client-conf to update.
claimName	string	When working in user authorization/converge mode, the claim name specifies the name of the field in the JWT claim from which to extract the identifier value from. Note that this field is only required when authzMode is user or converge.

PUT /api/v2/cluster/idpClientConfs/{name}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/idpClientConfs/%7Bname%7D' \ --data '{  "name": "{string}",  "claimName": "{string}"}'
Copy

Responses application/json

200

A successful response.

object	object	idp-client-configuration represents a configuration of a client-specific IdP entry in the Lightbits cluster. The Lightbits cluster supports IdP client configurations with three types of authorization modes: App, User, and Converge. App authorization mode should be used when Lightbits should map a specific client to a scope and role. User authorization mode should be used when Lightbits should map according to both the client ID and a specific claim in the JWT. Converge mode is used when Lightbits should map only according to the claim in the JWT. In this mode the client ID is ignored. Only a single such entry can be created for each IdP configuration. Lightbits API service will first attempt to check for a dedicated IdP client configuration using this client ID, falling back to to an optional converge entry only if no direct client specific entry is found.
UUID	string	The UUID of the idp-client-config entry.
name	string	A unique name of the idp-client-conf.
clientId	string	A unique client ID identifier registered in the IdP to identify a specific application (or a client) that wants to access resources from a Lightbits cluster. When using converge authorization mode, this field must be configured to: NOT_APPLICABLE.
idpConfigurationName	string	A reference to the IdP configuration that will use this client configuration.
claimName	string	When working in user authorization/converge mode, the claim name specifies the name of the field in JWT claim from which to extract the identifier value from. Note that this field is only required when authzMode is user or converge.
authzMode	string	The authorization mode will determine what information from access JWT will be mapped to a matching scope/role in the Lightbits cluster. The authorization mode can be one of the following: user, app, converge. Enum: `UnknownAuthzMode`,`App`,`User`,`Converge` Default: UnknownAuthzMode

Expand

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

idp-client-configuration with the specified name was not found.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "name": "{string}", "clientId": "{string}", "idpConfigurationName": "{string}", "claimName": "{string}", "authzMode": "{string}"}
Copy

Encryption Operations

/api/v2/cluster/clusterRootKey/rotate

/api/v2/cluster/clusterRootkey

/api/v2/cluster/encryption/enable

Rotate the cluster root encryption key (Mock).

Rotate the Cluster Level Encryption Key (KEK). After the rotation, all of the DEKs will be encrypted with the new KEK and the new KEK will be stored securely in the cluster.

Auth

POST /api/v2/cluster/clusterRootKey/rotate

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/clusterRootKey/rotate'
Copy

Responses application/json

200

A successful response.

object object

401

Unauthorized: authentication failed.

403

Permission denied.

404

Rotation is already in progress.

409

Last rotation occurred less than the defined interval period between rotations

412

Precondition failed.

500

System internal error.

501

Unimplemented capability.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Get cluster root encryption key.

Securely export the Cluster-Level Encryption Key (KEK). As a security measure, the exported key in the response will be encrypted.

Auth

Query String

encryptingKeyGeneration	string	encryptingKeyGeneration. The generation of the encryption key. if not specified, the latest key will be exported.
userPublicKey	string	userPublicKey. Public key to use in order to encrypt the exported KEK.

GET /api/v2/cluster/clusterRootkey

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/clusterRootkey' \ --data encryptingKeyGeneration={encryptingKeyGeneration} \ --data userPublicKey={userPublicKey}
Copy

Responses application/json

200

A successful response.

object	object
key	object	The object that includes each exported key and its generation.
encryptedKey	string	Cluster Encryption key encrypted with the given public key.
encryptingKeyGeneration	string	The Generation of the exported key.

401

Unauthorized: authentication failed.

501

Unimplemented capability.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "key": {  "encryptedKey": "{string}",  "encryptingKeyGeneration": "{string}" }}
Copy

Enable Cluster level encryption.

Enables cluster-level encryption. Once enabled, each volume will be encrypted with a Data Encryption Key (DEK), which is in turn encrypted by a Key Encryption Key (KEK). In the body, users can select the KeyStore type: tpm or file. Note: cluster encryption cannot be disabled once enabled.

Auth

Request Body application/json

object object

keyStore

string

Optional. Where to store the Encryption KEK on file or in tpm.

Enum: file,tpm

Default: file

POST /api/v2/cluster/encryption/enable

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/encryption/enable' \ --data '{  "keyStore": "{string}"}'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

409

Encryption is already enabled or enabling.

412

Precondition failed.

500

System internal error.

501

Unimplemented capability.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

In-band Authentication Operations

/api/v2/cluster/inBandAuth/disable

/api/v2/cluster/inBandAuth/enable

/api/v2/hosts

/api/v2/projects/{projectName}/trustedHostSecrets/{name}

/api/v2/projects/{projectName}/trustedHostSecrets/{name}

/api/v2/projects/{projectName}/trustedHosts

/api/v2/projects/{projectName}/trustedHosts

/api/v2/projects/{projectName}/trustedHosts/{name}

/api/v2/projects/{projectName}/trustedHosts/{name}

/api/v2/projects/{projectName}/trustedHosts/{name}

Disable In-Band cluster authentication (Beta).

Disables NVMe-oF In Band Authentication. Hosts can connect to a Lightbits cluster without establishing trust (the default Lightbits cluster configuration). In-Band Authentication functionality and its APIs are under development, available for evaluation purposes only. They should not be used in production clusters.

Auth

Request Body application/json

object	object
subsystemNqnName	string	Name of the subsystem NQN to disable In-Band Authentication for. If not specified, the cluster level will be assumed. Currently only supported for the default subsystem: DefaultSubSystem.

POST /api/v2/cluster/inBandAuth/disable

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/inBandAuth/disable' \ --data '{  "subsystemNqnName": "{string}"}'
Copy

Responses application/json

200

A successful response.

object object

401

Unauthorized: authentication failed.

403

Permission denied.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Enable In-Band cluster authentication (Beta).

Enables NVMe-oF In-Band Authentication. This allows a Lightbits cluster to selectively restrict the set of NVMe hosts (clients) that are allowed to connect to the NVMe target (Lightbits cluster), and also (optionally), restrict the set NVMe targets that a given NVMe host will trust and connect to. In-Band Authentication functionality and its APIs are under development, available for evaluation purposes only. They should not be used in production clusters.

Auth

Request Body application/json

object	object
subsystemNqnName	string	Name of the subsystem NQN to enable In-Band Authentication for. If not specified, the cluster level will be assumed. Currently only supported for the default subsystem: DefaultSubSystem.

POST /api/v2/cluster/inBandAuth/enable

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/inBandAuth/enable' \ --data '{  "subsystemNqnName": "{string}"}'
Copy

Responses application/json

200

A successful response.

object object

401

Unauthorized: authentication failed.

403

Permission denied.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Return a list of trusted hosts configurations.

Return a list of trusted hosts configurations. In-Band Authentication functionality and its APIs are under development, available for evaluation purposes only. They should not be used in production clusters.

Auth

Query String

projectName	string	projectName. Optional. When specified returns only trusted hosts that belong to the specified project.
offsetUUID	string	offsetUUID. Optional. When specified returns a list that starts a trusted host with a UUID equal to offsetUUID. Not currently supported.
limit	string	limit. Optional. Limits the number of trusted hosts in the response. Not currently supported.

GET /api/v2/hosts

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/hosts' \ --data projectName={projectName} \ --data offsetUUID={offsetUUID} \ --data limit={limit}
Copy

Responses application/json

200

A successful response.

object	object
hosts	array[object]	List of trusted hosts.
name	string	Unique name identifying the trusted host.
projectName	string	Project this host belongs to.
UUID	string	Unique identifier of the trusted host (internally generated by the Lightbits cluster).
hostNqn	string	Host NQN (NVMe Qualified Name) of the trusted host.
labels	array[object]	Optional. Labels to associate with the trusted host.
key	string
value	string
authRequired	string	Optional. authRequired is set by default.
nextOffset	string	If the response contains more hosts than the limit, the nextOffset will be returned. Currently this is not supported.

400

Invalid arguments.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Failed to find host name/project.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "hosts": [  {   "name": "{string}",   "projectName": "{string}",   "UUID": "{string}",   "hostNqn": "{string}",   "labels": [    {     "key": "{string}",     "value": "{string}"    }   ],   "authRequired": "{string}"  } ], "nextOffset": "{string}"}
Copy

Get secrets of a host.

Get a trusted host secrets required for authentication and connection. In-Band Authentication functionality and its APIs are under development, available for evaluation purposes only. They should not be used in production clusters.

Auth

Path Params

projectName

string

projectName

Project name of the trusted host to get secrets for.

name

string

name

Name of the trusted host to get secrets for.

GET /api/v2/projects/{projectName}/trustedHostSecrets/{name}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/trustedHostSecrets/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object	object
host	object	Configuration of info for the trusted host.
name	string	Unique name identifying the trusted host.
projectName	string	Project this host belongs to.
UUID	string	Unique identifier of the trusted host (internally generated by the Lightbits cluster).
hostNqn	string	Host NQN (NVMe Qualified Name) of the trusted host.
labels	array[object]	Optional. Labels to associate with the trusted host.
key	string
value	string
authRequired	string	Optional. authRequired is set by default.
hostSecret	string	A host secret to allow a trusted connection from a host to the NVMe target (Lightbits cluster).
targetSecret	string	A target secret to allow a trusted connection from a NVMe target (Lightbits cluster) to a host.
targetSecretType	string	Type of target secret to set Disabled (default)/ Enabled/ AutoGenSecret. Enum: `Disabled`,`Enabled`,`AutoGenSecret` Default: Disabled

400

Invalid arguments.

401

Unauthorized: authentication failed.

404

Failed to find host name/project.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "host": {  "name": "{string}",  "projectName": "{string}",  "UUID": "{string}",  "hostNqn": "{string}",  "labels": [   {    "key": "{string}",    "value": "{string}"   }  ],  "authRequired": "{string}" }, "hostSecret": "{string}", "targetSecret": "{string}", "targetSecretType": "{string}"}
Copy

Set the secrets for a host.

Set hosts secrets for a trusted host to allow trusted connectivity between a Lightbits cluster and hosts, as part of In-Band Authentication support. Specifying a host secret is mandatory for trusted connect of this host to the Lightbits cluster, Specifying a target secret - either explicitly or by using auto-gen mode - is optional, allowing only a trusted Lightbits cluster to connect to the host, If no target secret is specified, the target secret type will be set to disable. In-Band Authentication functionality and its APIs are under development, available for evaluation purposes only. They should not be used in production clusters.

Auth

Path Params

projectName

string

projectName

Project name of the trusted host to set secrets for.

name

string

name

Name of the trusted host to set secrets for.

Request Body application/json

object	object
name	string	Name of the trusted host to set secrets for.
projectName	string	Project name of the trusted host to set secrets for.
hostSecret	string	A trusted host secret to allow trusted connection from a host to the NVMe target (Lightbits cluster).
targetSecret	string	A target secret to allow a trusted connection from an NVMe target (Lightbits cluster) to a host.
targetSecretType	string	Type of target secret to set Disabled (default)/ Enabled/ AutoGenSecret. Enum: `Disabled`,`Enabled`,`AutoGenSecret` Default: Disabled

PUT /api/v2/projects/{projectName}/trustedHostSecrets/{name}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/trustedHostSecrets/%7Bname%7D' \ --data '{  "name": "{string}",  "projectName": "{string}",  "hostSecret": "{string}",  "targetSecret": "{string}",  "targetSecretType": "{string}"}'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid arguments.

401

Unauthorized: authentication failed.

404

Failed to find host name/project.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Return a list of trusted hosts configurations.

Auth

Path Params

projectName

string

projectName

Optional. When specified returns only trusted hosts that belong to the specified project.

Query String

offsetUUID	string	offsetUUID. Optional. When specified returns a list that starts a trusted host with a UUID equal to offsetUUID. Not currently supported.
limit	string	limit. Optional. Limits the number of trusted hosts in the response. Not currently supported.

GET /api/v2/projects/{projectName}/trustedHosts

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/trustedHosts' \ --data offsetUUID={offsetUUID} \ --data limit={limit}
Copy

Responses application/json

200

A successful response.

object	object
hosts	array[object]	List of trusted hosts.
name	string	Unique name identifying the trusted host.
projectName	string	Project this host belongs to.
UUID	string	Unique identifier of the trusted host (internally generated by the Lightbits cluster).
hostNqn	string	Host NQN (NVMe Qualified Name) of the trusted host.
labels	array[object]	Optional. Labels to associate with the trusted host.
key	string
value	string
authRequired	string	Optional. authRequired is set by default.
nextOffset	string	If the response contains more hosts than the limit, the nextOffset will be returned. Currently this is not supported.

400

Invalid arguments.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Failed to find host name/project.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "hosts": [  {   "name": "{string}",   "projectName": "{string}",   "UUID": "{string}",   "hostNqn": "{string}",   "labels": [    {     "key": "{string}",     "value": "{string}"    }   ],   "authRequired": "{string}"  } ], "nextOffset": "{string}"}
Copy

Create a trusted host resource.

Create a trusted host resource with configuration parameters needed for authentication and NVMe connectivity. When In-Band Authentication is enabled, only trusted hosts can connect to a Lightbits cluster. For each trusted host, an associated Lightbits resource must be created using this command. In-Band Authentication functionality and its APIs are under development, available for evaluation purposes only. They should not be used in production clusters.

Auth

Path Params

projectName

string

projectName

Project this trusted host belongs to.

Request Body application/json

object	object
name	string	Unique name identifying the trusted host to create.
projectName	string	Project this trusted host belongs to.
hostNqn	string	Host NQN (NVMe Qualified Name) of the trusted host.
labels	array[object]	Optional. Labels to associate with the trusted host.
key	string
value	string
authRequired	string	Optional. authRequired is set by default.

POST /api/v2/projects/{projectName}/trustedHosts

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/trustedHosts' \ --data '{  "name": "{string}",  "projectName": "{string}",  "hostNqn": "{string}",  "labels": [    {      "key": "{string}",      "value": "{string}"    }  ],  "authRequired": "{string}"}'
Copy

Responses application/json

200

A successful response.

object	object
name	string	Unique name identifying the trusted host.
projectName	string	Project this host belongs to.
UUID	string	Unique identifier of the trusted host (internally generated by the Lightbits cluster).
hostNqn	string	Host NQN (NVMe Qualified Name) of the trusted host.
labels	array[object]	Optional. Labels to associate with the trusted host.
key	string
value	string
authRequired	string	Optional. authRequired is set by default.

400

Invalid arguments.

401

Unauthorized: authentication failed.

403

Permission denied.

409

Host with the provided host name and project name already exists.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "name": "{string}", "projectName": "{string}", "UUID": "{string}", "hostNqn": "{string}", "labels": [  {   "key": "{string}",   "value": "{string}"  } ], "authRequired": "{string}"}
Copy

Get a host.

Get a trusted host configuration. In-Band Authentication functionality and its APIs are under development, available for evaluation purposes only. They should not be used in production clusters.

Auth

Path Params

projectName

string

Project this trusted host belongs to (required to identify resource to get).

name

string

name

Name of the trusted host to get (required to identify resource to get).

GET /api/v2/projects/{projectName}/trustedHosts/{name}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/trustedHosts/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object	object
name	string	Unique name identifying the trusted host.
projectName	string	Project this host belongs to.
UUID	string	Unique identifier of the trusted host (internally generated by the Lightbits cluster).
hostNqn	string	Host NQN (NVMe Qualified Name) of the trusted host.
labels	array[object]	Optional. Labels to associate with the trusted host.
key	string
value	string
authRequired	string	Optional. authRequired is set by default.

400

Invalid arguments.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Failed to find host name/project.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "name": "{string}", "projectName": "{string}", "UUID": "{string}", "hostNqn": "{string}", "labels": [  {   "key": "{string}",   "value": "{string}"  } ], "authRequired": "{string}"}
Copy

Delete a trusted host.

Delete a trusted host configuration. In-Band Authentication functionality and its APIs are under development, available for evaluation purposes only. They should not be used in production clusters.

Auth

Path Params

projectName

string

projectName

Project this trusted host belongs to (required to identify resource to delete).

name

string

name

Name of the trusted host to delete (required to identify resource to delete).

DELETE /api/v2/projects/{projectName}/trustedHosts/{name}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/trustedHosts/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid arguments.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Failed to find host name/project .

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Update a host.

Update a trusted host configuration, optionally modifying labels. In-Band Authentication functionality and its APIs are under development, available for evaluation purposes only. They should not be used in production clusters.

Auth

Path Params

projectName

string

projectName

Project this trusted host belongs to (required to identify resource to update).

name

string

name

Name of the trusted host to update (required to identify resource to update).

Request Body application/json

object	object
name	string	Name of the trusted host to update (required to identify resource to update).
projectName	string	Project this trusted host belongs to (required to identify resource to update).
hostNqn	string	Host NQN (NVMe Qualified Name) of the trusted host to update. Currently update of hostNqn is not supported.
labels	array[object]	Optional. Labels to associate with the trusted host.
key	string
value	string
authRequired	string	Optional. authRequired is set by default

PUT /api/v2/projects/{projectName}/trustedHosts/{name}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/trustedHosts/%7Bname%7D' \ --data '{  "name": "{string}",  "projectName": "{string}",  "hostNqn": "{string}",  "labels": [    {      "key": "{string}",      "value": "{string}"    }  ],  "authRequired": "{string}"}'
Copy

Responses application/json

200

A successful response.

object	object
name	string	Unique name identifying the trusted host.
projectName	string	Project this host belongs to.
UUID	string	Unique identifier of the trusted host (internally generated by the Lightbits cluster).
hostNqn	string	Host NQN (NVMe Qualified Name) of the trusted host.
labels	array[object]	Optional. Labels to associate with the trusted host.
key	string
value	string
authRequired	string	Optional. authRequired is set by default.

400

Invalid arguments.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Failed to find host name/project.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "name": "{string}", "projectName": "{string}", "UUID": "{string}", "hostNqn": "{string}", "labels": [  {   "key": "{string}",   "value": "{string}"  } ], "authRequired": "{string}"}
Copy

Upgrade Operations

/api/v2/cluster/upgrade

/api/v2/servers/{UUID}/upgrade

Upgrade cluster.

Upgrades servers in the cluster one by one. Only servers that do not cause loss of service are upgraded. The progress and status of the upgrade operation can be monitored by be polling the server object.

Auth

Request Body application/json

object	object
InstallPkgUri	string	URI of Lightbits package to install.
UUIDs	array[string]	Optional. Servers with given UUIDs are upgraded. If not given, all servers in the cluster are upgraded according to an upgradability (loss of service) check.
ProxyInfo	object	Optional. Proxy server information for upgrade behind proxy.
URL	string	URL of the proxy server. Pattern: "http://:".
Username	string	Username for the proxy server.
Password	string	Password for the proxy server.

POST /api/v2/cluster/upgrade

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/cluster/upgrade' \ --data '{  "InstallPkgUri": "{string}",  "UUIDs": [    "{array[string]...}"  ],  "ProxyInfo": {    "URL": "{string}",    "Username": "{string}",    "Password": "{string}"  }}'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid UUID or URI.

401

Unauthorized: authentication failed.

403

Permission denied.

404

One of the provided UUIDs is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Upgrade server.

Upgrades server given by UUID with a package pointed by URI. Since upgrading a server is a long operation, the status of the upgrade shall be fetched from server object

Auth

Path Params

UUID

string

UUID

The server's UUID for the upgrade server request.

Request Body application/json

object	object
UUID	string	The server's UUID for the upgrade server request.
InstallPkgUri	string	URI of Lightbits package to install.
ForceUpgrade	boolean	Optional. When true, bypasses the upgradability (loss of service) check.
ProxyInfo	object	Optional. Proxy server information for upgrade behind proxy.
URL	string	URL of the proxy server. Pattern: "http://:".
Username	string	Username for the proxy server.
Password	string	Password for the proxy server.

POST /api/v2/servers/{UUID}/upgrade

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/servers/%7BUUID%7D/upgrade' \ --data '{  "UUID": "{string}",  "InstallPkgUri": "{string}",  "ForceUpgrade": "{boolean}",  "ProxyInfo": {    "URL": "{string}",    "Username": "{string}",    "Password": "{string}"  }}'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid UUID or URI.

401

Unauthorized: authentication failed.

403

Permission denied.

404

UUID not found

409

There is a user operation in progress on the server.

412

Etag mismatch.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Cluster Configuration Features Operations

/api/v2/clusterConfig

/api/v2/clusterConfig/{configParam.name}

/api/v2/clusterConfig/{name}

/api/v2/featureFlags

/api/v2/featureFlags/{name}

/api/v2/featureFlags/{name}/disable

/api/v2/featureFlags/{name}/enable

List all cluster configuration parameters values.

Auth

GET /api/v2/clusterConfig

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/clusterConfig'
Copy

Responses application/json

200

A successful response.

object	object
values	array[object]
name	string	Specify the name of the parameter to update: ClusterName [name]/ ClockDriftIntervalForRaisingEvent [time]/ DeviceHealthIntervalForRaisingEvent [time]/ DurationToTurnIntoPermanentFailure [time]/ VolumeDeletionFromNodeDelay [time]/ DefaultQoSName [string]/ AllowedNumRevives [int] DisableVolumeStatisticsExport [bool]/ EnableTrim [bool]/ EvictionNoProgressTimeout [time]/ RevivesWindowDuration [time].
value	string	The value of the cluster config parameter, where the specific units are specific to the specified parameter.

400

Invalid argument.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "values": [  {   "name": "{string}",   "value": "{string}"  } ]}
Copy

Update Cluster Config value.

Auth

Path Params

configParam.name

string

ClusterConfigParam name

Specify the name of the parameter to update: ClusterName [name]/ ClockDriftIntervalForRaisingEvent [time]/ DeviceHealthIntervalForRaisingEvent [time]/ DurationToTurnIntoPermanentFailure [time]/ VolumeDeletionFromNodeDelay [time]/ DefaultQoSName [string]/ AllowedNumRevives [int] DisableVolumeStatisticsExport [bool]/ EnableTrim [bool]/ EvictionNoProgressTimeout [time]/ RevivesWindowDuration [time].

Request Body application/json

object	object
configParam	object	Cluster config parameter name and value to update.
name	string	Specify the name of the parameter to update: ClusterName [name]/ ClockDriftIntervalForRaisingEvent [time]/ DeviceHealthIntervalForRaisingEvent [time]/ DurationToTurnIntoPermanentFailure [time]/ VolumeDeletionFromNodeDelay [time]/ DefaultQoSName [string]/ AllowedNumRevives [int] DisableVolumeStatisticsExport [bool]/ EnableTrim [bool]/ EvictionNoProgressTimeout [time]/ RevivesWindowDuration [time].
value	string	The value of the cluster config parameter, where the specific units are specific to the specified parameter.

PUT /api/v2/clusterConfig/{configParam.name}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/clusterConfig/%7BconfigParam.name%7D' \ --data '{  "configParam": {    "name": "{string}",    "value": "{string}"  }}'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid argument.

404

Cluster configuration parameter was not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Get a specific cluster configuration parameter's value.

Auth

Path Params

name

string

name

specify name of parameter to get: ClusterName/ ClockDriftIntervalForRaisingEvent/ DeviceHealthIntervalForRaisingEvent/ DurationToTurnIntoPermanentFailure/ VolumeDeletionFromNodeDelay/ DefaultQoSName/ AllowedNumRevives/ DisableVolumeStatisticsExport EnableTrim/ EvictionNoProgressTimeout/ RevivesWindowDuration

GET /api/v2/clusterConfig/{name}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/clusterConfig/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object	object
name	string	Specify the name of the parameter to update: ClusterName [name]/ ClockDriftIntervalForRaisingEvent [time]/ DeviceHealthIntervalForRaisingEvent [time]/ DurationToTurnIntoPermanentFailure [time]/ VolumeDeletionFromNodeDelay [time]/ DefaultQoSName [string]/ AllowedNumRevives [int] DisableVolumeStatisticsExport [bool]/ EnableTrim [bool]/ EvictionNoProgressTimeout [time]/ RevivesWindowDuration [time].
value	string	The value of the cluster config parameter, where the specific units are specific to the specified parameter.

400

Invalid argument.

404

Cluster configuration parameter was not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "name": "{string}", "value": "{string}"}
Copy

List feature flags.

Auth

GET /api/v2/featureFlags

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/featureFlags'
Copy

Responses application/json

200

A successful response.

object	object
featureFlags	object
*	object
name	string
enabled	boolean

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "featureFlags": {}}
Copy

Get feature flag status.

Get feature flag status enable/disable corresponding to the given feature flag name.

Auth

Path Params

name

string

name

The name of the feature flag to get: "event-log", "evict-data", "fail-in-place", "in-band-authentication", "proactive-rebalance".

GET /api/v2/featureFlags/{name}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/featureFlags/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object	object
name	string
enabled	boolean

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "name": "{string}", "enabled": "{boolean}"}
Copy

Disable feature flag.

Disable feature flag status corresponding to the given feature flag name.

Auth

Path Params

name

string

name

The name of the feature flag to disable: "event-log", "evict-data", "fail-in-place", "in-band-authentication", "proactive-rebalance".

Request Body application/json

object	object
name	string	The name of the feature flag to disable: "event-log", "evict-data", "fail-in-place", "in-band-authentication", "proactive-rebalance".

POST /api/v2/featureFlags/{name}/disable

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/featureFlags/%7Bname%7D/disable' \ --data '{  "name": "{string}"}'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

501

Unimplemented capability.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Enable feature flag.

Enable feature flag status corresponding to the given feature flag name.

Auth

Path Params

name

string

name

The name of the feature flag to enable: "event-log", "evict-data", "fail-in-place", "in-band-authentication", "proactive-rebalance".

Request Body application/json

object	object
name	string	The name of the feature flag to enable: "event-log", "evict-data", "fail-in-place", "in-band-authentication", "proactive-rebalance".

POST /api/v2/featureFlags/{name}/enable

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/featureFlags/%7Bname%7D/enable' \ --data '{  "name": "{string}"}'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Host Operations

/api/v2/connectedHosts

/api/v2/connectedHosts/{hostNQN}

Get a list of connected hosts.

List all hosts connected to a cluster, or only connected hosts associated with a volume.

Auth

Query String

hostNQN	string	hostNQN. Not supported (hostNQN filtering parameter is ignored and all connected hosts will be returned).
volumeUUID	string	hostNQN. Optionally filter hosts associated with a specific volume (the default operation will return all hosts connected to the cluster).

GET /api/v2/connectedHosts

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/connectedHosts' \ --data hostNQN={hostNQN} \ --data volumeUUID={volumeUUID}
Copy

Responses application/json

200

A successful response.

object	object
connectedHosts	array[object]
hostNQN	string	Host's NVMe qualified name (NQN).
iPAddress	string	Host's IP addresses.
hostname	string	Host's name.
volumeUUIDs	array[string]	list of volumes to which this host connects to.

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

xxxxxxxxxx
 
{ "connectedHosts": [  {   "hostNQN": "{string}",   "iPAddress": "{string}",   "hostname": "{string}",   "volumeUUIDs": [    "{array[string]...}"   ]  } ]}
Copy

Get connected host information.

Get connected host information given by hostNQN.

Auth

Path Params

hostNQN

string

hostNQN

Host NQN to get.

GET /api/v2/connectedHosts/{hostNQN}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/connectedHosts/%7BhostNQN%7D'
Copy

Responses application/json

200

A successful response.

object	object
hostNQN	string	Host's NVMe qualified name (NQN).
iPAddress	string	Host's IP addresses.
hostname	string	Host's name.
volumeUUIDs	array[string]	list of volumes to which this host connects to.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Provided host NQN is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "hostNQN": "{string}", "iPAddress": "{string}", "hostname": "{string}", "volumeUUIDs": [  "{array[string]...}" ]}
Copy

Node Operations

/api/v2/nodes

/api/v2/nodes/{SrcNodeUUID}/replace

/api/v2/nvmeDevices/{Serial}

/api/v2/nodes/{UUID}

Get list of nodes.

List Nodes. An option to filter is done by the following parameters: 1. Name - e.g., api/v2/nodes?Name= 2. UUID - e.g., api/v2/nodes?UUID= 3. FailureDomain - e.g., api/v2/nodes?FailureDomain=

Auth

Query String

name	string	Name. Filter nodes by node name (either no filter, or only name, UUID, or failureDomain should be specified).
UUID	string	Name. Filter nodes by node name (either no filter, or only name, UUID, or failureDomain should be specified).
failureDomain	string	failureDomain. Filter nodes by a failure domain associated with nodes (either no filter, or only name, UUID, or failureDomain should be specified).

GET /api/v2/nodes

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/nodes' \ --data name={name} \ --data UUID={UUID} \ --data failureDomain={failureDomain}
Copy

Responses application/json

200

A successful response.

object	object
nodes	array[object]
name	string
UUID	string
state	string	Reserved value. Default should return an error, rather than a true state that is incorrect. Active: 1 Node is completed join cluster flow. Activating: 2 Node is is the process of coming up (starting required services) and joining cluster. Inactive: 3 Node is is Inactive (this includes internal states Removing and failed). Unattached: 4 Node is not attached to cluster (none of the cluster pgs contain this pg). Attaching: 6 Attaching a node to the cluster ongoing (replacing old node in pgs with this node). Detaching: 7 Detaching a node from the cluster ongoing (replacing this node in pgs with this a new node). Enum: `Unknown`,`Active`,`Activating`,`Inactive`,`Unattached`,`Attaching`,`Detaching` Default: Unknown
status	string	Machine-readable internal state of the node we want to report to the cluster. ConnectivityOK: reported during NodeStateEnum==Adding IssuedDeletePeer: reported during NodeStateEnum==Removing Enum: `NoStatus`,`ConnectivityOK`,`ConnectivityProblem`,`IssuedDeletePeer` Default: NoStatus
nvmeEndpoint	string
failureDomains	array[string]
failureInfo	string
hostname	string
inLocalRebuild	boolean
localRebuildProgress	int64
numManagedDevices	int32
maxNvmeDevices	int64
ec	boolean
statistics	object
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.
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.
GarbageCollectorDataIntegrityErrors	string	Number of data integrity errors that were detected by the GC.
metadataUtilization	number	Metadata RAM utilization, shown as: used/available
serverUUID	string
ETag	string	identifier for a specific version of a resource
readOnly	boolean
powerupProgress	int64
permanentFailure	boolean

Expand

400

Invalid argument, or several mutually exclusive arguments are provided.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "nodes": [  {   "name": "{string}",   "UUID": "{string}",   "state": "{string}",   "status": "{string}",   "nvmeEndpoint": "{string}",   "failureDomains": [    "{array[string]...}"   ],   "failureInfo": "{string}",   "hostname": "{string}",   "inLocalRebuild": "{boolean}",   "localRebuildProgress": "{int64}",   "numManagedDevices": "{int32}",   "maxNvmeDevices": "{int64}",   "ec": "{boolean}",   "statistics": {    "managedPhysicalStorage": "{string}",    "effectivePhysicalStorage": "{string}",    "logicalStorage": "{string}",    "logicalUsedStorage": "{string}",    "physicalUsedStorage": "{string}",    "physicalUsedStorageIncludingParity": "{string}",    "freePhysicalStorage": "{string}",    "estimatedFreeLogicalStorage": "{string}",    "estimatedLogicalStorage": "{string}",    "compressionRatio": "{number}",    "UnrecoverableDataIntegrityErrors": "{int64}",    "RecoverableDataIntegrityErrors": "{int64}",    "GarbageCollectorDataIntegrityErrors": "{string}",    "metadataUtilization": "{number}"   },   "serverUUID": "{string}",   "ETag": "{string}",   "readOnly": "{boolean}",   "powerupProgress": "{int64}",   "permanentFailure": "{boolean}"  } ]}
Copy

Replace Node.

The request is identified by the UUID of the replaced node (referred to as SrcNodeUUID). The required parameters in the body are:

TargetNodeUUID - the UUID of the target node that replaces the src Node. The command will succeed only if srcNode is Inactive, and targetNode is Unattached. Users should disable the server of the srcNode (that will make the node Inactive), and assure that targetNode is Unattached (possibly as a new node without assigned PGs or by replacing its PG to another node).

Auth

Path Params

SrcNodeUUID

string

SrcNodeUUID

The source node's UUID for the replace node request.

Request Body application/json

object	object
SrcNodeUUID	string	The source node's UUID for the replace node request.
TargetNodeUUID	string	The target node's UUID for the replace node request.
ReplaceWhileActive	boolean	Optional. When true, the replace node operation will be performed while the server is active. Default is False.

POST /api/v2/nodes/{SrcNodeUUID}/replace

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/nodes/%7BSrcNodeUUID%7D/replace' \ --data '{  "SrcNodeUUID": "{string}",  "TargetNodeUUID": "{string}",  "ReplaceWhileActive": "{boolean}"}'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid argument provided. Source and target nodes are not in the correct states.

401

Unauthorized: authentication failed.

403

Permission denied.

404

One of the provided UUIDs is not found.

409

There is a user operation in progress on one of the nodes.

412

Etag mismatch.

429

Too many commands in progress.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Get node information.

Get node information identified by the UUID of the node.

Auth

Path Params

UUID

string

UUID

ID of node to get.

GET /api/v2/nodes/{UUID}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/nodes/%7BUUID%7D'
Copy

Responses application/json

200

A successful response.

object	object
name	string
UUID	string
state	string	Reserved value. Default should return an error, rather than a true state that is incorrect. Active: 1 Node is completed join cluster flow. Activating: 2 Node is is the process of coming up (starting required services) and joining cluster. Inactive: 3 Node is is Inactive (this includes internal states Removing and failed). Unattached: 4 Node is not attached to cluster (none of the cluster pgs contain this pg). Attaching: 6 Attaching a node to the cluster ongoing (replacing old node in pgs with this node). Detaching: 7 Detaching a node from the cluster ongoing (replacing this node in pgs with this a new node). Enum: `Unknown`,`Active`,`Activating`,`Inactive`,`Unattached`,`Attaching`,`Detaching` Default: Unknown
status	string	Machine-readable internal state of the node we want to report to the cluster. ConnectivityOK: reported during NodeStateEnum==Adding IssuedDeletePeer: reported during NodeStateEnum==Removing Enum: `NoStatus`,`ConnectivityOK`,`ConnectivityProblem`,`IssuedDeletePeer` Default: NoStatus
nvmeEndpoint	string
failureDomains	array[string]
failureInfo	string
hostname	string
inLocalRebuild	boolean
localRebuildProgress	int64
numManagedDevices	int32
maxNvmeDevices	int64
ec	boolean
statistics	object
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.
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.
GarbageCollectorDataIntegrityErrors	string	Number of data integrity errors that were detected by the GC.
metadataUtilization	number	Metadata RAM utilization, shown as: used/available
serverUUID	string
ETag	string	identifier for a specific version of a resource
readOnly	boolean
powerupProgress	int64
permanentFailure	boolean

Expand

401

Unauthorized: authentication failed.

403

Permission denied.

404

Node UUID is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "name": "{string}", "UUID": "{string}", "state": "{string}", "status": "{string}", "nvmeEndpoint": "{string}", "failureDomains": [  "{array[string]...}" ], "failureInfo": "{string}", "hostname": "{string}", "inLocalRebuild": "{boolean}", "localRebuildProgress": "{int64}", "numManagedDevices": "{int32}", "maxNvmeDevices": "{int64}", "ec": "{boolean}", "statistics": {  "managedPhysicalStorage": "{string}",  "effectivePhysicalStorage": "{string}",  "logicalStorage": "{string}",  "logicalUsedStorage": "{string}",  "physicalUsedStorage": "{string}",  "physicalUsedStorageIncludingParity": "{string}",  "freePhysicalStorage": "{string}",  "estimatedFreeLogicalStorage": "{string}",  "estimatedLogicalStorage": "{string}",  "compressionRatio": "{number}",  "UnrecoverableDataIntegrityErrors": "{int64}",  "RecoverableDataIntegrityErrors": "{int64}",  "GarbageCollectorDataIntegrityErrors": "{string}",  "metadataUtilization": "{number}" }, "serverUUID": "{string}", "ETag": "{string}", "readOnly": "{boolean}", "powerupProgress": "{int64}", "permanentFailure": "{boolean}"}
Copy

Nv Me Device Operations

/api/v2/nvmeDevices/{serialNumber}

Retrieve a list of NVMe devices, with optional filtering selections.

A request to list NVMe devices is exposed via this API. The list of NVMe devices can be filtered by the following parameters: 1. ServerUUID - e.g., api/v2/nvmeDevices?ServerUUID= 2. NodeUUID - e.g., api/v2/nvmeDevices?NodeUUID=.

Auth

Query String

nodeUUID	string	nodeUUID. Optionally, list all NVMe devices managed by a specified node.
serverUUID	string	serverUUID. Optionally, list all NVMe devices attached to a specified server.

GET /api/v2/nvmeDevices

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/nvmeDevices' \ --data nodeUUID={nodeUUID} \ --data serverUUID={serverUUID}
Copy

Responses application/json

200

A successful response.

object	object
NvmeDevices	array[object]
size	string	Total capacity of the device in bytes.
numaNodeID	string	The NUMA node ID this device is associated with.
model	string	Model string of the device, if exists.
serial	string	Serial of the block device, if exists.
serverUUID	string	The UUID of the server to which the block device is installed.
state	string	Describes the state of the device. Unmanaged device state will be None. Enum: `None`,`Healthy`,`Adding`,`Rebuilding`,`Failed` Default: None
failureTime	date-time	Timestamp that will be updated in case the device has failed.
rebuildCompletionTime	date-time	Timestamp that will be updated once GFTL has completed to rebuild all the data that the device had, and we are safe for second failure.
name	string	Device name or address.
nodeUUID	string	The UUID of the node that manages the device. Empty string if the device is not managed.
ETag	string	identifier for a specific version of a resource.
statistics	object	Various nvme-device related statistics.
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.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "NvmeDevices": [  {   "size": "{string}",   "numaNodeID": "{string}",   "model": "{string}",   "serial": "{string}",   "serverUUID": "{string}",   "state": "{string}",   "failureTime": "{date-time}",   "rebuildCompletionTime": "{date-time}",   "name": "{string}",   "nodeUUID": "{string}",   "ETag": "{string}",   "statistics": {    "UnrecoverableDataIntegrityErrors": "{int64}",    "RecoverableDataIntegrityErrors": "{int64}"   }  } ]}
Copy

Add NVMe device to a node.

Add NVMe device identified by its serial number to a node identified by its UUID. If the NVMe device is already used by another node, or cannot be attached to the node, the command fails.

Auth

Request Body application/json

object	object
serialNumber	string	NVMe device serial number.
nodeUUID	string	UUID of node to add the NVMe device to.

POST /api/v2/nvmeDevices

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/nvmeDevices' \ --data '{  "serialNumber": "{string}",  "nodeUUID": "{string}"}'
Copy

Responses application/json

200

A successful response.

object object

400

Empty serial or empty node UUID is provided, the device is already attached to another node, the number of node's managed devices reached the maximum, the node is not listed as the server's node for the server that device belongs to, or the node is not active.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Serial or node UUID not found.

409

There is a user operation in progress on the device

412

Etag mismatch.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Retrieve a specific NVMe device with a filtering option.

Request NVMe device information according to it's serial number. Example usage: api/v2/nvmeDevices/15eb21c0-35ae-478d-b.

Auth

Path Params

Serial

string

Serial

Serial number of the NVMe device to get.

GET /api/v2/nvmeDevices/{Serial}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/nvmeDevices/%7BSerial%7D'
Copy

Responses application/json

200

A successful response.

object	object
size	string	Total capacity of the device in bytes.
numaNodeID	string	The NUMA node ID this device is associated with.
model	string	Model string of the device, if exists.
serial	string	Serial of the block device, if exists.
serverUUID	string	The UUID of the server to which the block device is installed.
state	string	Describes the state of the device. Unmanaged device state will be None. Enum: `None`,`Healthy`,`Adding`,`Rebuilding`,`Failed` Default: None
failureTime	date-time	Timestamp that will be updated in case the device has failed.
rebuildCompletionTime	date-time	Timestamp that will be updated once GFTL has completed to rebuild all the data that the device had, and we are safe for second failure.
name	string	Device name or address.
nodeUUID	string	The UUID of the node that manages the device. Empty string if the device is not managed.
ETag	string	identifier for a specific version of a resource.
statistics	object	Various nvme-device related statistics.
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.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Serial is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "size": "{string}", "numaNodeID": "{string}", "model": "{string}", "serial": "{string}", "serverUUID": "{string}", "state": "{string}", "failureTime": "{date-time}", "rebuildCompletionTime": "{date-time}", "name": "{string}", "nodeUUID": "{string}", "ETag": "{string}", "statistics": {  "UnrecoverableDataIntegrityErrors": "{int64}",  "RecoverableDataIntegrityErrors": "{int64}" }}
Copy

Update NVMe device on a node.

Update NVMe device defined by serial number on a server defined by server UUID.

Auth

Path Params

serialNumber

string

serialNumber

NVMe device serial number.

Request Body application/json

object	object
serverUUID	string	Server UUID of the NVMe device to update.
serialNumber	string	NVMe device serial number.
ledPattern	string	NVMe device LED pattern. specify either "locate", "rebuild" or "locate-off"

POST /api/v2/nvmeDevices/{serialNumber}

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/nvmeDevices/%7BserialNumber%7D' \ --data '{  "serverUUID": "{string}",  "serialNumber": "{string}",  "ledPattern": "{string}"}'
Copy

Responses application/json

200

A successful response.

object object

400

Empty serial or empty server UUID is provided, the device is already attached to another node, the number of node's managed devices reached the maximum, node is not listed as server's node for the server that the device belongs to, or node is not active.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Serial or server UUID not found.

409

There is a user operation in progress on the device.

412

Etag mismatch.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Policy Operations

/api/v2/policies/{UUID}

/api/v2/policies/{UUID}

/api/v2/policies/{UUID}

/api/v2/projects/{projectName}/resourcePolicies

/api/v2/projects/{projectName}/resourcePolicies

/api/v2/projects/{projectName}/resourcePolicies/{UUID}

/api/v2/projects/{projectName}/resourcePolicies/{UUID}

/api/v2/projects/{projectName}/resourcePolicies/{UUID}

List policies.

A request to list policies. The result can be filtered by either name or UUID.

Auth

Query String

UUID	string	UUID. Optionally filter specific policy by UUID.
name	string	name. Optionally filter specific policy by name.
projectName	string	projectName. Optionally filter policies by project name.

GET /api/v2/policies

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

Responses application/json

200

A successful response.

object	object
policies	array[object]
UUID	string
name	string
description	string
state	string	Enum: `Unknown`,`Creating`,`Active`,`Updating`,`Deprecated`,`Failed` Default: Unknown
QoSRateLimitPolicy	object
projectsNamesScope	array[string]	Lists the projects that have access to this policy (relevant if policyVisibility=Scoped)
policyVisibility	string	Policy Visibility, specifics who has access to this policy Enum: `Unavailable`,`Scoped`,`Global` Default: Unavailable
limitIOPS	object	A limit of 0 means no rate limit. Bandwidth limit is in units of MB/s.
writeIOPSLimit	int64	Volume write bandwidth limits, specified in units of IOPs. The granularity increases by 256 IOPs each time. 0 means unlimited.
readIOPSLimit	int64	Volume read bandwidth limits, specified in units of IOPs. The granularity increases by 256 IOPs each time. 0 means unlimited.
limitBw	object
writeBWLimit	int64	Volume write bandwidth limits, specified in units of MB/s. The granularity must be in full MB/s. 0 means unlimited.
readBWLimit	int64	Volume read bandwidth limits, specified in units of MB/s. The granularity must be in full MB/s. 0 means unlimited.
limitIOPSPerGB	object
writeIOPSPerGBLimit	int64	Volume write bandwidth limits, specified in units of IOPs per GB of volume size. 0 means unlimited.
readIOPSPerGBLimit	int64	Volume read bandwidth limits, specified in units of IOPs per GB of volume size. 0 means unlimited.

Expand

400

Invalid argument.

404

Returned when the policy UUID/name is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "policies": [  {   "UUID": "{string}",   "name": "{string}",   "description": "{string}",   "state": "{string}",   "QoSRateLimitPolicy": {    "projectsNamesScope": [     "{array[string]...}"    ],    "policyVisibility": "{string}",    "limitIOPS": {     "writeIOPSLimit": "{int64}",     "readIOPSLimit": "{int64}"    },    "limitBw": {     "writeBWLimit": "{int64}",     "readBWLimit": "{int64}"    },    "limitIOPSPerGB": {     "writeIOPSPerGBLimit": "{int64}",     "readIOPSPerGBLimit": "{int64}"    }   }  } ]}
Copy

Create a policy.

A policy is a set of user-defined rules that should be applied to one or more objects in the system.

Auth

Request Body application/json

object	object
name	string	Policy name
description	string	Policy description, up to 256B in length
qoSRateLimitPolicy	object
projectsNamesScope	array[string]	Lists the projects that have access to this policy (relevant if policyVisibility=Scoped)
policyVisibility	string	Policy Visibility, specifics who has access to this policy Enum: `Unavailable`,`Scoped`,`Global` Default: Unavailable
limitIOPS	object	A limit of 0 means no rate limit. Bandwidth limit is in units of MB/s.
writeIOPSLimit	int64	Volume write bandwidth limits, specified in units of IOPs. The granularity increases by 256 IOPs each time. 0 means unlimited.
readIOPSLimit	int64	Volume read bandwidth limits, specified in units of IOPs. The granularity increases by 256 IOPs each time. 0 means unlimited.
limitBw	object
writeBWLimit	int64	Volume write bandwidth limits, specified in units of MB/s. The granularity must be in full MB/s. 0 means unlimited.
readBWLimit	int64	Volume read bandwidth limits, specified in units of MB/s. The granularity must be in full MB/s. 0 means unlimited.
limitIOPSPerGB	object
writeIOPSPerGBLimit	int64	Volume write bandwidth limits, specified in units of IOPs per GB of volume size. 0 means unlimited.
readIOPSPerGBLimit	int64	Volume read bandwidth limits, specified in units of IOPs per GB of volume size. 0 means unlimited.

POST /api/v2/policies

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/policies' \ --data '{  "name": "{string}",  "description": "{string}",  "qoSRateLimitPolicy": {    "projectsNamesScope": [      "{array[string]...}"    ],    "policyVisibility": "{string}",    "limitIOPS": {      "writeIOPSLimit": "{int64}",      "readIOPSLimit": "{int64}"    },    "limitBw": {      "writeBWLimit": "{int64}",      "readBWLimit": "{int64}"    },    "limitIOPSPerGB": {      "writeIOPSPerGBLimit": "{int64}",      "readIOPSPerGBLimit": "{int64}"    }  }}'
Copy

Responses application/json

200

A successful response.

object	object
UUID	string
name	string
description	string
state	string	Enum: `Unknown`,`Creating`,`Active`,`Updating`,`Deprecated`,`Failed` Default: Unknown
QoSRateLimitPolicy	object
projectsNamesScope	array[string]	Lists the projects that have access to this policy (relevant if policyVisibility=Scoped)
policyVisibility	string	Policy Visibility, specifics who has access to this policy Enum: `Unavailable`,`Scoped`,`Global` Default: Unavailable
limitIOPS	object	A limit of 0 means no rate limit. Bandwidth limit is in units of MB/s.
writeIOPSLimit	int64	Volume write bandwidth limits, specified in units of IOPs. The granularity increases by 256 IOPs each time. 0 means unlimited.
readIOPSLimit	int64	Volume read bandwidth limits, specified in units of IOPs. The granularity increases by 256 IOPs each time. 0 means unlimited.
limitBw	object
writeBWLimit	int64	Volume write bandwidth limits, specified in units of MB/s. The granularity must be in full MB/s. 0 means unlimited.
readBWLimit	int64	Volume read bandwidth limits, specified in units of MB/s. The granularity must be in full MB/s. 0 means unlimited.
limitIOPSPerGB	object
writeIOPSPerGBLimit	int64	Volume write bandwidth limits, specified in units of IOPs per GB of volume size. 0 means unlimited.
readIOPSPerGBLimit	int64	Volume read bandwidth limits, specified in units of IOPs per GB of volume size. 0 means unlimited.

Expand

400

Provided invalid argument with one of the following reasons: mandatory argument is missing, invalid argument is provided name contains illegal characters.

404

One of the given projects was not found.

409

Policy with the provided name already exists.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "name": "{string}", "description": "{string}", "state": "{string}", "QoSRateLimitPolicy": {  "projectsNamesScope": [   "{array[string]...}"  ],  "policyVisibility": "{string}",  "limitIOPS": {   "writeIOPSLimit": "{int64}",   "readIOPSLimit": "{int64}"  },  "limitBw": {   "writeBWLimit": "{int64}",   "readBWLimit": "{int64}"  },  "limitIOPSPerGB": {   "writeIOPSPerGBLimit": "{int64}",   "readIOPSPerGBLimit": "{int64}"  } }}
Copy

Get policy.

A request to get policy by either name or UUID.

Auth

Path Params

UUID

string

UUID

UUID of the policy to get (specify either UUID or name)

Query String

name	string	name. name of the policy to get (specify either UUID or name)
projectName	string	projectName. The name of the project this policy belongs to

GET /api/v2/policies/{UUID}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/policies/%7BUUID%7D' \ --data name={name} \ --data projectName={projectName}
Copy

Responses application/json

200

A successful response.

object	object
UUID	string
name	string
description	string
state	string	Enum: `Unknown`,`Creating`,`Active`,`Updating`,`Deprecated`,`Failed` Default: Unknown
QoSRateLimitPolicy	object
projectsNamesScope	array[string]	Lists the projects that have access to this policy (relevant if policyVisibility=Scoped)
policyVisibility	string	Policy Visibility, specifics who has access to this policy Enum: `Unavailable`,`Scoped`,`Global` Default: Unavailable
limitIOPS	object	A limit of 0 means no rate limit. Bandwidth limit is in units of MB/s.
writeIOPSLimit	int64	Volume write bandwidth limits, specified in units of IOPs. The granularity increases by 256 IOPs each time. 0 means unlimited.
readIOPSLimit	int64	Volume read bandwidth limits, specified in units of IOPs. The granularity increases by 256 IOPs each time. 0 means unlimited.
limitBw	object
writeBWLimit	int64	Volume write bandwidth limits, specified in units of MB/s. The granularity must be in full MB/s. 0 means unlimited.
readBWLimit	int64	Volume read bandwidth limits, specified in units of MB/s. The granularity must be in full MB/s. 0 means unlimited.
limitIOPSPerGB	object
writeIOPSPerGBLimit	int64	Volume write bandwidth limits, specified in units of IOPs per GB of volume size. 0 means unlimited.
readIOPSPerGBLimit	int64	Volume read bandwidth limits, specified in units of IOPs per GB of volume size. 0 means unlimited.

Expand

400

Invalid argument.

404

Returned when the policy UUID/name is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "name": "{string}", "description": "{string}", "state": "{string}", "QoSRateLimitPolicy": {  "projectsNamesScope": [   "{array[string]...}"  ],  "policyVisibility": "{string}",  "limitIOPS": {   "writeIOPSLimit": "{int64}",   "readIOPSLimit": "{int64}"  },  "limitBw": {   "writeBWLimit": "{int64}",   "readBWLimit": "{int64}"  },  "limitIOPSPerGB": {   "writeIOPSPerGBLimit": "{int64}",   "readIOPSPerGBLimit": "{int64}"  } }}
Copy

Delete policy.

Delete policy information by provided policy UUID.

Auth

Path Params

UUID

string

UUID

UUID of the policy to delete (specify either UUID or name).

Query String

name

string

name. name of the policy to delete (specify either UUID or name).

DELETE /api/v2/policies/{UUID}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/policies/%7BUUID%7D' \ --data name={name}
Copy

Responses application/json

200

A successful response.

object object

400

Invalid argument.

404

The given policy to delete was not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Update a policy.

Updates user pre-defined policy by overriding the existing properties with the given arguments.

Auth

Path Params

UUID

string

UUID

The UUID of the policy request to update. If both name and UUID are provided, the name is ignored.

Request Body application/json

object	object
UUID	string	The UUID of the policy request to update. If both name and UUID are provided, the name is ignored.
name	string	The name of the policy request to update. If both name and UUID are provided, the name is ignored.
description	string	A short (up to 256B) description for this resource.
qoSRateLimitPolicy	object
projectsNamesScope	array[string]	Lists the projects that have access to this policy (relevant if policyVisibility=Scoped)
policyVisibility	string	Policy Visibility, specifics who has access to this policy Enum: `Unavailable`,`Scoped`,`Global` Default: Unavailable
limitIOPS	object	A limit of 0 means no rate limit. Bandwidth limit is in units of MB/s.
writeIOPSLimit	int64	Volume write bandwidth limits, specified in units of IOPs. The granularity increases by 256 IOPs each time. 0 means unlimited.
readIOPSLimit	int64	Volume read bandwidth limits, specified in units of IOPs. The granularity increases by 256 IOPs each time. 0 means unlimited.
limitBw	object
writeBWLimit	int64	Volume write bandwidth limits, specified in units of MB/s. The granularity must be in full MB/s. 0 means unlimited.
readBWLimit	int64	Volume read bandwidth limits, specified in units of MB/s. The granularity must be in full MB/s. 0 means unlimited.
limitIOPSPerGB	object
writeIOPSPerGBLimit	int64	Volume write bandwidth limits, specified in units of IOPs per GB of volume size. 0 means unlimited.
readIOPSPerGBLimit	int64	Volume read bandwidth limits, specified in units of IOPs per GB of volume size. 0 means unlimited.

Expand

PUT /api/v2/policies/{UUID}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/policies/%7BUUID%7D' \ --data '{  "UUID": "{string}",  "name": "{string}",  "description": "{string}",  "qoSRateLimitPolicy": {    "projectsNamesScope": [      "{array[string]...}"    ],    "policyVisibility": "{string}",    "limitIOPS": {      "writeIOPSLimit": "{int64}",      "readIOPSLimit": "{int64}"    },    "limitBw": {      "writeBWLimit": "{int64}",      "readBWLimit": "{int64}"    },    "limitIOPSPerGB": {      "writeIOPSPerGBLimit": "{int64}",      "readIOPSPerGBLimit": "{int64}"    }  }}'
Copy

Responses application/json

200

A successful response.

object object

400

Provided invalid argument(s) with one of the following reasons: mandatory argument is missing, mutually exclusive arguments were provided invalid argument is provided.

404

The given policy was not found or the request is not supported.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

List resource policies.

A request to list resource policies. The result can be filtered by either name or UUID.

Auth

Path Params

projectName

string

projectName

Optionally filter policies by project name.

Query String

UUID	string	UUID. Optionally filter specific policy by UUID.
volumeUUID	string	volumeUUID. Optionally filter all policies of a specific volume.

GET /api/v2/projects/{projectName}/resourcePolicies

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/resourcePolicies' \ --data UUID={UUID} \ --data volumeUUID={volumeUUID}
Copy

Responses application/json

200

A successful response.

object	object
resourcePolicies	array[object]
UUID	string
name	string
resourceUUID	string
resourceName	string
projectName	string
schedulePolicy	object
snapshotSchedulePolicy	object
hourlySchedule	object
startTime	date-time
hoursInCycle	int64
dailySchedule	object
startTime	date-time
daysInCycle	int64
weeklySchedule	object
daysOfWeek	array[object]
startTime	date-time
day	string	Enum: `DayOfWeekUnspecified`,`Sunday`,`Monday`,`Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday` Default: DayOfWeekUnspecified
retentionTime	string
description	string
state	string	Enum: `UnknownState`,`Creating`,`Active`,`Deleting`,`Failed` Default: UnknownState
defaultResourcePolicies	array[object]
policyType	string	For internal use only snapshot: Snapshot Create snapshots per volumes policy qosRateLimit: QosRateLimit Volumes QoS rate limit policy Enum: `unknown`,`snapshot`,`qosRateLimit` Default: unknown
policyUUID	string

Expand

400

Invalid argument.

404

Returned when the resource policy UUID/name is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "resourcePolicies": [  {   "UUID": "{string}",   "name": "{string}",   "resourceUUID": "{string}",   "resourceName": "{string}",   "projectName": "{string}",   "schedulePolicy": {    "snapshotSchedulePolicy": {     "hourlySchedule": {      "startTime": "{date-time}",      "hoursInCycle": "{int64}"     },     "dailySchedule": {      "startTime": "{date-time}",      "daysInCycle": "{int64}"     },     "weeklySchedule": {      "daysOfWeek": [       {        "startTime": "{date-time}",        "day": "{string}"       }      ]     }    },    "retentionTime": "{string}"   },   "description": "{string}",   "state": "{string}"  } ], "defaultResourcePolicies": [  {   "policyType": "{string}",   "policyUUID": "{string}"  } ]}
Copy

Create a resource policy.

A resource policy.

Auth

Path Params

projectName

string

projectName

The project this resource policy belongs to.

Request Body application/json

object	object
name	string	The name of the resource policy.
resourceUUID	string	The resource UUID. If both name and UUID are provided, the name is ignored and only the UUID is used.
resourceName	string	The resource name. If both name and UUID are provided, the name is ignored and only the UUID is used.
projectName	string	The project this resource policy belongs to.
schedulePolicy	object	The schedule policy for this resource policy.
snapshotSchedulePolicy	object
hourlySchedule	object
startTime	date-time
hoursInCycle	int64
dailySchedule	object
startTime	date-time
daysInCycle	int64
weeklySchedule	object
daysOfWeek	array[object]
startTime	date-time
day	string	Enum: `DayOfWeekUnspecified`,`Sunday`,`Monday`,`Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday` Default: DayOfWeekUnspecified
retentionTime	string
description	string	A short (up to 256B) description for this resource.

POST /api/v2/projects/{projectName}/resourcePolicies

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/resourcePolicies' \ --data '{  "name": "{string}",  "resourceUUID": "{string}",  "resourceName": "{string}",  "projectName": "{string}",  "schedulePolicy": {    "snapshotSchedulePolicy": {      "hourlySchedule": {        "startTime": "{date-time}",        "hoursInCycle": "{int64}"      },      "dailySchedule": {        "startTime": "{date-time}",        "daysInCycle": "{int64}"      },      "weeklySchedule": {        "daysOfWeek": [          {            "startTime": "{date-time}",            "day": "{string}"          }        ]      }    },    "retentionTime": "{string}"  },  "description": "{string}"}'
Copy

Responses application/json

200

A successful response.

object	object
UUID	string
name	string
resourceUUID	string
resourceName	string
projectName	string
schedulePolicy	object
snapshotSchedulePolicy	object
hourlySchedule	object
startTime	date-time
hoursInCycle	int64
dailySchedule	object
startTime	date-time
daysInCycle	int64
weeklySchedule	object
daysOfWeek	array[object]
startTime	date-time
day	string	Enum: `DayOfWeekUnspecified`,`Sunday`,`Monday`,`Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday` Default: DayOfWeekUnspecified
retentionTime	string
description	string
state	string	Enum: `UnknownState`,`Creating`,`Active`,`Deleting`,`Failed` Default: UnknownState

400

Provided invalid argument with one of the following reasons: mandatory argument is missing, name contains illegal characters.

404

Returned when the resource policy with a given resource UUID is not found.

409

Resource with the provided name already exists.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "name": "{string}", "resourceUUID": "{string}", "resourceName": "{string}", "projectName": "{string}", "schedulePolicy": {  "snapshotSchedulePolicy": {   "hourlySchedule": {    "startTime": "{date-time}",    "hoursInCycle": "{int64}"   },   "dailySchedule": {    "startTime": "{date-time}",    "daysInCycle": "{int64}"   },   "weeklySchedule": {    "daysOfWeek": [     {      "startTime": "{date-time}",      "day": "{string}"     }    ]   }  },  "retentionTime": "{string}" }, "description": "{string}", "state": "{string}"}
Copy

Get resource policy.

Get resource policy information by provided UUID/name

Auth

Path Params

projectName

string

projectName

The name of the project this resource policy belongs to.

UUID

string

UUID

The UUID of the resource policy to get.

GET /api/v2/projects/{projectName}/resourcePolicies/{UUID}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/resourcePolicies/%7BUUID%7D'
Copy

Responses application/json

200

A successful response.

object	object
UUID	string
name	string
resourceUUID	string
resourceName	string
projectName	string
schedulePolicy	object
snapshotSchedulePolicy	object
hourlySchedule	object
startTime	date-time
hoursInCycle	int64
dailySchedule	object
startTime	date-time
daysInCycle	int64
weeklySchedule	object
daysOfWeek	array[object]
startTime	date-time
day	string	Enum: `DayOfWeekUnspecified`,`Sunday`,`Monday`,`Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday` Default: DayOfWeekUnspecified
retentionTime	string
description	string
state	string	Enum: `UnknownState`,`Creating`,`Active`,`Deleting`,`Failed` Default: UnknownState

400

Invalid argument.

404

Returned when the resource policy UUID/name is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "name": "{string}", "resourceUUID": "{string}", "resourceName": "{string}", "projectName": "{string}", "schedulePolicy": {  "snapshotSchedulePolicy": {   "hourlySchedule": {    "startTime": "{date-time}",    "hoursInCycle": "{int64}"   },   "dailySchedule": {    "startTime": "{date-time}",    "daysInCycle": "{int64}"   },   "weeklySchedule": {    "daysOfWeek": [     {      "startTime": "{date-time}",      "day": "{string}"     }    ]   }  },  "retentionTime": "{string}" }, "description": "{string}", "state": "{string}"}
Copy

Delete resource policy.

Delete resource policy information by provided UUID/name.

Auth

Path Params

projectName

string

projectName

The name of the project this resource policy belongs to.

UUID

string

UUID

The UUID of the resource policy to get.

DELETE /api/v2/projects/{projectName}/resourcePolicies/{UUID}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/resourcePolicies/%7BUUID%7D'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid argument.

404

Returned when the resource policy UUID/name is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Update a resource policy.

Update resource policy enable the change of the following attributes: retentionTime schedulePolicy description

Auth

Path Params

projectName

string

projectName

The name of the project this resource policy request belongs to.

UUID

string

UUID

The UUID of the resource policy request to update.

Request Body application/json

object	object
UUID	string	The UUID of the resource policy request to update.
projectName	string	The name of the project this resource policy request belongs to.
schedulePolicy	object	The updated schedule policy.
snapshotSchedulePolicy	object
hourlySchedule	object
startTime	date-time
hoursInCycle	int64
dailySchedule	object
startTime	date-time
daysInCycle	int64
weeklySchedule	object
daysOfWeek	array[object]
startTime	date-time
day	string	Enum: `DayOfWeekUnspecified`,`Sunday`,`Monday`,`Tuesday`,`Wednesday`,`Thursday`,`Friday`,`Saturday` Default: DayOfWeekUnspecified
retentionTime	string
description	string	An updated short (up to 256B) description.

PUT /api/v2/projects/{projectName}/resourcePolicies/{UUID}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/resourcePolicies/%7BUUID%7D' \ --data '{  "UUID": "{string}",  "projectName": "{string}",  "schedulePolicy": {    "snapshotSchedulePolicy": {      "hourlySchedule": {        "startTime": "{date-time}",        "hoursInCycle": "{int64}"      },      "dailySchedule": {        "startTime": "{date-time}",        "daysInCycle": "{int64}"      },      "weeklySchedule": {        "daysOfWeek": [          {            "startTime": "{date-time}",            "day": "{string}"          }        ]      }    },    "retentionTime": "{string}"  },  "description": "{string}"}'
Copy

Responses application/json

200

A successful response.

object object

400

Provided invalid argument with one of the following reasons: mandatory argument is missing, name contains illegal characters, invalid argument value.

404

Returned when the resource policy UUID/name is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Project Operations

/api/v2/projects/{name}

/api/v2/projects/{name}

/api/v2/projects/{projectName}

List projects.

list all projects.

Auth

GET /api/v2/projects

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects'
Copy

Responses application/json

200

A successful response.

object	object
projects	array[object]
UUID	string	Project UUID.
name	string	Project Name.
description	string	Brief description of project.
defaultPolicies	array[object]	List of default polices specified for this project.
policyType	string	Policy Type. Available types are 'QoS' or 'Snapshot'. Enum: `unknown`,`snapshot`,`qosRateLimit` Default: unknown
policyUUID	string	Policy UUID

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "projects": [  {   "UUID": "{string}",   "name": "{string}",   "description": "{string}",   "defaultPolicies": [    {     "policyType": "{string}",     "policyUUID": "{string}"    }   ]  } ]}
Copy

Create project.

A project has a name, a description, and a default QOS rate limit policy.

Auth

Request Body application/json

object	object
name	string	Project Name
description	string	Brief (up to 256B) description of the project.
defaultPolicies	array[object]	List of default polices. Such as default QoS policy.
policyType	string	Policy Type. Available types are 'QoS' or 'Snapshot'. Enum: `unknown`,`snapshot`,`qosRateLimit` Default: unknown
policyUUID	string	Policy UUID

POST /api/v2/projects

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/projects' \ --data '{  "name": "{string}",  "description": "{string}",  "defaultPolicies": [    {      "policyType": "{string}",      "policyUUID": "{string}"    }  ]}'
Copy

Responses application/json

200

A successful response.

object	object
UUID	string	Project UUID.
name	string	Project Name.
description	string	Brief description of project.
defaultPolicies	array[object]	List of default polices specified for this project.
policyType	string	Policy Type. Available types are 'QoS' or 'Snapshot'. Enum: `unknown`,`snapshot`,`qosRateLimit` Default: unknown
policyUUID	string	Policy UUID

400

Provided invalid argument with one of the following reasons: mandatory argument is missing, name contains illegal characters.

401

Unauthorized: authentication failed.

403

Permission denied.

409

Resource with the provided name already exists.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "name": "{string}", "description": "{string}", "defaultPolicies": [  {   "policyType": "{string}",   "policyUUID": "{string}"  } ]}
Copy

Get project.

Get project by name

Auth

Path Params

name

string

name

project name.

GET /api/v2/projects/{name}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object	object
UUID	string	Project UUID.
name	string	Project Name.
description	string	Brief description of project.
defaultPolicies	array[object]	List of default polices specified for this project.
policyType	string	Policy Type. Available types are 'QoS' or 'Snapshot'. Enum: `unknown`,`snapshot`,`qosRateLimit` Default: unknown
policyUUID	string	Policy UUID

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Provided project name is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "UUID": "{string}", "name": "{string}", "description": "{string}", "defaultPolicies": [  {   "policyType": "{string}",   "policyUUID": "{string}"  } ]}
Copy

Delete project.

Deletes project with provided name.

Auth

Path Params

name

string

name

project name

DELETE /api/v2/projects/{name}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object object

400

Provided invalid name or the project is not allowed to be deleted.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Project with provided name is not found.

412

Etag mismatch.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Update Project Default Policy.

Update project's default resource policy.

Auth

Path Params

projectName

string

projectName

The name of the project to update.

Request Body application/json

object	object
projectName	string	The name of the project to update.
defaultPolicies	array[object]	The updated default policies to apply to the project.
policyType	string	Policy Type. Available types are 'QoS' or 'Snapshot'. Enum: `unknown`,`snapshot`,`qosRateLimit` Default: unknown
policyUUID	string	Policy UUID

PUT /api/v2/projects/{projectName}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D' \ --data '{  "projectName": "{string}",  "defaultPolicies": [    {      "policyType": "{string}",      "policyUUID": "{string}"    }  ]}'
Copy

Responses application/json

200

A successful response.

object object

400

Mandatory argument is missing.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Access Control Operations

/api/v2/projects/{projectName}/credentials

/api/v2/projects/{projectName}/credentials

/api/v2/projects/{projectName}/credentials/{ID}

/api/v2/projects/{projectName}/credentials/{ID}

/api/v2/projects/{projectName}/roles

/api/v2/projects/{projectName}/roles/{name}

List credentials.

Auth

Path Params

projectName

string

projectName

Project name associated with credentials.

GET /api/v2/projects/{projectName}/credentials

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/credentials'
Copy

Responses application/json

200

A successful response.

object	object
credentials	array[object]
projectName	string
ID	string
type	string	Enum: `UnknownType`,`RS256PubKey`,`TlsCertChainPem`,`TlsPrivKeyPem` Default: UnknownType
payload	string
kind	string	CredsKind specifies the origin and intended usage of the credentials. Enum: `UserCreds`,`BeaconCreds`,`UnknownKind` Default: UserCreds

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "credentials": [  {   "projectName": "{string}",   "ID": "{string}",   "type": "{string}",   "payload": "{string}",   "kind": "{string}"  } ]}
Copy

Create credential.

A credential has a name and description.

Auth

Path Params

projectName

string

projectName

Project name.

Request Body application/json

object	object
projectName	string	Project name.
ID	string	Credential ID.
type	string	Type of the credentials, one of: pki rsa256pubkey cert-chain. Enum: `UnknownType`,`RS256PubKey`,`TlsCertChainPem`,`TlsPrivKeyPem` Default: UnknownType
payload	string	Payload of the credentials.

POST /api/v2/projects/{projectName}/credentials

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/credentials' \ --data '{  "projectName": "{string}",  "ID": "{string}",  "type": "{string}",  "payload": "{string}"}'
Copy

Responses application/json

200

A successful response.

object	object
projectName	string
ID	string
type	string	Enum: `UnknownType`,`RS256PubKey`,`TlsCertChainPem`,`TlsPrivKeyPem` Default: UnknownType
payload	string
kind	string	CredsKind specifies the origin and intended usage of the credentials. Enum: `UserCreds`,`BeaconCreds`,`UnknownKind` Default: UserCreds

400

Provided invalid argument with one of the following reasons: 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 is invalid.

401

Unauthorized: authentication failed.

403

Permission denied.

409

Resource with the provided name already exists.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "projectName": "{string}", "ID": "{string}", "type": "{string}", "payload": "{string}", "kind": "{string}"}
Copy

Get credential.

Get credential by ID.

Auth

Path Params

projectName

string

projectName

Project name.

string

Credential ID.

GET /api/v2/projects/{projectName}/credentials/{ID}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/credentials/%7BID%7D'
Copy

Responses application/json

200

A successful response.

object	object
projectName	string
ID	string
type	string	Enum: `UnknownType`,`RS256PubKey`,`TlsCertChainPem`,`TlsPrivKeyPem` Default: UnknownType
payload	string
kind	string	CredsKind specifies the origin and intended usage of the credentials. Enum: `UserCreds`,`BeaconCreds`,`UnknownKind` Default: UserCreds

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Provided credential ID is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "projectName": "{string}", "ID": "{string}", "type": "{string}", "payload": "{string}", "kind": "{string}"}
Copy

Delete credential.

Deletes credential with provided ID.

Auth

Path Params

projectName

string

projectName

Project name.

string

Credential ID.

DELETE /api/v2/projects/{projectName}/credentials/{ID}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/credentials/%7BID%7D'
Copy

Responses application/json

200

A successful response.

object object

400

Provided invalid name or the credential is not allowed to be deleted.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Credential with provided ID is not found.

412

Etag mismatch.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

List all roles defined in a project.

List roles

Auth

Path Params

projectName

string

projectName

The name of the project to list roles for.

GET /api/v2/projects/{projectName}/roles

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/roles'
Copy

Responses application/json

200

A successful response.

object	object
roles	array[object]
name	string
projectName	string
rulesJson	string	A JSON representation of the role 'rules' array, e.g.: [{"resources":["versions"],"actions":["get"]}]

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "roles": [  {   "name": "{string}",   "projectName": "{string}",   "rulesJson": "{string}"  } ]}
Copy

Get role.

Get role by name.

Auth

Path Params

projectName

string

projectName

The name of the project this role belongs to.

name

string

name

The name of the role to get.

GET /api/v2/projects/{projectName}/roles/{name}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/roles/%7Bname%7D'
Copy

Responses application/json

200

A successful response.

object	object
role	object
name	string
projectName	string
rulesJson	string	A JSON representation of the role 'rules' array, e.g.: [{"resources":["versions"],"actions":["get"]}]

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Provided role name is not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "role": {  "name": "{string}",  "projectName": "{string}",  "rulesJson": "{string}" }}
Copy

Snapshot Operations

/api/v2/projects/{projectName}/snapshots

/api/v2/projects/{projectName}/snapshots

/api/v2/projects/{projectName}/snapshots/diff/{snapshotUUID}

/api/v2/projects/{projectName}/snapshots/{UUID}

/api/v2/projects/{projectName}/snapshots/{UUID}

List snapshots.

List can be filtered by UUID/Name.

Auth

Path Params

projectName

string

projectName

The name of the project this snapshot belongs to.

Query String

UUID	string	UUID. Optionally filter a specific snapshot by UUID.
Name	string	Name. Optionally filter a specific snapshot by name.
offsetUUID	string	offsetUUID. Optional. When provided, returned list starts with next to offsetUUID volume.
limit	string	limit. Optional. Limits the number of snapshots in the response (default/max is 1000 snapshots in a response).
showAll	boolean	showAll. Optional. Show also snapshots in Deleting state (the default is false).

GET /api/v2/projects/{projectName}/snapshots

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/snapshots' \ --data UUID={UUID} \ --data Name={Name} \ --data offsetUUID={offsetUUID} \ --data limit={limit} \ --data showAll={showAll}
Copy

Responses application/json

200

A successful response.

object	object
snapshots	array[object]
state	string	Enum: `Unknown`,`Creating`,`Available`,`Deleting`,`Deleted`,`Failed` Default: Unknown
UUID	string
name	string
description	string
creationTime	date-time
retentionTime	string
sourceVolumeUUID	string
sourceVolumeName	string
replicaCount	int64
nodeList	array[string]
nsid	int64
acl	object
values	array[string]
compression	boolean
size	string
IPAcl	object
values	array[string]
sectorSize	int64
statistics	object
physicalCapacity	string	The physical capacity that exists in this volume layer.
physicalOwnedCapacity	string	The capacity that would be freed when the snapshot would be deleted.
physicalOwnedMemory	string	The number, in bytes, of md ranges multiplied by the size of md range.
physicalMemory	string	Memory used by this MSVV (how many chunks).
userWritten	string	Amount, in bytes of data, requested to be written by the user.
ETag	string
projectName	string
primaryNodeUUID	string
labels	array[object]	Once a snapshot is taken, the volume's labels are copied to the snapshot. Once a clone is created, if the user does not pass new labels on clone creation, the cloned volume labels are copied from the source snapshot labels.
key	string
value	string

Expand

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "snapshots": [  {   "state": "{string}",   "UUID": "{string}",   "name": "{string}",   "description": "{string}",   "creationTime": "{date-time}",   "retentionTime": "{string}",   "sourceVolumeUUID": "{string}",   "sourceVolumeName": "{string}",   "replicaCount": "{int64}",   "nodeList": [    "{array[string]...}"   ],   "nsid": "{int64}",   "acl": {    "values": [     "{array[string]...}"    ]   },   "compression": "{boolean}",   "size": "{string}",   "IPAcl": {    "values": [     "{array[string]...}"    ]   },   "sectorSize": "{int64}",   "statistics": {    "physicalCapacity": "{string}",    "physicalOwnedCapacity": "{string}",    "physicalOwnedMemory": "{string}",    "physicalMemory": "{string}",    "userWritten": "{string}"   },   "ETag": "{string}",   "projectName": "{string}",   "primaryNodeUUID": "{string}",   "labels": [    {     "key": "{string}",     "value": "{string}"    }   ]  } ]}
Copy

Create snapshot.

Create a snapshot from a volume.

Auth

Path Params

projectName

string

projectName

The name of the project this snapshot belongs to

Request Body application/json

object	object
name	string	The name of the snapshot
sourceVolumeUUID	string	The UUID of the volume to create the snapshot from. You should specify either the UUID or the name. If both UUID and name are specified, the UUID takes precedence.
sourceVolumeName	string	The name of the volume to create the snapshot from. You should specify either the UUID or the name. If both UUID and name are specified, the UUID takes precedence.
retentionTime	string	The length of time in seconds to retain this snapshot for.
description	string	A short description (up to 256B) of the snapshot.
projectName	string	The name of the project this snapshot belongs to

POST /api/v2/projects/{projectName}/snapshots

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/snapshots' \ --data '{  "name": "{string}",  "sourceVolumeUUID": "{string}",  "sourceVolumeName": "{string}",  "retentionTime": "{string}",  "description": "{string}",  "projectName": "{string}"}'
Copy

Responses application/json

200

A successful response.

object	object
state	string	Enum: `Unknown`,`Creating`,`Available`,`Deleting`,`Deleted`,`Failed` Default: Unknown
UUID	string
name	string
description	string
creationTime	date-time
retentionTime	string
sourceVolumeUUID	string
sourceVolumeName	string
replicaCount	int64
nodeList	array[string]
nsid	int64
acl	object
values	array[string]
compression	boolean
size	string
IPAcl	object
values	array[string]
sectorSize	int64
statistics	object
physicalCapacity	string	The physical capacity that exists in this volume layer.
physicalOwnedCapacity	string	The capacity that would be freed when the snapshot would be deleted.
physicalOwnedMemory	string	The number, in bytes, of md ranges multiplied by the size of md range.
physicalMemory	string	Memory used by this MSVV (how many chunks).
userWritten	string	Amount, in bytes of data, requested to be written by the user.
ETag	string
projectName	string
primaryNodeUUID	string
labels	array[object]	Once a snapshot is taken, the volume's labels are copied to the snapshot. Once a clone is created, if the user does not pass new labels on clone creation, the cloned volume labels are copied from the source snapshot labels.
key	string
value	string

Expand

400

Provided invalid argument with one of the following reasons: mandatory argument is missing, name contains illegal characters.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Returned when the snapshot with the given source-volume UUID is not found.

409

Resource with the provided name already exists.

500

Internal Lightbits error.

501

Unimplemented capability (updating capacity).

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "state": "{string}", "UUID": "{string}", "name": "{string}", "description": "{string}", "creationTime": "{date-time}", "retentionTime": "{string}", "sourceVolumeUUID": "{string}", "sourceVolumeName": "{string}", "replicaCount": "{int64}", "nodeList": [  "{array[string]...}" ], "nsid": "{int64}", "acl": {  "values": [   "{array[string]...}"  ] }, "compression": "{boolean}", "size": "{string}", "IPAcl": {  "values": [   "{array[string]...}"  ] }, "sectorSize": "{int64}", "statistics": {  "physicalCapacity": "{string}",  "physicalOwnedCapacity": "{string}",  "physicalOwnedMemory": "{string}",  "physicalMemory": "{string}",  "userWritten": "{string}" }, "ETag": "{string}", "projectName": "{string}", "primaryNodeUUID": "{string}", "labels": [  {   "key": "{string}",   "value": "{string}"  } ]}
Copy

List changed LBAs between a volume's snapshots.

List changed LBAs between a volume's snapshots (optionally list all snapshots LBAs).

Auth

Path Params

projectName

string

projectName

Project name

snapshotUUID

string

snapshotUUID

Target snapshot UUID for comparison (specify either snapshotUUID or snapshotName).

Query String

baseSnapshotUUID	string	baseSnapshotUUID. Source snapshot UUID for comparison. Optional in case of full comparison (specify either baseSnapshotUUID or baseSnapshotName).
offsetLBA	string	offsetLBA. The first offset from which the comparison shall start, aligned to 64 and rounded down.
snapshotName	string	snapshotName. Target snapshot name for comparison (specify either snapshotUUID or snapshotName).
baseSnapshotName	string	baseSnapshotName. Source snapshot name for comparison. Optional in case of full comparison (specify either baseSnapshotUUID or baseSnapshotName).

GET /api/v2/projects/{projectName}/snapshots/diff/{snapshotUUID}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/snapshots/diff/%7BsnapshotUUID%7D' \ --data baseSnapshotUUID={baseSnapshotUUID} \ --data offsetLBA={offsetLBA} \ --data snapshotName={snapshotName} \ --data baseSnapshotName={baseSnapshotName}
Copy

Responses application/json

200

A successful response.

object	object
nextOffsetLBA	string	LBA Offset for next call, zero at the last call (when end of LBA range has been reached).
lbaRanges	array[object]	List of ranges of the target snapshot UUID that differs from the base snapshot UUID.
lbaStart	string
lbaEnd	string
dataBitMap	string

400

Invalid arguments. Snapshot UUIDs are identical or they are no on same chain or offset-lba exceeds snapshot size.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Failed to find snapshot UUID or base snapshot UUID or project name.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "nextOffsetLBA": "{string}", "lbaRanges": [  {   "lbaStart": "{string}",   "lbaEnd": "{string}",   "dataBitMap": "{string}"  } ]}
Copy

Get snapshot.

Get snapshot by UUID/Name.

Auth

Path Params

projectName

string

projectName

The name of the project this snapshot belongs to.

UUID

string

UUID

The UUID of the snapshot to get (either UUID or Name must be specified).

Query String

Name

string

Name. The name of the snapshot to get (either UUID or Name must be specified).

GET /api/v2/projects/{projectName}/snapshots/{UUID}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/snapshots/%7BUUID%7D' \ --data Name={Name}
Copy

Responses application/json

200

A successful response.

object	object
state	string	Enum: `Unknown`,`Creating`,`Available`,`Deleting`,`Deleted`,`Failed` Default: Unknown
UUID	string
name	string
description	string
creationTime	date-time
retentionTime	string
sourceVolumeUUID	string
sourceVolumeName	string
replicaCount	int64
nodeList	array[string]
nsid	int64
acl	object
values	array[string]
compression	boolean
size	string
IPAcl	object
values	array[string]
sectorSize	int64
statistics	object
physicalCapacity	string	The physical capacity that exists in this volume layer.
physicalOwnedCapacity	string	The capacity that would be freed when the snapshot would be deleted.
physicalOwnedMemory	string	The number, in bytes, of md ranges multiplied by the size of md range.
physicalMemory	string	Memory used by this MSVV (how many chunks).
userWritten	string	Amount, in bytes of data, requested to be written by the user.
ETag	string
projectName	string
primaryNodeUUID	string
labels	array[object]	Once a snapshot is taken, the volume's labels are copied to the snapshot. Once a clone is created, if the user does not pass new labels on clone creation, the cloned volume labels are copied from the source snapshot labels.
key	string
value	string

Expand

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Snapshot with UUID/Name not found.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "state": "{string}", "UUID": "{string}", "name": "{string}", "description": "{string}", "creationTime": "{date-time}", "retentionTime": "{string}", "sourceVolumeUUID": "{string}", "sourceVolumeName": "{string}", "replicaCount": "{int64}", "nodeList": [  "{array[string]...}" ], "nsid": "{int64}", "acl": {  "values": [   "{array[string]...}"  ] }, "compression": "{boolean}", "size": "{string}", "IPAcl": {  "values": [   "{array[string]...}"  ] }, "sectorSize": "{int64}", "statistics": {  "physicalCapacity": "{string}",  "physicalOwnedCapacity": "{string}",  "physicalOwnedMemory": "{string}",  "physicalMemory": "{string}",  "userWritten": "{string}" }, "ETag": "{string}", "projectName": "{string}", "primaryNodeUUID": "{string}", "labels": [  {   "key": "{string}",   "value": "{string}"  } ]}
Copy

Delete snapshot.

Deletes snapshot with provided UUID. Deletion of a snapshot is a long operation. The status of deletion can be queried with a GET operation on the snapshot. As long as the operation runs, the snapshot state is Deleting. When the operation has completed, GET snapshot will return a NotFound error response.

Auth

Path Params

projectName

string

projectName

The name of the project this snapshot belongs to.

UUID

string

UUID

The UUID of the snapshot to delete (specify either UUID or Name).

Query String

name

string

name. The name of the snapshot to delete (specify either UUID or Name).

DELETE /api/v2/projects/{projectName}/snapshots/{UUID}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/snapshots/%7BUUID%7D' \ --data name={name}
Copy

Responses application/json

200

A successful response.

object object

400

Provided invalid UUID or a snapshot state does not allow deletion (Deleting/Failed).

404

Snapshot with provided UUID is not found.

409

There is a user operation in progress on the snapshot

412

Etag mismatch.

500

Internal Lightbits error.

503

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

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

Volume Operations

/api/v2/projects/{projectName}/volumes

/api/v2/projects/{projectName}/volumes

/api/v2/projects/{projectName}/volumes/{UUID}

/api/v2/projects/{projectName}/volumes/{UUID}

/api/v2/projects/{projectName}/volumes/{UUID}

/api/v2/projects/{projectName}/volumes/{UUID}/rollback

/api/v2/volumes/{UUID}

/api/v2/volumes/{UUID}

/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

Path Params

projectName

string

projectName

Optional. Return only volumes of the given project.

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).
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/projects/{projectName}/volumes

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/volumes' \ --data UUID={UUID} \ --data name={name} \ --data failureDomain={failureDomain} \ --data offsetUUID={offsetUUID} \ --data limit={limit} \ --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 fd (failure domain). Value should specify the failure domains we want to match.
key	string	Enum: `Unknown`,`FD`,`PrimaryFD` 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 is resides.

Expand

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "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

Expand

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

Path Params

projectName

string

projectName

Name of the project the volume belongs to.

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 fd (failure domain). Value should specify the failure domains we want to match.
key	string	Enum: `Unknown`,`FD`,`PrimaryFD` 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

Expand

POST /api/v2/projects/{projectName}/volumes

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/volumes' \ --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 fd (failure domain). Value should specify the failure domains we want to match.
key	string	Enum: `Unknown`,`FD`,`PrimaryFD` 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 is resides.

Expand

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

xxxxxxxxxx
 
{ "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

Expand

Get volume information.

Get volume information by provided UUID

Auth

Path Params

projectName

string

projectName

Name of project volume belongs to.

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.

GET /api/v2/projects/{projectName}/volumes/{UUID}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/volumes/%7BUUID%7D' \ --data name={name}
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 fd (failure domain). Value should specify the failure domains we want to match.
key	string	Enum: `Unknown`,`FD`,`PrimaryFD` 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 is resides.

Expand

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

xxxxxxxxxx
 
{ "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

Expand

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

projectName

string

projectName

The project name of the volume to delete.

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).

DELETE /api/v2/projects/{projectName}/volumes/{UUID}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/volumes/%7BUUID%7D' \ --data name={name}
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

xxxxxxxxxx
 
{}
Copy

Update volume.

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

Auth

Path Params

projectName

string

project name

Name of the project the volume belongs to.

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 (.).

Expand

PUT /api/v2/projects/{projectName}/volumes/{UUID}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/volumes/%7BUUID%7D' \ --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

xxxxxxxxxx
 
{}
Copy

Roll back a volume to a previous snapshot.

Auth

Path Params

projectName

string

projectName

Project volume belongs to.

UUID

string

UUID

Volume UUID to rollback (specify either volume UUID or volume name).

Request Body application/json

object	object
UUID	string	Volume UUID to rollback (specify either volume UUID or volume name).
srcSnapshotUUID	string	Source snapshot UUID to rollback volume to (specify either snapshot UUID or volume name).
projectName	string	Project volume belongs to.
Name	string	Volume Name (specify either volume UUID or volume name).
srcSnapshotName	string	Source snapshot name to rollback volume to (specify either snapshot UUID or volume name).

PUT /api/v2/projects/{projectName}/volumes/{UUID}/rollback

xxxxxxxxxx
 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/projects/%7BprojectName%7D/volumes/%7BUUID%7D/rollback' \ --data '{  "UUID": "{string}",  "srcSnapshotUUID": "{string}",  "projectName": "{string}",  "Name": "{string}",  "srcSnapshotName": "{string}"}'
Copy

Responses application/json

200

A successful response.

object object

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

404

Volume or snapshot UUID not found.

500

Internal Lightbits error.

503

Cannot roll volume back. Volume is deleting.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{}
Copy

List volumes.

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

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/volumes' \ --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 fd (failure domain). Value should specify the failure domains we want to match.
key	string	Enum: `Unknown`,`FD`,`PrimaryFD` 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 is resides.

Expand

400

Invalid argument.

401

Unauthorized: authentication failed.

403

Permission denied.

500

Internal Lightbits error.

default

An unexpected error response.

Response

xxxxxxxxxx
 
{ "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

Expand

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 fd (failure domain). Value should specify the failure domains we want to match.
key	string	Enum: `Unknown`,`FD`,`PrimaryFD` 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

Expand

POST /api/v2/volumes

xxxxxxxxxx
 
curl --request POST \ --url 'https://documentation.lightbitslabs.com/api/v2/volumes' \ --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 fd (failure domain). Value should specify the failure domains we want to match.
key	string	Enum: `Unknown`,`FD`,`PrimaryFD` 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 is resides.

Expand

400

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

xxxxxxxxxx
 
{ "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

Expand

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}

xxxxxxxxxx
 
curl --get \ --url 'https://documentation.lightbitslabs.com/api/v2/volumes/%7BUUID%7D' \ --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 fd (failure domain). Value should specify the failure domains we want to match.
key	string	Enum: `Unknown`,`FD`,`PrimaryFD` 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 is resides.

Expand

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

xxxxxxxxxx
 
{ "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

Expand

Delete volume.

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}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://documentation.lightbitslabs.com/api/v2/volumes/%7BUUID%7D' \ --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

xxxxxxxxxx
 
{}
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 (.).

Expand

PUT /api/v2/volumes/{UUID}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://documentation.lightbitslabs.com/api/v2/volumes/%7BUUID%7D' \ --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

xxxxxxxxxx
 
{}
Copy

Server Operations

/api/v2/servers/{UUID}

/api/v2/servers/{UUID}

/api/v2/servers/{UUID}/disable