eEVOS HCI REST API Reference

Version 1.0.0 · Generated 2026-10-23 · 347 operations

Disclaimer: Use of this API is entirely at the user's own responsibility. API usage is not covered by support.

Getting started

Base URL: https://<server>:18443

Send X-API-Key: <API_KEY> with protected requests. Use a unique Idempotency-Key for retryable mutating requests. Retain the returned X-Correlation-ID for audits and troubleshooting.

Passwords, API keys, access keys, secret keys, tokens, and fencing credentials must use an application/json request body. Secret values in URLs are rejected.

Examples validate HTTPS certificates. For a private CA, add --cacert /path/to/ca.pem.

Product scope

Only operations supported by this product are included; storage and cluster features from other product families are intentionally omitted.

Operation summary

Method	Count
GET	137
POST	156
PUT	12
PATCH	2
DELETE	40

API — 53 operations
Ceph — 60 operations
Cluster — 54 operations
Hardware — 1 operations
NVMe Initiator — 5 operations
Networking — 14 operations
System — 1 operations
Users — 10 operations
Virtual Machines — 146 operations
iSCSI Initiator — 3 operations

API

GET `/api/docs`

Get /api/docs.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/docs'

Responses

Status	Meaning
200	Swagger UI
404	Documentation disabled

GET `/api/docs/openapi-json`

Get /api/docs/openapi-json.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/docs/openapi-json'

Responses

Status	Meaning
200	Swagger UI static asset

GET `/api/docs/swagger-ui-bundle.js`

Get /api/docs/swagger-ui-bundle.js.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/docs/swagger-ui-bundle.js'

Responses

Status	Meaning
200	Swagger UI static asset

GET `/api/docs/swagger-ui-standalone-preset.js`

Get /api/docs/swagger-ui-standalone-preset.js.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/docs/swagger-ui-standalone-preset.js'

Responses

Status	Meaning
200	Swagger UI static asset

GET `/api/docs/swagger-ui.css`

Get /api/docs/swagger-ui.css.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/docs/swagger-ui.css'

Responses

Status	Meaning
200	Swagger UI static asset

GET `/api/openapi.json`

Get /api/openapi.json.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/openapi.json'

Responses

Status	Meaning
200	OpenAPI 3.1 document
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/openapi.yaml`

Get /api/openapi.yaml.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/openapi.yaml'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/groups`

Delete /api/v1/groups.

Parameters

Parameter	Location	Required	Type	Description
`group_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/groups?group_name=example-group'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/groups`

Get /api/v1/groups.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/groups'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

PATCH `/api/v1/groups`

Patch /api/v1/groups.

Parameters

Parameter	Location	Required	Type	Description
`gid`	query	no	string	Request parameter.
`group_name`	query	yes	string	Request parameter.
`new_group_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X PATCH \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/groups?group_name=example-group'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/groups`

Post /api/v1/groups.

Parameters

Parameter	Location	Required	Type	Description
`gid`	query	no	string	Request parameter.
`group_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/groups?group_name=example-group'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/jobs`

Delete /api/v1/jobs.

Parameters

Parameter	Location	Required	Type	Description
`job_id`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/jobs?job_id=<job_id>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/jobs`

read the state and captured output of a long-running API operation.

Parameters

Parameter	Location	Required	Type	Description
`job_id`	query	no	string	Request parameter.
`limit`	query	no	string	Request parameter.
`status`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/jobs'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/mounts`

unmount and remove a remote SMB share definition.

Parameters

Parameter	Location	Required	Type	Description
`mount_folder`	query	no	string	Request parameter.
`server_name`	query	no	string	Request parameter.
`share_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/mounts'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/mounts`

list configured VM backup mount definitions.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/mounts'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/mounts`

mount a remote SMB share.

Parameters

Parameter	Location	Required	Type	Description
`domain_name`	query	no	string	Request parameter.
`ip_address`	query	yes	string (ipv4)	Request parameter.
`mount_folder`	query	yes	string	Request parameter.
`share_name`	query	yes	string	Request parameter.
`user_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`password`	JSON body	no	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/mounts?ip_address=192.0.2.10&mount_folder=<mount_folder>&share_name=example-share'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/mounts/backup-servers`

remove a configured VM backup mount definition.

Parameters

Parameter	Location	Required	Type	Description
`backup_server_folder`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/mounts/backup-servers?backup_server_folder=<backup_server_folder>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/mounts/backup-servers`

list configured backup-server mount definitions.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/mounts/backup-servers'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/mounts/s3-backups`

Parameters

Parameter	Location	Required	Type	Description
`access_id`	query	yes	string	Request parameter.
`bucket`	query	yes	string	Request parameter.
`endpoint`	query	yes	string	Request parameter.
`mount_folder`	query	yes	string	Request parameter.
`provider`	query	yes	string	Request parameter.
`region`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`access_key`	JSON body	yes	string	Request parameter.
`password`	JSON body	yes	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"access_key":"<access_key>","password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/mounts/s3-backups?access_id=<access_id>&bucket=<bucket>&endpoint=<endpoint>&mount_folder=<mount_folder>&provider=<provider>&region=<region>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/multi-cluster/license`

show the local cluster license and version information.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/multi-cluster/license'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/multi-cluster/partner-info`

query partner-cluster information for migration workflows.

Parameters

Parameter	Location	Required	Type	Description
`ip_address`	query	yes	string (ipv4)	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`password`	JSON body	yes	string	Request parameter.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Content-Type: application/json' \
  --data '{"password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/multi-cluster/partner-info?ip_address=192.0.2.10'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/multi-cluster/shared-iscsi-disk`

create a shared iSCSI-backed cluster disk resource.

Parameters

Parameter	Location	Required	Type	Description
`chap_user`	query	no	string	Request parameter.
`portal_ip`	query	yes	string (ipv4)	Request parameter.
`resource_name`	query	yes	string	Request parameter.
`target_name`	query	yes	string	FC target or backing-volume name, as required by the operation.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`password`	JSON body	no	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/multi-cluster/shared-iscsi-disk?portal_ip=<portal_ip>&resource_name=<resource_name>&target_name=example-target'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/multi-cluster/status`

show cluster node and cluster-service status.

Parameters

Parameter	Location	Required	Type	Description
`extended`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/multi-cluster/status'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/notifications`

Get /api/v1/notifications.

Parameters

Parameter	Location	Required	Type	Description
`view`	query	no	string	Optional alternate representation, such as discovered BMC data.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/notifications'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/notifications`

Post /api/v1/notifications.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/notifications'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

PUT `/api/v1/notifications`

Put /api/v1/notifications.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X PUT \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/notifications'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/product/capabilities`

Get /api/v1/product/capabilities.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/product/capabilities'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/rdma/devices`

list RDMA devices, ports, modes, and detected IP information.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/rdma/devices'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/rdma/nfs`

disable the persistent NFS over RDMA configuration.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/rdma/nfs'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/rdma/nfs`

report NFS over RDMA configuration, interface, port, and listener state.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/rdma/nfs'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/rdma/nfs`

enable persistent NFS over RDMA support.

Parameters

Parameter	Location	Required	Type	Description
`port`	query	no	integer; minimum 0	TCP port; NFS over RDMA defaults to 20049.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/rdma/nfs'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/rdma/recovery`

report RDMA failover recovery service state and its latest recovery activity.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/rdma/recovery'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/rdma/recovery`

install or repair and start the persistent RDMA failover recovery service.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/rdma/recovery'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/rdma/reset-port`

reset InfiniBand ports through the RDMA management backend.

Parameters

Parameter	Location	Required	Type	Description
`ip_address`	query	no	string (ipv4)	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/rdma/reset-port'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/rdma/software-roce`

enable or disable software RoCE on one network port.

Parameters

Parameter	Location	Required	Type	Description
`mode`	query	yes	string	Requested operating or access mode; accepted values depend on the endpoint.
`network_port`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/rdma/software-roce?mode=<mode>&network_port=<network_port>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/rdma/software-roce/enable-all`

enable all persistently configured software RoCE devices.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/rdma/software-roce/enable-all'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ssh-trust`

Post /api/v1/ssh-trust.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ssh-trust'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/storage/md`

Get /api/v1/storage/md.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/storage/md'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/storage/md`

Post /api/v1/storage/md.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/storage/md'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/sync/jobs`

Delete /api/v1/sync/jobs.

Parameters

Parameter	Location	Required	Type	Description
`job_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/sync/jobs'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/sync/jobs`

Get /api/v1/sync/jobs.

Parameters

Parameter	Location	Required	Type	Description
`job_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/sync/jobs'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/sync/jobs`

Post /api/v1/sync/jobs.

Parameters

Parameter	Location	Required	Type	Description
`job_name`	query	no	string	Request parameter.
`snapshot_replication`	query	no	string	Request parameter.
`source_share`	query	no	string	Request parameter.
`target_server`	query	no	string	Request parameter.
`target_share`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/sync/jobs'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/system/api-configuration`

Get /api/v1/system/api-configuration.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/system/api-configuration'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

PUT `/api/v1/system/api-configuration`

Put /api/v1/system/api-configuration.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X PUT \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/system/api-configuration'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/system/settings`

Post /api/v1/system/settings.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/system/settings'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ups`

query the configured UPS and return its current status values.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ups'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ups/snmp-devices`

scan and configure an SNMP UPS.

Parameters

Parameter	Location	Required	Type	Description
`ip_address`	query	yes	string (ipv4)	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ups/snmp-devices?ip_address=192.0.2.10'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ups/usb-devices`

scan for a USB UPS and write a new NUT configuration.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ups/usb-devices'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/volumes`

list available volumes.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/volumes'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/volumes`

create a mirror volume through the disk-management CLI.

Parameters

Parameter	Location	Required	Type	Description
`disk_path`	query	yes	string	Request parameter.
`drive_name`	query	yes	string	Request parameter.
`purpose`	query	yes	string	Storage purpose. Use S3 when creating an eEKAS object-storage drive.
`size`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/volumes?disk_path=<disk_path>&drive_name=<drive_name>&purpose=<purpose>&size=<size>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

`GET /api/v1/observability/health`

Get /api/v1/observability/health

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`GET /api/v1/observability/hosts`

Get /api/v1/observability/hosts

Parameter	Location	Required	Type	Description
`node`	query	no	string	Backend parameter `node`.
`range`	query	no	string	Backend parameter `range`.
`step`	query	no	string	Backend parameter `step`.
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`GET /api/v1/observability/storage`

Get /api/v1/observability/storage

Parameter	Location	Required	Type	Description
`backend`	query	no	string	Backend parameter `backend`.
`range`	query	no	string	Backend parameter `range`.
`step`	query	no	string	Backend parameter `step`.
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.
`osd`	query	no	integer	Backend parameter osd
`pool_id`	query	no	integer	Backend parameter pool_id

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

Ceph

DELETE `/api/v1/ceph-targets`

Delete /api/v1/ceph-targets.

Parameters

Parameter	Location	Required	Type	Description
`ip_group`	query	no	string	IP Group that supplies service addresses and an ordered, selectable subset of eligible gateway nodes. Multiple distributed addresses can balance SMB, NFS or S3 client connections when published under one DNS name.
`pool_name`	query	no	string	ZFS pool name.
`target_name`	query	no	string	FC target or backing-volume name, as required by the operation.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph-targets'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph-targets`

Get /api/v1/ceph-targets.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph-targets'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph-targets`

Post /api/v1/ceph-targets.

Parameters

Parameter	Location	Required	Type	Description
`device_path`	query	no	string	Request parameter.
`ip_group`	query	no	string	IP Group that supplies service addresses and an ordered, selectable subset of eligible gateway nodes. Multiple distributed addresses can balance SMB, NFS or S3 client connections when published under one DNS name.
`pool_name`	query	no	string	ZFS pool name.
`target_name`	query	no	string	FC target or backing-volume name, as required by the operation.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph-targets'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph-targets/activate`

Post /api/v1/ceph-targets/activate.

Parameters

Parameter	Location	Required	Type	Description
`ip_group`	query	no	string	IP Group that supplies service addresses and an ordered, selectable subset of eligible gateway nodes. Multiple distributed addresses can balance SMB, NFS or S3 client connections when published under one DNS name.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph-targets/activate'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph-targets/configs`

Post /api/v1/ceph-targets/configs.

Parameters

Parameter	Location	Required	Type	Description
`ip_group`	query	no	string	IP Group that supplies service addresses and an ordered, selectable subset of eligible gateway nodes. Multiple distributed addresses can balance SMB, NFS or S3 client connections when published under one DNS name.
`pool_name`	query	no	string	ZFS pool name.
`target_name`	query	no	string	FC target or backing-volume name, as required by the operation.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph-targets/configs'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph-targets/connections`

Get /api/v1/ceph-targets/connections.

Parameters

Parameter	Location	Required	Type	Description
`target_nqn`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph-targets/connections'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph-targets/deactivate`

Post /api/v1/ceph-targets/deactivate.

Parameters

Parameter	Location	Required	Type	Description
`ip_group`	query	no	string	IP Group that supplies service addresses and an ordered, selectable subset of eligible gateway nodes. Multiple distributed addresses can balance SMB, NFS or S3 client connections when published under one DNS name.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph-targets/deactivate'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph-targets/initiators`

Post /api/v1/ceph-targets/initiators.

Parameters

Parameter	Location	Required	Type	Description
`allowed_initiators`	query	no	string	Request parameter.
`ip_group`	query	no	string	IP Group that supplies service addresses and an ordered, selectable subset of eligible gateway nodes. Multiple distributed addresses can balance SMB, NFS or S3 client connections when published under one DNS name.
`pool_name`	query	no	string	ZFS pool name.
`target_name`	query	no	string	FC target or backing-volume name, as required by the operation.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph-targets/initiators'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph-targets/listeners`

Post /api/v1/ceph-targets/listeners.

Parameters

Parameter	Location	Required	Type	Description
`ip_address`	query	no	string (ipv4)	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph-targets/listeners'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph-targets/portals/reset`

Post /api/v1/ceph-targets/portals/reset.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph-targets/portals/reset'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph-targets/ports/activate`

Post /api/v1/ceph-targets/ports/activate.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph-targets/ports/activate'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph-targets/ports/manage`

Post /api/v1/ceph-targets/ports/manage.

Parameters

Parameter	Location	Required	Type	Description
`ip_address`	query	no	string (ipv4)	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph-targets/ports/manage'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph-targets/service/start`

Post /api/v1/ceph-targets/service/start.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph-targets/service/start'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph-targets/volumes`

Post /api/v1/ceph-targets/volumes.

Parameters

Parameter	Location	Required	Type	Description
`pool_name`	query	no	string	ZFS pool name.
`size`	query	no	string	Request parameter.
`target_name`	query	no	string	FC target or backing-volume name, as required by the operation.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph-targets/volumes'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage`

Get /api/v1/ceph/storage.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/ceph/storage-snapshots`

Delete /api/v1/ceph/storage-snapshots.

Parameters

Parameter	Location	Required	Type	Description
`pool_name`	query	no	string	ZFS pool name.
`resource_name`	query	no	string	Request parameter.
`snapshot_name`	query	no	string	Request parameter.
`type`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage-snapshots'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage-snapshots`

Get /api/v1/ceph/storage-snapshots.

Parameters

Parameter	Location	Required	Type	Description
`pool_name`	query	no	string	ZFS pool name.
`resource_name`	query	no	string	Request parameter.
`type`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage-snapshots'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph/storage-snapshots`

Post /api/v1/ceph/storage-snapshots.

Parameters

Parameter	Location	Required	Type	Description
`pool_name`	query	no	string	ZFS pool name.
`resource_name`	query	no	string	Request parameter.
`retention_days`	query	no	integer; minimum 0	Request parameter.
`type`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage-snapshots'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/ceph/storage-snapshots/expired`

Delete /api/v1/ceph/storage-snapshots/expired.

Parameters

Parameter	Location	Required	Type	Description
`pool_name`	query	no	string	ZFS pool name.
`type`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage-snapshots/expired'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage-snapshots/pools-and-volumes`

Get /api/v1/ceph/storage-snapshots/pools-and-volumes.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage-snapshots/pools-and-volumes'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph/storage-snapshots/rollback`

Post /api/v1/ceph/storage-snapshots/rollback.

Parameters

Parameter	Location	Required	Type	Description
`pool_name`	query	no	string	ZFS pool name.
`resource_name`	query	no	string	Request parameter.
`snapshot_name`	query	no	string	Request parameter.
`type`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage-snapshots/rollback'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph/storage-snapshots/schedules`

Post /api/v1/ceph/storage-snapshots/schedules.

Parameters

Parameter	Location	Required	Type	Description
`max_snapshots`	query	no	string	Request parameter.
`resources`	query	no	string	Request parameter.
`scheduleType`	query	no	string	Request parameter.
`startHour`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage-snapshots/schedules'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage-snapshots/summary`

Get /api/v1/ceph/storage-snapshots/summary.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage-snapshots/summary'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage/analyse-pgs`

Get /api/v1/ceph/storage/analyse-pgs.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage/analyse-pgs'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph/storage/cephfs/attach`

Post /api/v1/ceph/storage/cephfs/attach.

Parameters

Parameter	Location	Required	Type	Description
`fs_name`	query	no	string	Request parameter.
`mountpoint`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage/cephfs/attach'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/ceph/storage/cephfs/detach`

Delete /api/v1/ceph/storage/cephfs/detach.

Parameters

Parameter	Location	Required	Type	Description
`fs_name`	query	no	string	Request parameter.
`mountpoint`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage/cephfs/detach'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage/diagnostics`

Get /api/v1/ceph/storage/diagnostics.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage/diagnostics'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage/ec-calculator`

Get /api/v1/ceph/storage/ec-calculator.

Parameters

Parameter	Location	Required	Type	Description
`failure_domain`	query	no	string	Request parameter.
`usable_size`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage/ec-calculator'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage/health-status`

Get /api/v1/ceph/storage/health-status.

Parameters

Parameter	Location	Required	Type	Description
`format`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage/health-status'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage/io-performance`

Get /api/v1/ceph/storage/io-performance.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage/io-performance'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph/storage/legacy-osds/convert`

Post /api/v1/ceph/storage/legacy-osds/convert.

Deprecated: retained for compatibility.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage/legacy-osds/convert'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/ceph/storage/orphan-osd-services`

Delete /api/v1/ceph/storage/orphan-osd-services.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage/orphan-osd-services'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage/osd-drives`

Get /api/v1/ceph/storage/osd-drives.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage/osd-drives'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

`DELETE /api/v1/ceph/storage/osd-pool-members`

Delete /api/v1/ceph/storage/osd-pool-members

Parameter	Location	Required	Type	Description
`node_name`	query	no	string	Backend parameter `node_name`.
`osd_number`	query	no	string	Backend parameter `osd_number`.
`pool_name`	query	yes	string	Backend parameter `pool_name`.
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.
`Idempotency-Key`	header	no	string	Required for cluster membership changes; otherwise replays the cached response for an identical mutating request.

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`POST /api/v1/ceph/storage/osd-pool-members`

Post /api/v1/ceph/storage/osd-pool-members

Parameter	Location	Required	Type	Description
`pool_name`	query	yes	string	Backend parameter `pool_name`.
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.
`Idempotency-Key`	header	no	string	Required for cluster membership changes; otherwise replays the cached response for an identical mutating request.

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`DELETE /api/v1/ceph/storage/osd-pools`

Delete /api/v1/ceph/storage/osd-pools

Parameter	Location	Required	Type	Description
`pool_name`	query	yes	string	Backend parameter `pool_name`.
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.
`Idempotency-Key`	header	no	string	Required for cluster membership changes; otherwise replays the cached response for an identical mutating request.

Status	Meaning
202	Asynchronous operation accepted
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`POST /api/v1/ceph/storage/osd-pools`

Post /api/v1/ceph/storage/osd-pools

Parameter	Location	Required	Type	Description
`meta_drives`	query	no	string	Backend parameter meta_drives
`blockdb_drives`	query	no	string	Backend parameter blockdb_drives
`replicas`	query	no	integer	Backend parameter replicas
`min_size`	query	no	integer	Backend parameter min_size
`erasure_setting`	query	no	string	Backend parameter erasure_setting
`failure_domain`	query	no	string	Backend parameter failure_domain Values: host, rack
`pg_mode`	query	no	string	Backend parameter pg_mode
`pg_main`	query	no	integer	Backend parameter pg_main
`blockdb_size_mode`	query	no	string	Backend parameter blockdb_size_mode Values: auto, custom
`blockdb_size_gb`	query	no	integer	Backend parameter blockdb_size_gb
`domain_name`	query	no	string	Backend parameter domain_name
`port_number`	query	no	integer	Backend parameter port_number
`data_drives`	query	no	string	Backend parameter `data_drives`.
`ip_address`	query	no	string	Backend parameter `ip_address`.
`ip_group`	query	no	string	Backend parameter `ip_group`.
`pool_name`	query	yes	string	Backend parameter `pool_name`.
`purpose`	query	no	string	Backend parameter `purpose`.
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.
`Idempotency-Key`	header	no	string	Required for cluster membership changes; otherwise replays the cached response for an identical mutating request.

Status	Meaning
202	Asynchronous operation accepted
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

GET `/api/v1/ceph/storage/pg-per-pool`

Get /api/v1/ceph/storage/pg-per-pool.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage/pg-per-pool'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage/pool-status`

Get /api/v1/ceph/storage/pool-status.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage/pool-status'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage/rbd-drives`

Get /api/v1/ceph/storage/rbd-drives.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage/rbd-drives'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/ceph/storage/rbds`

Delete /api/v1/ceph/storage/rbds.

Parameters

Parameter	Location	Required	Type	Description
`pool_name`	query	no	string	ZFS pool name.
`rbd_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage/rbds'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph/storage/rbds`

Post /api/v1/ceph/storage/rbds.

Parameters

Parameter	Location	Required	Type	Description
`Size`	query	no	string	Request parameter.
`pool_name`	query	no	string	ZFS pool name.
`rbd_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage/rbds'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph/storage/rbds/clone`

Post /api/v1/ceph/storage/rbds/clone.

Parameters

Parameter	Location	Required	Type	Description
`clone_name`	query	no	string	Request parameter.
`new_name`	query	no	string	Request parameter.
`pool_name`	query	no	string	ZFS pool name.
`rbd_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage/rbds/clone'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph/storage/rbds/delete-all-vm`

Post /api/v1/ceph/storage/rbds/delete-all-vm.

Parameters

Parameter	Location	Required	Type	Description
`pool_name`	query	no	string	ZFS pool name.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage/rbds/delete-all-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph/storage/rbds/map`

Post /api/v1/ceph/storage/rbds/map.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage/rbds/map'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

`POST /api/v1/ceph/storage/repairs`

Post /api/v1/ceph/storage/repairs

Parameter	Location	Required	Type	Description
`action`	query	no	string	Backend parameter `action`.
`confirmed`	query	no	string	Backend parameter `confirmed`.
`issue_id`	query	no	string	Backend parameter `issue_id`.
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.
`Idempotency-Key`	header	no	string	Required for cluster membership changes; otherwise replays the cached response for an identical mutating request.

Status	Meaning
202	Asynchronous operation accepted
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

POST `/api/v1/ceph/storage/subvolumes/resize`

Post /api/v1/ceph/storage/subvolumes/resize.

Parameters

Parameter	Location	Required	Type	Description
`pool_name`	query	no	string	ZFS pool name.
`size`	query	no	string	Request parameter.
`volume_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage/subvolumes/resize'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/ceph/storage/topology-map`

Get /api/v1/ceph/storage/topology-map.

Parameters

Parameter	Location	Required	Type	Description
`format`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/ceph/storage/topology-map'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/ceph/storage/zfs-volumes`

Post /api/v1/ceph/storage/zfs-volumes.

Parameters

Parameter	Location	Required	Type	Description
`pool_name`	query	no	string	ZFS pool name.
`volume_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/storage/zfs-volumes'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

`GET /api/v1/ceph/placement`

Read monitor/manager placement or queue an update

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.

Status	Meaning
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed
200	Successful response
501	Product does not support this endpoint
502	Backend failed
503	Backend unavailable
504	Backend timed out

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`GET /api/v1/ceph/storage/blockdb`

Inspect one BlockDB device or reusable volume group on a registered node

Parameter	Location	Required	Type	Description
`node`	query	no	string	Request parameter node
`device`	query	no	string	Request parameter device
`vg`	query	no	string	Request parameter vg
`required_gb`	query	no	integer	Request parameter required_gb
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.

Status	Meaning
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed
200	Successful response
501	Product does not support this endpoint
502	Backend failed
503	Backend unavailable
504	Backend timed out

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`GET /api/v1/ceph/storage/deletion-preflight`

Inspect drive deletion dependencies without changing storage

Parameter	Location	Required	Type	Description
`pool_name`	query	yes	string	Request parameter pool_name
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.

Status	Meaning
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed
200	Successful response
501	Product does not support this endpoint
502	Backend failed
503	Backend unavailable
504	Backend timed out

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`GET /api/v1/ceph/storage/fullness-thresholds`

Read or update cluster-wide OSD fullness percentages; updates default to dry run

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.

Status	Meaning
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed
200	Successful response
501	Product does not support this endpoint
502	Backend failed
503	Backend unavailable
504	Backend timed out

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`GET /api/v1/ceph/storage/member-removal-preflight`

Inspect OSD-member removal blockers without removing an OSD

Parameter	Location	Required	Type	Description
`pool_name`	query	yes	string	Request parameter pool_name
`node_name`	query	yes	string	Request parameter node_name
`osd_number`	query	yes	integer	Request parameter osd_number
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.

Status	Meaning
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed
200	Successful response
501	Product does not support this endpoint
502	Backend failed
503	Backend unavailable
504	Backend timed out

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`GET /api/v1/ceph/storage/overview`

Read structured Ceph health including muted checks, capacity, OSDs and pools

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.

Status	Meaning
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed
200	Successful response
501	Product does not support this endpoint
502	Backend failed
503	Backend unavailable
504	Backend timed out

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`GET /api/v1/observability/ceph`

Read Ceph capacity, pool I/O, OSD latency, recovery and PG history; empty metrics are unavailable

Parameter	Location	Required	Type	Description
`range`	query	no	string	Request parameter range Values: 1h, 6h, 24h, 7d, 30d, 90d
`step`	query	no	integer	Request parameter step
`osd`	query	no	integer	Request parameter osd
`pool_id`	query	no	integer	Request parameter pool_id
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.

Status	Meaning
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed
200	Successful response
501	Product does not support this endpoint
502	Backend failed
503	Backend unavailable
504	Backend timed out

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`POST /api/v1/ceph/storage/blockdb/preflight`

Validate structured BlockDB ownership, balanced layout and required capacity

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.
`Idempotency-Key`	header	no	string	Required for cluster membership changes; otherwise replays the cached response for an identical mutating request.

Send request fields in an application/json body.

Field	Required	Type	Description
`request`	yes	object

Status	Meaning
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed
200	Successful response
501	Product does not support this endpoint
502	Backend failed
503	Backend unavailable
504	Backend timed out

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`PUT /api/v1/ceph/placement`

Read monitor/manager placement or queue an update

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.
`Idempotency-Key`	header	no	string	Required for cluster membership changes; otherwise replays the cached response for an identical mutating request.

Send request fields in an application/json body.

Field	Required	Type	Description
`mon_nodes`	yes	array
`mgr_nodes`	yes	array
`confirmed`	yes	boolean	Explicit approval of the requested change.

Status	Meaning
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed
202	Background job accepted; poll status_url for completion
501	Product does not support this endpoint
502	Backend failed
503	Backend unavailable
504	Backend timed out

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`PUT /api/v1/ceph/racks`

Queue a node-to-rack placement update

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.
`Idempotency-Key`	header	no	string	Required for cluster membership changes; otherwise replays the cached response for an identical mutating request.

Send request fields in an application/json body.

Field	Required	Type	Description
`node_name`	yes	string
`rack_name`	yes	string
`confirmed`	yes	boolean	Explicit approval of the requested change.

Status	Meaning
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed
202	Background job accepted; poll status_url for completion
501	Product does not support this endpoint
502	Backend failed
503	Backend unavailable
504	Backend timed out

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`PUT /api/v1/ceph/storage/fullness-thresholds`

Read or update cluster-wide OSD fullness percentages; updates default to dry run

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.
`Idempotency-Key`	header	no	string	Required for cluster membership changes; otherwise replays the cached response for an identical mutating request.

Send request fields in an application/json body.

Field	Required	Type	Description
`nearfull`	yes	number
`backfillfull`	yes	number
`full`	yes	number
`dry_run`	no	boolean
`confirmed`	no	boolean	Explicit approval of the requested change.

Status	Meaning
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed
200	Successful response
501	Product does not support this endpoint
502	Backend failed
503	Backend unavailable
504	Backend timed out

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

Cluster

POST `/api/v1/ceph/cluster`

bootstrap Ceph on the configured eEKAS cluster and deploy monitor/manager roles to registered nodes.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/ceph/cluster'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/cluster-drives`

delete a cluster drive.

Parameters

Parameter	Location	Required	Type	Description
`drive_name`	query	yes	string	Request parameter.
`type`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster-drives?drive_name=<drive_name>&type=<type>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster-drives/available/all`

show available backing devices across all cluster nodes.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster-drives/available/all'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster-drives/available/local`

show locally available cluster drive backing devices.

Parameters

Parameter	Location	Required	Type	Description
`drive_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster-drives/available/local'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster-drives/check-shared`

identify physically shared drives across cluster nodes.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster-drives/check-shared'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster-drives/import-volume`

import an existing NAS volume into cluster management.

Parameters

Parameter	Location	Required	Type	Description
`ip_address`	query	yes	string (ipv4)	Request parameter.
`node`	query	no	string	Cluster node name.
`protocol`	query	no	string; values: http, https, NFS, CIFS, iscsi, nvme	Request parameter.
`volume_path`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster-drives/import-volume?ip_address=192.0.2.10&volume_path=<volume_path>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster-drives/ip-address`

change the access IP address for a cluster drive.

Parameters

Parameter	Location	Required	Type	Description
`current_ip_address`	query	yes	string (ipv4)	Request parameter.
`drive_name`	query	yes	string	Request parameter.
`new_ip_address`	query	yes	string (ipv4)	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster-drives/ip-address?current_ip_address=<current_ip_address>&drive_name=<drive_name>&new_ip_address=<new_ip_address>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster-drives/mirror`

list configured mirror cluster drives.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster-drives/mirror'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster-drives/mirror`

create a mirror cluster drive.

Parameters

Parameter	Location	Required	Type	Description
`disk_path1`	query	yes	string	Request parameter.
`disk_path2`	query	no	string	Request parameter.
`drive_name`	query	yes	string	Request parameter.
`ip_address`	query	yes	string (ipv4)	Request parameter.
`node_name1`	query	yes	string	Request parameter.
`node_name2`	query	no	string	Request parameter.
`purpose`	query	yes	string	Storage purpose. Use S3 when creating an eEKAS object-storage drive.
`size`	query	yes	string	Request parameter.
`this_node_only`	query	no	boolean	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster-drives/mirror?disk_path1=<disk_path1>&drive_name=<drive_name>&ip_address=192.0.2.10&node_name1=<node_name1>&purpose=<purpose>&size=<size>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster-drives/mirror/resize`

resize a mirror cluster drive.

Parameters

Parameter	Location	Required	Type	Description
`mirror_drive`	query	yes	string	Request parameter.
`new_size`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster-drives/mirror/resize?mirror_drive=<mirror_drive>&new_size=<new_size>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster-drives/optimize-bandwidth`

tune the mirror replication bandwidth profile.

Parameters

Parameter	Location	Required	Type	Description
`bandwidth`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster-drives/optimize-bandwidth?bandwidth=<bandwidth>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster-drives/preferred-node`

change the preferred node for a cluster drive.

Parameters

Parameter	Location	Required	Type	Description
`drive_name`	query	yes	string	Request parameter.
`new_node`	query	yes	string	Request parameter.
`shared_data_storage`	query	no	boolean	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster-drives/preferred-node?drive_name=<drive_name>&new_node=<new_node>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster-drives/replication-protocol`

change the mirror replication protocol.

Parameters

Parameter	Location	Required	Type	Description
`drive_name`	query	yes	string	Request parameter.
`protocol`	query	yes	string; values: A, C	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster-drives/replication-protocol?drive_name=<drive_name>&protocol=A'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster-drives/resource-candidates`

list suitable cluster drives for resource creation, including capacity, eligibility, physical media and Ceph pool protection mode.

Parameters

Parameter	Location	Required	Type	Description
`MEDIA`	query	yes	string	Request parameter.
`POOLMODE`	query	yes	string	Request parameter.
`TOTALSIZEINGB`	query	yes	string	Request parameter.
`iSCSI_Only`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster-drives/resource-candidates?MEDIA=<MEDIA>&POOLMODE=<POOLMODE>&TOTALSIZEINGB=<TOTALSIZEINGB>&iSCSI_Only=<iSCSI_Only>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster-drives/shared-volumes`

list shared cluster volumes.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster-drives/shared-volumes'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster-drives/shared-volumes`

create a shared cluster volume.

Parameters

Parameter	Location	Required	Type	Description
`disk_path`	query	yes	string	Request parameter.
`drive_name`	query	yes	string	Request parameter.
`ip_address`	query	yes	string (ipv4)	Request parameter.
`preferred_node`	query	no	string	Request parameter.
`purpose`	query	yes	string	Storage purpose. Use S3 when creating an eEKAS object-storage drive.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster-drives/shared-volumes?disk_path=<disk_path>&drive_name=<drive_name>&ip_address=192.0.2.10&purpose=<purpose>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster-drives/system`

create the system mirror drive.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster-drives/system'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/bootstrap`

create or resume a three-node eEKAS HA cluster, then initialize node registration for Ceph.

Parameters

Parameter	Location	Required	Type	Description
`cluster_name`	query	yes	string	Request parameter.
`node1_ip`	query	yes	string (ipv4)	Request parameter.
`node1_replication`	query	yes	string	Request parameter.
`node2_ip`	query	yes	string (ipv4)	Request parameter.
`node2_replication`	query	yes	string	Request parameter.
`node3_ip`	query	yes	string (ipv4)	Request parameter.
`node3_replication`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	yes	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`password`	JSON body	yes	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/cluster/bootstrap?cluster_name=<cluster_name>&node1_ip=<node1_ip>&node1_replication=<node1_replication>&node2_ip=<node2_ip>&node2_replication=<node2_replication>&node3_ip=<node3_ip>&node3_replication=<node3_replication>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
428	Idempotency-Key is required
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/check-system-files`

verify and fix system file permissions/ownership.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/check-system-files'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/csync2-config`

create or recreate the csync2 cluster file sync configuration.

Parameters

Parameter	Location	Required	Type	Description
`recreate`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/csync2-config'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster/fencing`

Get /api/v1/cluster/fencing.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster/fencing'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/fencing`

Post /api/v1/cluster/fencing.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/fencing'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/file-sync/switch`

switch the cluster to cluster file sync mode.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/file-sync/switch'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/fix-system-disk`

repair problematic system mirror state.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/fix-system-disk'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/heartbeat/global-ocfs2`

create the global OCFS2 heartbeat infrastructure.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/heartbeat/global-ocfs2'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/heartbeat/initialize-ram-device`

initialize the heartbeat RAM device.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/heartbeat/initialize-ram-device'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/import-drives`

import non-configured cluster drives.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/import-drives'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/import-resources`

import non-configured cluster resources.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/import-resources'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/cluster/ipmi-stonith`

remove one managed BMC fencing resource and reconcile overall readiness.

Parameters

Parameter	Location	Required	Type	Description
`node`	query	yes	string	Cluster node name.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/ipmi-stonith?node=node1'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster/ipmi-stonith`

report BMC fencing coverage or discovered BMC addresses without changing cluster configuration.

Parameters

Parameter	Location	Required	Type	Description
`view`	query	no	string	Optional alternate representation, such as discovered BMC data.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster/ipmi-stonith'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/ipmi-stonith`

create, update, or adopt BMC fencing resources for HA cluster nodes.

Parameters

Parameter	Location	Required	Type	Description
`bmc_admin_user`	query	no	string	Request parameter.
`create_stonith`	query	no	string	Request parameter.
`enable_stonith`	query	no	string	Request parameter.
`ipmi_channel`	query	no	string	Request parameter.
`ipmi_channels`	query	no	string	Request parameter.
`ipmi_ip`	query	yes	string (ipv4)	Request parameter.
`ipmi_map`	query	no	string	Request parameter.
`ipmi_user_id`	query	no	string	Request parameter.
`node`	query	no	string	Cluster node name.
`provision_bmc_user`	query	no	string	Request parameter.
`stonith_user`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`bmc_admin_pass`	JSON body	no	string	Request parameter.
`stonith_pass`	JSON body	no	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"bmc_admin_pass":"<bmc_admin_pass>","stonith_pass":"<stonith_pass>"}' \
  'https://<server>:18443/api/v1/cluster/ipmi-stonith?ipmi_ip=<ipmi_ip>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/join/add-node`

add a new node to an existing cluster.

Parameters

Parameter	Location	Required	Type	Description
`heartbeat_ip`	query	yes	string (ipv4)	Request parameter.
`node_ip`	query	yes	string (ipv4)	Request parameter.
`replication_ip`	query	yes	string (ipv4)	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	yes	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`password`	JSON body	yes	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/cluster/join/add-node?heartbeat_ip=<heartbeat_ip>&node_ip=<node_ip>&replication_ip=<replication_ip>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
428	Idempotency-Key is required
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/join/dual`

join a node into a dual-node cluster.

Parameters

Parameter	Location	Required	Type	Description
`my_heartbeat`	query	yes	string	Request parameter.
`my_replication`	query	yes	string	Request parameter.
`remote_heartbeat`	query	yes	string	Request parameter.
`remote_replication`	query	yes	string	Request parameter.
`use_folder`	query	no	boolean	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	yes	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`password`	JSON body	yes	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/cluster/join/dual?my_heartbeat=<my_heartbeat>&my_replication=<my_replication>&remote_heartbeat=<remote_heartbeat>&remote_replication=<remote_replication>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
428	Idempotency-Key is required
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster/join/info`

inspect a remote node and collect cluster join information.

Parameters

Parameter	Location	Required	Type	Description
`ip_address`	query	yes	string (ipv4)	Request parameter.
`user_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`password`	JSON body	yes	string	Request parameter.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Content-Type: application/json' \
  --data '{"password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/cluster/join/info?ip_address=192.0.2.10&user_name=<user_name>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/join/multi`

join a node into a multi-node cluster.

Parameters

Parameter	Location	Required	Type	Description
`my_heartbeat`	query	yes	string	Request parameter.
`my_replication`	query	yes	string	Request parameter.
`remote_heartbeat`	query	yes	string	Request parameter.
`remote_replication`	query	yes	string	Request parameter.
`use_folder`	query	no	boolean	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	yes	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`password`	JSON body	yes	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/cluster/join/multi?my_heartbeat=<my_heartbeat>&my_replication=<my_replication>&remote_heartbeat=<remote_heartbeat>&remote_replication=<remote_replication>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
428	Idempotency-Key is required
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster/maintenance`

Get /api/v1/cluster/maintenance.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster/maintenance'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/maintenance`

Post /api/v1/cluster/maintenance.

Parameters

Parameter	Location	Required	Type	Description
`confirm`	query	no	string	Request parameter.
`node`	query	no	string	Cluster node name.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/maintenance'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster/monitor`

Get /api/v1/cluster/monitor.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster/monitor'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/name`

change the cluster base name.

Parameters

Parameter	Location	Required	Type	Description
`newname`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/name?newname=<newname>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster/non-configured-resources`

scan for resources present on the nodes but missing in cluster configuration.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster/non-configured-resources'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster/ping-ips`

ping configured cluster IPs locally or across nodes.

Parameters

Parameter	Location	Required	Type	Description
`local_only`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster/ping-ips'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/push-system-files`

push this node's system files to the other nodes.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/push-system-files'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/ra-monitor-timeouts`

reconfigure resource-agent monitor intervals/timeouts.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/ra-monitor-timeouts'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/cluster/resources`

delete a cluster resource.

Parameters

Parameter	Location	Required	Type	Description
`lun_number`	query	no	integer; minimum 0	Request parameter.
`resource_name`	query	yes	string	Request parameter.
`resource_type`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/resources?resource_name=<resource_name>&resource_type=<resource_type>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster/resources`

list cluster resources relevant to storage/share targets.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster/resources'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/cluster/resources/move`

clear the temporary `cli-prefer`/`cli-ban` constraint created by a move without deleting permanent preferred-node constraints.

Parameters

Parameter	Location	Required	Type	Description
`resource_name`	query	yes	string	Request parameter.
`wait_seconds`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/resources/move?resource_name=<resource_name>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster/resources/move`

return the resource's current node and whether a temporary Pacemaker move constraint is active.

Parameters

Parameter	Location	Required	Type	Description
`resource_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster/resources/move?resource_name=<resource_name>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/resources/move`

move a Pacemaker resource to a configured cluster node and wait for placement to complete.

Parameters

Parameter	Location	Required	Type	Description
`node_name`	query	yes	string	Request parameter.
`resource_name`	query	yes	string	Request parameter.
`run_async`	query	no	string	Request parameter.
`wait_seconds`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/resources/move?node_name=<node_name>&resource_name=<resource_name>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/resources/rename`

rename a cluster resource.

Parameters

Parameter	Location	Required	Type	Description
`current_name`	query	yes	string	Request parameter.
`new_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/resources/rename?current_name=<current_name>&new_name=<new_name>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/resources/resize`

resize a cluster resource.

Parameters

Parameter	Location	Required	Type	Description
`lun_number`	query	no	integer; minimum 0	Request parameter.
`new_size`	query	yes	string	Request parameter.
`resource_name`	query	yes	string	Request parameter.
`resource_type`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/resources/resize?new_size=<new_size>&resource_name=<resource_name>&resource_type=<resource_type>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/resources/upgrade`

upgrade legacy cluster resource ordering/constraint syntax.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/resources/upgrade'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/cluster/status`

return cluster and CEPH/node status information.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/cluster/status'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/cluster/sync-system-files`

synchronize system files from the newest node.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/cluster/sync-system-files'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

`GET /api/v1/observability/clusters`

Get /api/v1/observability/clusters

Parameter	Location	Required	Type	Description
`range`	query	no	string	Backend parameter `range`.
`step`	query	no	string	Backend parameter `step`.
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

NVMe Initiator

POST `/api/v1/nvme-initiators/connect`

connect to an NVMe target.

Parameters

Parameter	Location	Required	Type	Description
`NQN`	query	yes	string	Request parameter.
`portal_ip`	query	yes	string (ipv4)	Request parameter.
`portal_port`	query	no	integer; minimum 0	Request parameter.
`transport_type`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/nvme-initiators/connect?NQN=<NQN>&portal_ip=<portal_ip>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/nvme-initiators/connect-configured`

connect all persistently configured NVMe initiator targets.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/nvme-initiators/connect-configured'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/nvme-initiators/connections`

list current NVMe initiator connections.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/nvme-initiators/connections'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/nvme-initiators/disconnect`

disconnect an NVMe target.

Parameters

Parameter	Location	Required	Type	Description
`NQN`	query	yes	string	Request parameter.
`keep_config`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/nvme-initiators/disconnect?NQN=<NQN>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/nvme-initiators/discover`

discover NVMe targets on a portal.

Parameters

Parameter	Location	Required	Type	Description
`port_number`	query	no	integer; minimum 0	Request parameter.
`portal_ip`	query	yes	string (ipv4)	Request parameter.
`transport_type`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/nvme-initiators/discover?portal_ip=<portal_ip>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Networking

DELETE `/api/v1/network/bridge-and-network`

delete a virtual network and its host bridge if the network uses bridge mode.

Parameters

Parameter	Location	Required	Type	Description
`virtual_network`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/network/bridge-and-network?virtual_network=<virtual_network>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/network/host-bridges`

delete a host bridge.

Parameters

Parameter	Location	Required	Type	Description
`bridge_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/network/host-bridges?bridge_name=<bridge_name>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/network/host-bridges`

list configured host bridges.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/network/host-bridges'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/network/host-bridges`

create a host bridge.

Parameters

Parameter	Location	Required	Type	Description
`gateway`	query	yes	string	Request parameter.
`host_bridge`	query	no	string	Request parameter.
`ip_address`	query	yes	string (ipv4)	Request parameter.
`netmask`	query	yes	string	Request parameter.
`network_port`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/network/host-bridges?gateway=<gateway>&ip_address=192.0.2.10&netmask=<netmask>&network_port=<network_port>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/network/ports`

list available network ports and their status.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/network/ports'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/network/virtual-networks`

delete a virtual network.

Parameters

Parameter	Location	Required	Type	Description
`virtual_network`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/network/virtual-networks?virtual_network=<virtual_network>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/network/virtual-networks`

list configured virtual networks.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/network/virtual-networks'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/network/virtual-networks`

create a virtual network.

Parameters

Parameter	Location	Required	Type	Description
`dhcp_range_begin`	query	yes	string	Request parameter.
`dhcp_range_end`	query	yes	string	Request parameter.
`host_bridge`	query	yes	string	Request parameter.
`ip_address`	query	yes	string (ipv4)	Request parameter.
`netmask`	query	yes	string	Request parameter.
`network_name`	query	yes	string	Request parameter.
`network_type`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/network/virtual-networks?dhcp_range_begin=<dhcp_range_begin>&dhcp_range_end=<dhcp_range_end>&host_bridge=<host_bridge>&ip_address=192.0.2.10&netmask=<netmask>&network_name=<network_name>&network_type=<network_type>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/sdn/virtual-switches`

delete a virtual switch.

Parameters

Parameter	Location	Required	Type	Description
`name`	query	no	string	Human-readable display name.
`switch_number`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/sdn/virtual-switches'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/sdn/virtual-switches`

list SDN virtual switches.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/sdn/virtual-switches'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/sdn/virtual-switches`

create a virtual switch.

Parameters

Parameter	Location	Required	Type	Description
`allow_unsafe`	query	no	string	Request parameter.
`name`	query	no	string	Human-readable display name.
`rstp`	query	no	string	Request parameter.
`switch_number`	query	no	string	Request parameter.
`uplink`	query	no	string	Request parameter.
`uplink_port`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/sdn/virtual-switches?uplink_port=<uplink_port>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/sdn/vlans`

query VLAN configuration for a target device.

Parameters

Parameter	Location	Required	Type	Description
`target_dev`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/sdn/vlans'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/sdn/vlans`

set VLAN configuration on a target device.

Parameters

Parameter	Location	Required	Type	Description
`target_dev`	query	no	string	Request parameter.
`untagged_vlan`	query	no	string	Request parameter.
`vlan_id`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/sdn/vlans'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/sdn/vlans/current`

clear current VLAN settings on a target device.

Parameters

Parameter	Location	Required	Type	Description
`target_dev`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/sdn/vlans/current?target_dev=<target_dev>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

System

GET `/health`

check whether the API is reachable.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/health'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Users

DELETE `/api/v1/users`

Delete /api/v1/users.

Parameters

Parameter	Location	Required	Type	Description
`remove_home`	query	no	string	Request parameter.
`username`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/users?username=api-user'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/users`

Get /api/v1/users.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/users'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

PATCH `/api/v1/users`

Patch /api/v1/users.

Parameters

Parameter	Location	Required	Type	Description
`full_name`	query	no	string	Request parameter.
`home`	query	no	string	Request parameter.
`new_username`	query	no	string	Request parameter.
`primary_group`	query	no	string	Request parameter.
`shell`	query	no	string	Request parameter.
`uid`	query	no	string	Request parameter.
`username`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`password`	JSON body	yes	string	Request parameter.

Example

curl \
  -X PATCH \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/users?username=api-user'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/users`

Post /api/v1/users.

Parameters

Parameter	Location	Required	Type	Description
`full_name`	query	yes	string	Request parameter.
`group`	query	yes	string	Request parameter.
`username`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`password`	JSON body	yes	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/users?full_name=<full_name>&group=<group>&username=api-user'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/users/generate-userid`

request the next generated user ID from the CLI.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/users/generate-userid'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/users/groups`

Post /api/v1/users/groups.

Parameters

Parameter	Location	Required	Type	Description
`groups`	query	yes	string	Comma-separated FC host-group identifiers.
`mode`	query	no	string	Requested operating or access mode; accepted values depend on the endpoint.
`username`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/users/groups?groups=<groups>&username=api-user'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/users/internal`

create the internal cluster communication user if needed.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/users/internal'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/users/lock`

Post /api/v1/users/lock.

Parameters

Parameter	Location	Required	Type	Description
`locked`	query	yes	string	Request parameter.
`username`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/users/lock?locked=<locked>&username=api-user'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/users/oem-password`

set the OEM/admin password through the CLI.

Parameters

Parameter	Location	Required	Type	Description
`confirmation`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`current_password`	JSON body	yes	string	Request parameter.
`password`	JSON body	yes	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"current_password":"<current_password>","password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/users/oem-password?confirmation=<confirmation>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/users/password`

Post /api/v1/users/password.

Parameters

Parameter	Location	Required	Type	Description
`username`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`password`	JSON body	yes	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/users/password?username=api-user'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Virtual Machines

POST `/api/v1/mounts/vm-backups`

Parameters

Parameter	Location	Required	Type	Description
`backup_target_folder`	query	yes	string	Request parameter.
`domain_name`	query	no	string	Request parameter.
`ip_address`	query	yes	string (ipv4)	Request parameter.
`mount_folder`	query	no	string	Request parameter.
`share_name`	query	yes	string	Request parameter.
`user_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`password`	JSON body	no	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"password":"REPLACE_WITH_PASSWORD"}' \
  'https://<server>:18443/api/v1/mounts/vm-backups?backup_target_folder=<backup_target_folder>&ip_address=192.0.2.10&share_name=example-share'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/multi-vms`

delete one VM.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/multi-vms?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/multi-vms`

list configured VMs.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/multi-vms'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/multi-vms/autostart`

list VM autostart settings.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/multi-vms/autostart'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/multi-vms/creation-info`

return capacity and network information used during VM creation.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/multi-vms/creation-info'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/multi-vms/exists`

check whether a VM exists.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/multi-vms/exists?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/multi-vms/info`

return detailed configuration information for one VM.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/multi-vms/info?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/multi-vms/migrate`

migrate VMs using a CLI list file.

Parameters

Parameter	Location	Required	Type	Description
`list_path`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/multi-vms/migrate?list_path=<list_path>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/multi-vms/move-disk`

move VMs to another disk using a CLI list file.

Parameters

Parameter	Location	Required	Type	Description
`list_path`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/multi-vms/move-disk?list_path=<list_path>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/multi-vms/settings`

pull detailed VM settings from its XML configuration.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/multi-vms/settings?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/multi-vms/start`

start one VM or a list of VMs.

Parameters

Parameter	Location	Required	Type	Description
`list_path`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/multi-vms/start?list_path=<list_path>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/multi-vms/stop`

stop one VM or stop a VM list with a specific stop mode.

Parameters

Parameter	Location	Required	Type	Description
`list_path`	query	yes	string	Request parameter.
`stop_type`	query	yes	string	Request parameter.
`vm_mode`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/multi-vms/stop?list_path=<list_path>&stop_type=<stop_type>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/multi-vms/vmstats`

return cached VM statistics output.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/multi-vms/vmstats'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/multi-vms/with-stats`

list configured VMs with runtime usage information.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/multi-vms/with-stats'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/sdn/vm-ports`

remove a switch port from a VM.

Parameters

Parameter	Location	Required	Type	Description
`port_name`	query	no	string	Request parameter.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/sdn/vm-ports'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/sdn/vm-ports`

attach a switch port to a VM.

Parameters

Parameter	Location	Required	Type	Description
`switch_name`	query	no	string	Request parameter.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/sdn/vm-ports'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/sdn/vm-profiles/sync`

sync SDN VM profiles across cluster nodes.

Parameters

Parameter	Location	Required	Type	Description
`source_node`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/sdn/vm-profiles/sync'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vm-backups`

delete older VM backups and keep the requested number of newest backups.

Parameters

Parameter	Location	Required	Type	Description
`backup_path`	query	yes	string	Request parameter.
`keep_last_backups`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-backups?backup_path=<backup_path>&keep_last_backups=<keep_last_backups>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-backups`

list VM backups.

Parameters

Parameter	Location	Required	Type	Description
`backup_path`	query	no	string	Request parameter.
`backup_server`	query	no	string	Request parameter.
`only_vm_names`	query	no	string	Request parameter.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-backups'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-backups/check-expired`

check expired VM backups and optionally clean them up.

Parameters

Parameter	Location	Required	Type	Description
`backup_path`	query	yes	string	Request parameter.
`cleanup`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-backups/check-expired?backup_path=<backup_path>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vm-backups/job-history`

clear VM backup job history.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-backups/job-history'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-backups/jobs`

list current and recent VM backup jobs.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-backups/jobs'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-backups/kill-running`

stop running VM backup jobs.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-backups/kill-running'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-backups/master`

show the current VM backup master node.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-backups/master'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-backups/mount`

mount one VM backup for recovery access.

Parameters

Parameter	Location	Required	Type	Description
`backup_name`	query	yes	string	Request parameter.
`backup_path`	query	yes	string	Request parameter.
`backup_server`	query	no	string	Request parameter.
`recovery_volume`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-backups/mount?backup_name=<backup_name>&backup_path=<backup_path>&recovery_volume=<recovery_volume>&vm_name=example-vm'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-backups/mount-cloud`

mount one cloud VM backup for recovery access.

Parameters

Parameter	Location	Required	Type	Description
`backup_name`	query	yes	string	Request parameter.
`target_folder`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-backups/mount-cloud?backup_name=<backup_name>&target_folder=<target_folder>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-backups/restore`

Post /api/v1/vm-backups/restore.

Parameters

Parameter	Location	Required	Type	Description
`backup_name`	query	yes	string	Request parameter.
`backup_path`	query	yes	string	Request parameter.
`backup_server`	query	no	string	Request parameter.
`new_name`	query	no	string	Request parameter.
`restore_target`	query	yes	string	Request parameter.
`restore_type`	query	yes	string	Request parameter.
`storage_wait_seconds`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-backups/restore?backup_name=<backup_name>&backup_path=<backup_path>&restore_target=<restore_target>&restore_type=<restore_type>&vm_name=example-vm'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-backups/restore-cloud`

restore a cloud-backed VM backup.

Parameters

Parameter	Location	Required	Type	Description
`backup_name`	query	yes	string	Request parameter.
`new_name`	query	no	string	Request parameter.
`restore_target`	query	yes	string	Request parameter.
`target_folder`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-backups/restore-cloud?backup_name=<backup_name>&restore_target=<restore_target>&target_folder=<target_folder>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-backups/run`

Post /api/v1/vm-backups/run.

Parameters

Parameter	Location	Required	Type	Description
`backup_server`	query	no	string	Request parameter.
`storage_wait_seconds`	query	no	string	Request parameter.
`target_folder`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-backups/run?target_folder=<target_folder>&vm_name=example-vm'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-backups/run-batch`

run a batch VM backup job.

Parameters

Parameter	Location	Required	Type	Description
`job_folder`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-backups/run-batch?job_folder=<job_folder>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-backups/run-batch-restore`

run a batch VM restore job.

Parameters

Parameter	Location	Required	Type	Description
`job_folder`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-backups/run-batch-restore?job_folder=<job_folder>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-backups/running`

list currently running VM backup jobs.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-backups/running'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-backups/schedules`

list VM backup schedules.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-backups/schedules'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-backups/unmount`

unmount a recovery mount.

Parameters

Parameter	Location	Required	Type	Description
`backup_name`	query	yes	string	Request parameter.
`mount_path`	query	no	string	Request parameter.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-backups/unmount?backup_name=<backup_name>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vm-folders`

delete a VM folder and move its children and assigned VMs to its parent.

Parameters

Parameter	Location	Required	Type	Description
`folder_id`	query	yes	string	Request parameter.
`revision`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-folders?folder_id=<folder_id>&revision=<revision>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-folders`

list the hierarchical VM folder inventory and VM assignments.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-folders'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-folders`

create a VM folder.

Parameters

Parameter	Location	Required	Type	Description
`name`	query	yes	string	Human-readable display name.
`parent_id`	query	no	string	Request parameter.
`revision`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-folders?name=<name>&revision=<revision>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

PUT `/api/v1/vm-folders`

rename or move a VM folder.

Parameters

Parameter	Location	Required	Type	Description
`action`	query	yes	string	Operation-specific action selector.
`folder_id`	query	yes	string	Request parameter.
`name`	query	no	string	Human-readable display name.
`parent_id`	query	no	string	Request parameter.
`revision`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X PUT \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-folders?action=<action>&folder_id=<folder_id>&revision=<revision>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vm-folders/assignments`

remove a VM assignment so the VM appears at inventory root.

Parameters

Parameter	Location	Required	Type	Description
`revision`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-folders/assignments?revision=<revision>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

PUT `/api/v1/vm-folders/assignments`

assign one or more VMs to a folder, or to root to unfile them.

Parameters

Parameter	Location	Required	Type	Description
`folder_id`	query	yes	string	Request parameter.
`revision`	query	yes	string	Request parameter.
`vm_names`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X PUT \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-folders/assignments?folder_id=<folder_id>&revision=<revision>&vm_names=<vm_names>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-folders/vms`

resolve VMs assigned to a folder and all its descendant folders.

Parameters

Parameter	Location	Required	Type	Description
`folder_id`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-folders/vms'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/advanced-recommendation`

Get /api/v1/vm-placement/advanced-recommendation.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/advanced-recommendation'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/alerts`

Get /api/v1/vm-placement/alerts.

Parameters

Parameter	Location	Required	Type	Description
`limit`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/alerts'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-placement/alerts`

Post /api/v1/vm-placement/alerts.

Parameters

Parameter	Location	Required	Type	Description
`alert_id`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-placement/alerts'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/audit`

Get /api/v1/vm-placement/audit.

Parameters

Parameter	Location	Required	Type	Description
`limit`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/audit'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-placement/balance`

execute the current recommendation only when policy automation is enabled.

Parameters

Parameter	Location	Required	Type	Description
`asynchronous`	query	no	string	Request parameter.
`confirm`	query	yes	string	Request parameter.
`target_node`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-placement/balance?confirm=<confirm>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-placement/capacity-simulation`

Post /api/v1/vm-placement/capacity-simulation.

Parameters

Parameter	Location	Required	Type	Description
`scenario_b64`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-placement/capacity-simulation'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/compliance`

Get /api/v1/vm-placement/compliance.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/compliance'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/evacuation`

Get /api/v1/vm-placement/evacuation.

Parameters

Parameter	Location	Required	Type	Description
`node`	query	no	string	Cluster node name.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/evacuation'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-placement/evacuation`

Post /api/v1/vm-placement/evacuation.

Parameters

Parameter	Location	Required	Type	Description
`asynchronous`	query	no	string	Request parameter.
`confirm`	query	no	string	Request parameter.
`node`	query	no	string	Cluster node name.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-placement/evacuation'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/history`

Get /api/v1/vm-placement/history.

Parameters

Parameter	Location	Required	Type	Description
`limit`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/history'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/initial-placement`

Get /api/v1/vm-placement/initial-placement.

Parameters

Parameter	Location	Required	Type	Description
`cpus`	query	no	string	Request parameter.
`datastore`	query	no	string	Request parameter.
`memory_mb`	query	no	string	Request parameter.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/initial-placement'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/maintenance`

Get /api/v1/vm-placement/maintenance.

Parameters

Parameter	Location	Required	Type	Description
`node`	query	no	string	Cluster node name.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/maintenance'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-placement/maintenance`

Post /api/v1/vm-placement/maintenance.

Parameters

Parameter	Location	Required	Type	Description
`action`	query	no	string	Operation-specific action selector.
`confirm`	query	no	string	Request parameter.
`node`	query	no	string	Cluster node name.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-placement/maintenance'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/maintenance-batch`

Get /api/v1/vm-placement/maintenance-batch.

Parameters

Parameter	Location	Required	Type	Description
`nodes`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/maintenance-batch'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-placement/maintenance-batch`

Post /api/v1/vm-placement/maintenance-batch.

Parameters

Parameter	Location	Required	Type	Description
`confirm`	query	no	string	Request parameter.
`nodes`	query	no	string	Request parameter.
`state`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-placement/maintenance-batch'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/monitor`

Get /api/v1/vm-placement/monitor.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/monitor'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/nodes`

return dynamically discovered online cluster nodes and placement scores.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/nodes'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/policy`

Get /api/v1/vm-placement/policy.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/policy'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

PUT `/api/v1/vm-placement/policy`

Put /api/v1/vm-placement/policy.

Parameters

Parameter	Location	Required	Type	Description
`policy_b64`	query	no	string	Request parameter.
`revision`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X PUT \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-placement/policy'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-placement/policy/validate`

Post /api/v1/vm-placement/policy/validate.

Parameters

Parameter	Location	Required	Type	Description
`policy_b64`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-placement/policy/validate'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/power-plan`

Get /api/v1/vm-placement/power-plan.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/power-plan'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-placement/power-plan`

Post /api/v1/vm-placement/power-plan.

Parameters

Parameter	Location	Required	Type	Description
`action`	query	no	string	Operation-specific action selector.
`confirm`	query	no	string	Request parameter.
`node`	query	no	string	Cluster node name.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-placement/power-plan'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/recommendation`

return ranked and explainable candidates for a running VM.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/recommendation?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/recommendations`

Get /api/v1/vm-placement/recommendations.

Parameters

Parameter	Location	Required	Type	Description
`limit`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/recommendations'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-placement/recommendations`

Post /api/v1/vm-placement/recommendations.

Parameters

Parameter	Location	Required	Type	Description
`action`	query	no	string	Operation-specific action selector.
`confirm`	query	no	string	Request parameter.
`note`	query	no	string	Request parameter.
`recommendation_id`	query	no	string	Request parameter.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-placement/recommendations'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/service`

Get /api/v1/vm-placement/service.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/service'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

PUT `/api/v1/vm-placement/service`

Put /api/v1/vm-placement/service.

Parameters

Parameter	Location	Required	Type	Description
`enabled`	query	no	boolean	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X PUT \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-placement/service'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/simulation`

Get /api/v1/vm-placement/simulation.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/simulation'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-placement/telemetry`

Get /api/v1/vm-placement/telemetry.

Parameters

Parameter	Location	Required	Type	Description
`limit`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-placement/telemetry'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vm-recovery-plans`

Delete /api/v1/vm-recovery-plans.

Parameters

Parameter	Location	Required	Type	Description
`name`	query	no	string	Human-readable display name.
`revision`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-recovery-plans'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-recovery-plans`

Get /api/v1/vm-recovery-plans.

Parameters

Parameter	Location	Required	Type	Description
`name`	query	no	string	Human-readable display name.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-recovery-plans'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

PUT `/api/v1/vm-recovery-plans`

Put /api/v1/vm-recovery-plans.

Parameters

Parameter	Location	Required	Type	Description
`plan_b64`	query	no	string	Request parameter.
`revision`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X PUT \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-recovery-plans'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-recovery-plans/actions`

Post /api/v1/vm-recovery-plans/actions.

Parameters

Parameter	Location	Required	Type	Description
`action`	query	no	string	Operation-specific action selector.
`confirm`	query	no	string	Request parameter.
`name`	query	no	string	Human-readable display name.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-recovery-plans/actions'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vm-templates`

remove template protection without deleting the source VM.

Parameters

Parameter	Location	Required	Type	Description
`name`	query	yes	string	Human-readable display name.
`revision`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-templates?name=<name>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vm-templates`

list templates or return one template by optional `name`.

Parameters

Parameter	Location	Required	Type	Description
`name`	query	no	string	Human-readable display name.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vm-templates'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-templates`

protect a powered-off VM as a versioned template source.

Parameters

Parameter	Location	Required	Type	Description
`name`	query	yes	string	Human-readable display name.
`release`	query	no	string	Request parameter.
`revision`	query	no	string	Request parameter.
`source_vm`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vm-templates?name=<name>&source_vm=<source_vm>'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vm-templates/deploy`

deploy a new storage-aware VM clone from a protected template.

Parameters

Parameter	Location	Required	Type	Description
`asynchronous`	query	no	string	Request parameter.
`name`	query	yes	string	Human-readable display name.
`target_datastore`	query	no	string	Request parameter.
`target_network`	query	no	string	Request parameter.
`target_node`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`customization_b64`	JSON body	no	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"customization_b64":"<customization_b64>"}' \
  'https://<server>:18443/api/v1/vm-templates/deploy?name=<name>&vm_name=example-vm'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vms`

delete a VM.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms`

list configured VMs.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms`

create a VM.

Parameters

Parameter	Location	Required	Type	Description
`bios_type`	query	no	string	Request parameter.
`cores`	query	no	string	Request parameter.
`cpu_model`	query	no	string	Request parameter.
`disk_size_gb`	query	no	string	Request parameter.
`disk_type`	query	no	string	Request parameter.
`drive`	query	no	string	Request parameter.
`guest_os`	query	no	string	Request parameter.
`iso_path`	query	no	string	Request parameter.
`memory`	query	no	string	Request parameter.
`memory_mb`	query	no	string	Request parameter.
`number_of_disks_for_import`	query	no	string	Request parameter.
`preferred_node`	query	no	string	Request parameter.
`sockets`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`vm_network`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms?vm_name=example-vm'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/all-config`

pull configuration details for all VMs.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/all-config'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/autostart`

list VM autostart settings.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/autostart'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/bandwidth`

read VM bandwidth settings.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/bandwidth?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/bandwidth`

set VM bandwidth settings.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/bandwidth?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/clean-locks`

clean VM lock files.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/clean-locks'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/clone`

clone Legacy BIOS or UEFI VMs while generating independent identity,.

Parameters

Parameter	Location	Required	Type	Description
`clone_name`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/clone?clone_name=<clone_name>&vm_name=example-vm'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vms/console-sessions`

idempotently terminate a managed VM console proxy session.

Parameters

Parameter	Location	Required	Type	Description
`session_id`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/console-sessions?session_id=<session_id>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/console-sessions`

atomically create a short-lived, localhost-only VM console proxy session.

Parameters

Parameter	Location	Required	Type	Description
`ttl_seconds`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/console-sessions?vm_name=example-vm'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/cpu-baseline`

detect and set the most compatible cluster CPU baseline.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/cpu-baseline'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/cpu-features`

set VM CPU feature mode.

Parameters

Parameter	Location	Required	Type	Description
`features`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/cpu-features?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/cpu-model`

Get /api/v1/vms/cpu-model.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/cpu-model?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/cpu-model`

Post /api/v1/vms/cpu-model.

Parameters

Parameter	Location	Required	Type	Description
`action`	query	no	string	Operation-specific action selector.
`cpu_model`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/cpu-model?cpu_model=<cpu_model>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/creation-info`

show VM creation prerequisites and available resources.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/creation-info'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/customization`

Post /api/v1/vms/customization.

Parameters

Parameter	Location	Required	Type	Description
`action`	query	no	string	Operation-specific action selector.
`timeout`	query	no	string	Request parameter.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`customization_b64`	JSON body	no	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"customization_b64":"<customization_b64>"}' \
  'https://<server>:18443/api/v1/vms/customization'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vms/devices`

Delete /api/v1/vms/devices.

Parameters

Parameter	Location	Required	Type	Description
`action`	query	no	string	Operation-specific action selector.
`kind`	query	no	string	Registry type or result category requested by the operation.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/devices'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/eject-iso`

eject ISO media from a VM.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/eject-iso?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/exists`

check whether a VM exists.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/exists?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/firewall/disable`

disable VNC firewall restrictions.

Parameters

Parameter	Location	Required	Type	Description
`port`	query	yes	integer; minimum 0	TCP port; NFS over RDMA defaults to 20049.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/firewall/disable?port=1'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/firewall/enable`

enable VNC firewall restrictions.

Parameters

Parameter	Location	Required	Type	Description
`port`	query	yes	integer; minimum 0	TCP port; NFS over RDMA defaults to 20049.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/firewall/enable?port=1'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/firmware`

Post /api/v1/vms/firmware.

Parameters

Parameter	Location	Required	Type	Description
`action`	query	no	string	Operation-specific action selector.
`backup_id`	query	no	string	Request parameter.
`confirm`	query	no	string	Request parameter.
`target`	query	no	string	Cluster FC target resource identifier.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/firmware'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/guest-agent`

return guest-agent network data for running VMs.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/guest-agent'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/guest-operations`

Post /api/v1/vms/guest-operations.

Parameters

Parameter	Location	Required	Type	Description
`operation`	query	no	string	Request parameter.
`snapshot_name`	query	no	string	Request parameter.
`timeout`	query	no	string	Request parameter.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/guest-operations'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/import`

Post /api/v1/vms/import.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/import'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/import/validate`

Post /api/v1/vms/import/validate.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/import/validate'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/info`

show detailed information for one VM.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/info?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/instant-backup-schedule`

Post /api/v1/vms/instant-backup-schedule.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/instant-backup-schedule'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vms/iso`

Delete /api/v1/vms/iso.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/iso'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/iso`

Get /api/v1/vms/iso.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/iso?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/iso`

Post /api/v1/vms/iso.

Parameters

Parameter	Location	Required	Type	Description
`iso_path`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/iso?iso_path=<iso_path>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vms/metadata`

remove declarative metadata without deleting the VM.

Parameters

Parameter	Location	Required	Type	Description
`revision`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/metadata?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/metadata`

list VM metadata or return one VM when `vm_name` is supplied.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/metadata'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

PUT `/api/v1/vms/metadata`

atomically converge tags, annotation, owner, and custom attributes.

Parameters

Parameter	Location	Required	Type	Description
`metadata_b64`	query	yes	string	Request parameter.
`revision`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X PUT \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/metadata?metadata_b64=<metadata_b64>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/migrate`

live-migrate one VM to the peer node while retaining shared storage.

Parameters

Parameter	Location	Required	Type	Description
`list_path`	query	no	string	Request parameter.
`target_node`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/migrate?target_node=<target_node>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/monitor-timeout`

Get /api/v1/vms/monitor-timeout.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/monitor-timeout?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/monitor-timeout`

set the VM monitor timeout.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/monitor-timeout?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/move-disk`

live storage migration between cluster drives.

Parameters

Parameter	Location	Required	Type	Description
`current_drive`	query	yes	string	Request parameter.
`list_path`	query	no	string	Request parameter.
`target_drive`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/move-disk?current_drive=<current_drive>&target_drive=<target_drive>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/network-attachment`

Post /api/v1/vms/network-attachment.

Parameters

Parameter	Location	Required	Type	Description
`source_name`	query	yes	string	Request parameter.
`source_type`	query	yes	string	Request parameter.
`virtual_port`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/network-attachment?source_name=<source_name>&source_type=<source_type>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/network-policy`

apply VM network policy.

Parameters

Parameter	Location	Required	Type	Description
`target_node`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/network-policy?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/passthrough`

Get /api/v1/vms/passthrough.

Parameters

Parameter	Location	Required	Type	Description
`device_type`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/passthrough'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/passthrough`

preflight, configure, restore, assign, or unassign PCI and USB passthrough.

Parameters

Parameter	Location	Required	Type	Description
`action`	query	yes	string; values: check_passthrough, configure_passthrough, restore_passthrough, assign_device_to_vm, unassign_device_from_vm, assign_usb_to_vm, unassign_usb_from_vm	Operation-specific action selector.
`allow_unsafe_group`	query	no	string; values: yes, no	Request parameter.
`assignment_scope`	query	no	string; values: group, function	Request parameter.
`device_type`	query	no	string	Request parameter.
`driver`	query	no	string	Request parameter.
`pci_address`	query	no	string	Request parameter.
`usb_bus`	query	no	string	Request parameter.
`usb_device`	query	no	string	Request parameter.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/passthrough?action=check_passthrough'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/primary-interface`

Get /api/v1/vms/primary-interface.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/primary-interface?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/rbd`

create an RBD-backed VM.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/rbd?vm_name=example-vm'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vms/recovery-mount`

Delete /api/v1/vms/recovery-mount.

Parameters

Parameter	Location	Required	Type	Description
`action`	query	no	string	Operation-specific action selector.
`folder_name`	query	no	string	Request parameter.
`mount_root`	query	no	string	Request parameter.
`snapshot_name`	query	no	string	Request parameter.
`snapshot_type`	query	no	string	Request parameter.
`vm_name`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/recovery-mount'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/remote-migration`

Post /api/v1/vms/remote-migration.

Parameters

Parameter	Location	Required	Type	Description
`delete_on_source`	query	no	string	Request parameter.
`remote_server`	query	yes	string	Request parameter.
`target_drive`	query	yes	string	Request parameter.
`target_network`	query	no	string	Request parameter.
`target_server`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/remote-migration?remote_server=<remote_server>&target_drive=<target_drive>&target_server=<target_server>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vms/remote-migration/partners`

Delete /api/v1/vms/remote-migration/partners.

Parameters

Parameter	Location	Required	Type	Description
`partner_id`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/remote-migration/partners'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/remote-migration/partners`

Get /api/v1/vms/remote-migration/partners.

Parameters

Parameter	Location	Required	Type	Description
`partner_id`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/remote-migration/partners'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/remote-migration/partners`

Post /api/v1/vms/remote-migration/partners.

Parameters

Parameter	Location	Required	Type	Description
`partner_id`	query	no	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/remote-migration/partners'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

PUT `/api/v1/vms/remote-migration/partners`

Put /api/v1/vms/remote-migration/partners.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X PUT \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/remote-migration/partners'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/remote-migration/preflight`

Get /api/v1/vms/remote-migration/preflight.

Parameters

Parameter	Location	Required	Type	Description
`remote_server`	query	yes	string	Request parameter.
`target_drive`	query	yes	string	Request parameter.
`target_network`	query	no	string	Request parameter.
`target_server`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/remote-migration/preflight?remote_server=<remote_server>&target_drive=<target_drive>&target_server=<target_server>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/resize`

Get /api/v1/vms/resize.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/resize?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/resize`

Post /api/v1/vms/resize.

Parameters

Parameter	Location	Required	Type	Description
`disk_size_gb`	query	no	string	Request parameter.
`disk_target`	query	no	string	Request parameter.
`memory_mb`	query	no	string	Request parameter.
`restart_policy`	query	no	string	Request parameter.
`vcpus`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/resize?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/settings`

pull detailed VM settings from XML.

Parameters

Parameter	Location	Required	Type	Description
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/settings?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

DELETE `/api/v1/vms/snapshots`

Delete /api/v1/vms/snapshots.

Parameters

Parameter	Location	Required	Type	Description
`snapshot_name`	query	yes	string	Request parameter.
`type`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X DELETE \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/snapshots?snapshot_name=<snapshot_name>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/snapshots`

Get /api/v1/vms/snapshots.

Parameters

Parameter	Location	Required	Type	Description
`type`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/snapshots?vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/snapshots`

Post /api/v1/vms/snapshots.

Parameters

Parameter	Location	Required	Type	Description
`include_ram`	query	no	string	Request parameter.
`preserve_unselected`	query	no	string	Request parameter.
`type`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/snapshots?vm_name=example-vm'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/snapshots/revert`

Post /api/v1/vms/snapshots/revert.

Parameters

Parameter	Location	Required	Type	Description
`snapshot_name`	query	yes	string	Request parameter.
`type`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/snapshots/revert?snapshot_name=<snapshot_name>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/start`

start one VM or a VM list.

Parameters

Parameter	Location	Required	Type	Description
`list_path`	query	yes	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/start?list_path=<list_path>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/status-quick`

return the quick VM status view.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/status-quick'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/stop`

stop one VM or a VM list.

Parameters

Parameter	Location	Required	Type	Description
`list_path`	query	yes	string	Request parameter.
`stop_type`	query	yes	string	Request parameter.
`vm_mode`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/stop?list_path=<list_path>&stop_type=<stop_type>&vm_name=example-vm'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/vmstats`

return cached VM stats output.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/vmstats'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/vnc-ports/next`

find the next available VNC/VNC proxy ports.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/vnc-ports/next'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/vms/vnc-server`

start the VM websockify/noVNC server.

Parameters

Parameter	Location	Required	Type	Description
`host_ip`	query	yes	string (ipv4)	Request parameter.
`reset_vnc_ports`	query	no	string	Request parameter.
`vm_name`	query	yes	string	Request parameter.
`vnc_port`	query	yes	string	Request parameter.
`vnc_proxy_port`	query	yes	string	Request parameter.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/vms/vnc-server?host_ip=<host_ip>&vm_name=example-vm&vnc_port=<vnc_port>&vnc_proxy_port=<vnc_proxy_port>'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/vms/with-stats`

list configured VMs with runtime stats.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/vms/with-stats'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

`GET /api/v1/observability/vms`

Get /api/v1/observability/vms

Parameter	Location	Required	Type	Description
`range`	query	no	string	Backend parameter `range`.
`step`	query	no	string	Backend parameter `step`.
`vm_name`	query	no	string	Backend parameter `vm_name`.
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

`POST /api/v1/vm-templates/actions`

Post /api/v1/vm-templates/actions

Parameter	Location	Required	Type	Description
`action`	query	no	string	Backend parameter `action`.
`confirm`	query	no	string	Backend parameter `confirm`.
`name`	query	no	string	Backend parameter `name`.
`revision`	query	no	string	Backend parameter `revision`.
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.
`Idempotency-Key`	header	no	string	Required for cluster membership changes; otherwise replays the cached response for an identical mutating request.

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

iSCSI Initiator

POST `/api/v1/iscsi-initiators/connect`

connect the initiator to a target portal.

Parameters

Parameter	Location	Required	Type	Description
`chap_user`	query	no	string	Request parameter.
`connect_on_all_nodes`	query	no	string	Request parameter.
`portal`	query	yes	string	Request parameter.
`target_name`	query	yes	string	FC target or backing-volume name, as required by the operation.
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.
`chap_password`	JSON body	no	string	Request parameter.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  -H 'Content-Type: application/json' \
  --data '{"chap_password":"<chap_password>"}' \
  'https://<server>:18443/api/v1/iscsi-initiators/connect?portal=<portal>&target_name=example-target'

Responses

Status	Meaning
201	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

POST `/api/v1/iscsi-initiators/sync`

synchronize discovered iSCSI target configuration to all cluster nodes.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.
`Idempotency-Key`	header	no	string; maximum length 255	Prevents duplicate execution when the same mutating request is retried.

Example

curl \
  -X POST \
  -H 'X-API-Key: <API_KEY>' \
  -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  'https://<server>:18443/api/v1/iscsi-initiators/sync'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

GET `/api/v1/iscsi-initiators/targets`

Get /api/v1/iscsi-initiators/targets.

Parameters

Parameter	Location	Required	Type	Description
`X-Correlation-ID`	header	no	string	Optional request identifier. The server generates one when omitted.

Example

curl \
  -X GET \
  -H 'X-API-Key: <API_KEY>' \
  'https://<server>:18443/api/v1/iscsi-initiators/targets'

Responses

Status	Meaning
200	Successful response
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed

Common response behavior

Mutating operations can return HTTP 202 and a job identifier for asynchronous work. Errors are JSON objects with an error field. Common statuses are 400, 401, 403, 404, 409, 429, and 500.

Hardware

`GET /api/v1/hardware/sensors`

Read current BMC sensors locally, for one registered node, or node=all

Parameter	Location	Required	Type	Description
`node`	query	no	string	Request parameter node
`X-Correlation-ID`	header	no	string	Optional caller correlation ID; generated when omitted.

Status	Meaning
400	Invalid request
401	Invalid or missing API key
403	API role is not permitted
405	Method not allowed
409	Resource state conflict
422	Request could not be processed
429	Rate limit exceeded
500	Backend operation failed
200	Successful response
501	Product does not support this endpoint
502	Backend failed
503	Backend unavailable
504	Backend timed out

Response field types and nested request objects are defined in openapi.json / openapi.yaml. A 202 response accepts a job; poll status_url to verify completion.

Hardware and storage update — 2026-10-23

Read the hardware and storage notes in the product endpoint sections for sensor fields, monitoring, confirmations, preflight requests and the credential-retrieval migration.

eEVOS HCI REST API Reference

Getting started

Product scope

Operation summary

Contents

API

GET /api/docs

Parameters

Example

Responses

GET /api/docs/openapi-json

Parameters

Example

Responses

GET /api/docs/swagger-ui-bundle.js

Parameters

Example

Responses

GET /api/docs/swagger-ui-standalone-preset.js

Parameters

Example

Responses

GET /api/docs/swagger-ui.css

Parameters

Example

Responses

GET /api/openapi.json

Parameters

Example

Responses

GET /api/openapi.yaml

Parameters

Example

Responses

DELETE /api/v1/groups

Parameters

Example

Responses

GET /api/v1/groups

Parameters

Example

Responses

PATCH /api/v1/groups

Parameters

Example

Responses

POST /api/v1/groups

Parameters

Example

Responses

DELETE /api/v1/jobs

Parameters

Example

Responses

GET /api/v1/jobs

Parameters

Example

Responses

DELETE /api/v1/mounts

Parameters

Example

Responses

GET /api/v1/mounts

Parameters

Example

Responses

POST /api/v1/mounts

Parameters

Example

Responses

DELETE /api/v1/mounts/backup-servers

Parameters

Example

Responses

GET /api/v1/mounts/backup-servers

Parameters

Example

Responses

POST /api/v1/mounts/s3-backups

Parameters

GET `/api/docs`

GET `/api/docs/openapi-json`

GET `/api/docs/swagger-ui-bundle.js`

GET `/api/docs/swagger-ui-standalone-preset.js`

GET `/api/docs/swagger-ui.css`

GET `/api/openapi.json`

GET `/api/openapi.yaml`

DELETE `/api/v1/groups`

GET `/api/v1/groups`

PATCH `/api/v1/groups`

POST `/api/v1/groups`

DELETE `/api/v1/jobs`

GET `/api/v1/jobs`

DELETE `/api/v1/mounts`

GET `/api/v1/mounts`

POST `/api/v1/mounts`

DELETE `/api/v1/mounts/backup-servers`

GET `/api/v1/mounts/backup-servers`

POST `/api/v1/mounts/s3-backups`

GET `/api/v1/multi-cluster/license`

GET `/api/v1/multi-cluster/partner-info`

POST `/api/v1/multi-cluster/shared-iscsi-disk`

GET `/api/v1/multi-cluster/status`

GET `/api/v1/notifications`

POST `/api/v1/notifications`

PUT `/api/v1/notifications`

GET `/api/v1/product/capabilities`

GET `/api/v1/rdma/devices`

DELETE `/api/v1/rdma/nfs`

GET `/api/v1/rdma/nfs`

POST `/api/v1/rdma/nfs`

GET `/api/v1/rdma/recovery`

POST `/api/v1/rdma/recovery`

POST `/api/v1/rdma/reset-port`

POST `/api/v1/rdma/software-roce`

POST `/api/v1/rdma/software-roce/enable-all`