SupremeRAID™ RESTful API

Apr. 24, 2026

Date:4/24/26

About this document

The SupremeRAID™ RESTful API facilitates easy integration with third-party systems, offering CRUD operations and tailored response codes for efficient RAID management.

Info

The SupremeRAID™ RESTful API requires the graid-mgr service to be running and TCP port 50061 to be open for proper operation.
If port 50061 is unavailable and a different port is required, update the port configuration in /etc/graidmgr/service.conf.

Base URL & Authentication

Version: 1.0.1
Base Path: /api/v1
Content-Type: application/json
Authentication: All API requests require authentication except for the setup and token generation endpoints.

Security Scheme	Type	Header Name
APIAuth	apiKey	`Authorization`

HTTP code

200: OK. Please refer to the status code section
400: Invalid request message framing
401: Invalid authentication credentials
500: Unexpected internal server error

Version information

Method	Path
GET	/version

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "gpuraid": "9.9.9-999.g12345678.999",
    "graidmgr": "1.0.1"
  }
}

Authentication

Method	Path
POST	/setup/authentication

Parameters (Required Model): auth.SetupAuthRequest

{
  "host_token": "string",
  "password": "string"
}

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Token

Generate token

Method	Path
POST	/token

Parameters (Required Model): auth.GenerateTokenRequest
```
{
  "password": "string"
}
```

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "expired_timestamp": 0,
    "token": "string"
  }
}

Invalidate token

Method	Path
DELETE	/token

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

License

Get License Information

Method	Path
GET	/licenses

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "active": true,
      "expired": true,
      "ha": true,
      "keys": [
        {
          "expired_date": "string",
          "expired_remain_days": 0,
          "ha": true,
          "key": "string",
          "nvmeof": true,
          "pd_num": 0,
          "raid5": true,
          "raid6": true
        }
      ],
      "nvmeof": true,
      "pd_num": 0,
      "raid5": true,
      "raid6": true
    }
  ]
}

Apply License

Method	Path
POST	/licenses

Parameters (Required Model): raid.ApplyLicenseRequest
```
{
  "key": "string"
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Event

Get Event List

Method	Path
GET	/events

Parameters (Query):
- category (string): [raid]
- severity (string): [info, warning, error, critical, fatal]
- start_ts (integer): 10-digit epoch time: example(1705997428)

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "category": "string",
      "is_checked": true,
      "message": "string",
      "severity": "string",
      "timestamp": 0,
      "uuid": "string"
    }
  ]
}

Delete Events

Method	Path
DELETE	/events

Parameters (Required Model): events.EventDeleteRequest

{
  "category": "raid",
  "end_time": 0,
  "severity": "info|warning|error|critical|all",
  "start_time": 0
}

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Delete ALL Events

Method	Path
DELETE	/events/all

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Get Event

Method	Path
GET	/events/

Parameters (Required Path): id (integer)

Responses: 200 OK(please refer to the status code section)

{
  "code": 0,
  "data": {
    "category": "string",
    "is_checked": true,
    "message": "string",
    "severity": "string",
    "timestamp": 0,
    "uuid": "string"
  }
}

Delete Event

Method	Path
DELETE	/events/

Parameters (Required Path): id (integer, required)
Responses: 200 OK(please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Users

Get Users list

Method	Path
GET	/users

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "account": "string",
      "created_at": 0,
      "email": "example@example.com",
      "id": "0",
      "modified_at": 0,
      "name": "display name",
      "notification": {
        "categories": [
          "string"
        ],
        "on": true,
        "severity": "string"
      },
      "permissions": [
        "string"
      ],
      "role": "string"
    }
  ]
}

Get Users information

Method	Path
GET	/users/

Parameters (Required Path): id (integer)

Responses: 200 OK(please refer to the status code section)

{
  "code": 0,
  "data": {
    "account": "string",
    "created_at": 0,
    "email": "example@example.com",
    "id": "0",
    "modified_at": 0,
    "name": "display name",
    "notification": {
      "categories": [
        "string"
      ],
      "on": true,
      "severity": "string"
    },
    "permissions": [
      "string"
    ],
    "role": "string"
  }
}

Create a new user

Method	Path
POST	/users

Parameters (Required Model): users.UserCreateRequest

{
  "account": "user1",
  "admin": true,
  "email": "example@example.com",
  "name": "user1",
  "password": "password1"
}

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Edit user's information

Method	Path
PUT	/users/

Parameters (Required Path): id (integer)

Parameters (Required Model): users.UserEditRequest

{
  "email": {},
  "name": {},
  "password": {},
  "role": {}
}

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Edit user's notification configuration

Method	Path
PUT	/users/{id}/notification

Parameters (Required Path): id (integer)

Parameters (Required Model): users.UserNotificationEditRequest

{
  "categories": [
    "gpuraid",
    "task"
  ],
  "on": false,
  "severity": "info|warning|error|critical"
}

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Delete a user

Method	Path
DELETE	/users/

Parameters (Required Path): id (integer)
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Physical Drive

Get physical drives list

Method	Path
GET	/physical_drives

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "assumed_clean": true,
      "critical_warning": 0,
      "dev_path": "string",
      "global_hotspare": true,
      "guid": "string",
      "hotspare_targets": [
        "string"
      ],
      "id": 0,
      "is_locating": true,
      "model": "string",
      "numa_node": 0,
      "nvme_smart_Info": {
        "available_spare": "string",
        "available_spare_threshold": "string",
        "composite_temperature": "string",
        "controller_busy_time": "string",
        "critical_composite_temperature_time": "string",
        "critical_warning": "string",
        "data_units_read": "string",
        "data_units_written": "string",
        "endurance_group_critical_warning_summary": "string",
        "host_reads_commands": "string",
        "host_writes_commands": "string",
        "media_and_data_integrity_errors": "string",
        "number_of_error_information_log_entries": "string",
        "percent_used": "string",
        "power_cycles": "string",
        "power_on_hours": "string",
        "thermal_temperature_t1_total_time": "string",
        "thermal_temperature_t1_transition_count": "string",
        "thermal_temperature_t2_total_time": "string",
        "thermal_temperature_t2_transition_count": "string",
        "unsafe_shutdown": "string",
        "warning_composite_temperature_time": "string"
      },
      "rebuild_estimate_time": 0,
      "rebuild_progress": 0,
      "rebuild_status": "string",
      "serial_number": "string",
      "size": 0,
      "slot_id": 0,
      "state": "string",
      "uuid": "string",
      "wearout": 0
    }
  ]
}

Get List of Unused Physical Drives

Method	Path
GET	/physical_drives/free

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "assumed_clean": true,
      "critical_warning": 0,
      "dev_path": "string",
      "global_hotspare": true,
      "guid": "string",
      "hotspare_targets": [
        "string"
      ],
      "id": 0,
      "is_locating": true,
      "model": "string",
      "numa_node": 0,
      "nvme_smart_Info": {
        "available_spare": "string",
        "available_spare_threshold": "string",
        "composite_temperature": "string",
        "controller_busy_time": "string",
        "critical_composite_temperature_time": "string",
        "critical_warning": "string",
        "data_units_read": "string",
        "data_units_written": "string",
        "endurance_group_critical_warning_summary": "string",
        "host_reads_commands": "string",
        "host_writes_commands": "string",
        "media_and_data_integrity_errors": "string",
        "number_of_error_information_log_entries": "string",
        "percent_used": "string",
        "power_cycles": "string",
        "power_on_hours": "string",
        "thermal_temperature_t1_total_time": "string",
        "thermal_temperature_t1_transition_count": "string",
        "thermal_temperature_t2_total_time": "string",
        "thermal_temperature_t2_transition_count": "string",
        "unsafe_shutdown": "string",
        "warning_composite_temperature_time": "string"
      },
      "rebuild_estimate_time": 0,
      "rebuild_progress": 0,
      "rebuild_status": "string",
      "serial_number": "string",
      "size": 0,
      "slot_id": 0,
      "state": "string",
      "uuid": "string",
      "wearout": 0
    }
  ]
}

Get Locating Physical Drives List

Method	Path
GET	/physical_drives/locate

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "assumed_clean": true,
      "critical_warning": 0,
      "dev_path": "string",
      "global_hotspare": true,
      "guid": "string",
      "hotspare_targets": [
        "string"
      ],
      "id": 0,
      "is_locating": true,
      "model": "string",
      "numa_node": 0,
      "nvme_smart_Info": {
        "available_spare": "string",
        "available_spare_threshold": "string",
        "composite_temperature": "string",
        "controller_busy_time": "string",
        "critical_composite_temperature_time": "string",
        "critical_warning": "string",
        "data_units_read": "string",
        "data_units_written": "string",
        "endurance_group_critical_warning_summary": "string",
        "host_reads_commands": "string",
        "host_writes_commands": "string",
        "media_and_data_integrity_errors": "string",
        "number_of_error_information_log_entries": "string",
        "percent_used": "string",
        "power_cycles": "string",
        "power_on_hours": "string",
        "thermal_temperature_t1_total_time": "string",
        "thermal_temperature_t1_transition_count": "string",
        "thermal_temperature_t2_total_time": "string",
        "thermal_temperature_t2_transition_count": "string",
        "unsafe_shutdown": "string",
        "warning_composite_temperature_time": "string"
      },
      "rebuild_estimate_time": 0,
      "rebuild_progress": 0,
      "rebuild_status": "string",
      "serial_number": "string",
      "size": 0,
      "slot_id": 0,
      "state": "string",
      "uuid": "string",
      "wearout": 0
    }
  ]
}

Get Physical Drives List of Specified NUMA Node

Method	Path
GET	/physical_drives/numa/

Parameters (Required path): node (integer)

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "assumed_clean": true,
      "critical_warning": 0,
      "dev_path": "string",
      "global_hotspare": true,
      "guid": "string",
      "hotspare_targets": [
        "string"
      ],
      "id": 0,
      "is_locating": true,
      "model": "string",
      "numa_node": 0,
      "nvme_smart_Info": {
        "available_spare": "string",
        "available_spare_threshold": "string",
        "composite_temperature": "string",
        "controller_busy_time": "string",
        "critical_composite_temperature_time": "string",
        "critical_warning": "string",
        "data_units_read": "string",
        "data_units_written": "string",
        "endurance_group_critical_warning_summary": "string",
        "host_reads_commands": "string",
        "host_writes_commands": "string",
        "media_and_data_integrity_errors": "string",
        "number_of_error_information_log_entries": "string",
        "percent_used": "string",
        "power_cycles": "string",
        "power_on_hours": "string",
        "thermal_temperature_t1_total_time": "string",
        "thermal_temperature_t1_transition_count": "string",
        "thermal_temperature_t2_total_time": "string",
        "thermal_temperature_t2_transition_count": "string",
        "unsafe_shutdown": "string",
        "warning_composite_temperature_time": "string"
      },
      "rebuild_estimate_time": 0,
      "rebuild_progress": 0,
      "rebuild_status": "string",
      "serial_number": "string",
      "size": 0,
      "slot_id": 0,
      "state": "string",
      "uuid": "string",
      "wearout": 0
    }
  ]
}

Get Single Physical Drive Description

Method	Path
GET	/physical_drives/{uuid}

Parameters (Required Path): uuid (string)

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "assumed_clean": true,
    "critical_warning": 0,
    "dev_path": "string",
    "global_hotspare": true,
    "guid": "string",
    "hotspare_targets": [
      "string"
    ],
    "id": 0,
    "is_locating": true,
    "model": "string",
    "numa_node": 0,
    "nvme_smart_Info": {
      "available_spare": "string",
      "available_spare_threshold": "string",
      "composite_temperature": "string",
      "controller_busy_time": "string",
      "critical_composite_temperature_time": "string",
      "critical_warning": "string",
      "data_units_read": "string",
      "data_units_written": "string",
      "endurance_group_critical_warning_summary": "string",
      "host_reads_commands": "string",
      "host_writes_commands": "string",
      "media_and_data_integrity_errors": "string",
      "number_of_error_information_log_entries": "string",
      "percent_used": "string",
      "power_cycles": "string",
      "power_on_hours": "string",
      "thermal_temperature_t1_total_time": "string",
      "thermal_temperature_t1_transition_count": "string",
      "thermal_temperature_t2_total_time": "string",
      "thermal_temperature_t2_transition_count": "string",
      "unsafe_shutdown": "string",
      "warning_composite_temperature_time": "string"
    },
    "rebuild_estimate_time": 0,
    "rebuild_progress": 0,
    "rebuild_status": "string",
    "serial_number": "string",
    "size": 0,
    "slot_id": 0,
    "state": "string",
    "uuid": "string",
    "wearout": 0
  }
}

Create a Physical Drive

Method	Path
POST	/physical_drives

Parameters (Required Model: raid.PhysicalDriveCreateRequest
```
{
  "device": "\<DEVICE_PATH\>|\<NQN\>|\<WWID\>"
}
```

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "pd_uuid": "string"
  }
}

Delete a Physical Drive

Method	Path
DELETE	/physical_drives/{uuid}

Parameters (Required path): uuid (string)
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Mark a Physical Drive

Method	Path
PUT	/physical_drives/{uuid}/marker

Parameters (Required path): uuid (string)
Parameters (Required Model): raid.PhysicalDriveMarkerRequest
- online: state will be 'online'
- offline: state will be 'offline'
- good: state will be 'unconfigured_good'
- bad: state will be 'unconfigured_bad'
```
{
  "marker": "online | offline | good | bad"
}
 
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Replace a Physical Drive

Method	Path
POST	/physical_drives/{uuid}/replace

Parameters (Required Path): uuid (string)

Parameters (Required Model): raid.PhysicalDriveReplaceRequest

{
  "new_device": "\<DEVICE_PATH\>|\<NQN\>|\<WWID\>"
}

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Locate a Physical Drive

Method	Path
POST	/physical_drives/{uuid}/locate

Parameters (Required Path): uuid (string)
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Unlocate a Physical Drive

Method	Path
DELETE	/physical_drives/{uuid}/locate

Parameters (Required Path): uuid (string)
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Assign a Physical Drive as Hot Spare For Specific Drive Group(s)

Method	Path
PUT	/physical_drives/{uuid}/hotspare

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.PhysicalDriveSetHotspareRequest
```
{
  "dg_uuids": [
    "string"
  ]
}
```
Responses: 200OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Assign a Physical Drive as Global Hot Spare

Method	Path
POST	/physical_drives/{uuid}/hotspare/global

Parameters (Required path): uuid (string)
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Revoke a Physical Drive from Global Hot Spare

Method	Path
DELETE	/physical_drives/{uuid}/hotspare/global

Parameters (Required path): uuid (string)
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Drive Groups

Get Drive Group List

Method	Path
GET	/drive_groups

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "assume_clean": true,
      "auto_failover": true,
      "cc_error": true,
      "cc_running": true,
      "cc_speed": "string",
      "copyback_dst_pd_uuid": "string",
      "copyback_running": true,
      "copyback_spare": true,
      "copyback_speed": "string",
      "copyback_src_pd_uuid": "string",
      "free": 0,
      "fw_rev": "string",
      "id": 0,
      "init_speed": "string",
      "journal_mode": "string",
      "journal_support": true,
      "mode": "string",
      "model": "string",
      "nqn": "string",
      "pd_uuids": [
        "string"
      ],
      "prefer_controller": "string",
      "rebuild_speed": "string",
      "resync_speed": "string",
      "running_controller": "string",
      "serial": "string",
      "size": 0,
      "spdk_bdev": true,
      "state": "string",
      "strip_size": 0,
      "sync_estimate_time": 0,
      "sync_progress": 0,
      "used_size": 0,
      "uuid": "string",
      "vd_num": 0,
      "vendor": "string"
    }
  ]
}

Get Drive Group Description

Method	Path
GET	/drive_groups/{uuid}

Parameters (Required Path): uuid (string)

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "assume_clean": true,
    "auto_failover": true,
    "cc_error": true,
    "cc_running": true,
    "cc_speed": "string",
    "copyback_dst_pd_uuid": "string",
    "copyback_running": true,
    "copyback_spare": true,
    "copyback_speed": "string",
    "copyback_src_pd_uuid": "string",
    "free": 0,
    "fw_rev": "string",
    "id": 0,
    "init_speed": "string",
    "journal_mode": "string",
    "journal_support": true,
    "mode": "string",
    "model": "string",
    "nqn": "string",
    "pd_uuids": [
      "string"
    ],
    "prefer_controller": "string",
    "rebuild_speed": "string",
    "resync_speed": "string",
    "running_controller": "string",
    "serial": "string",
    "size": 0,
    "spdk_bdev": true,
    "state": "string",
    "strip_size": 0,
    "sync_estimate_time": 0,
    "sync_progress": 0,
    "used_size": 0,
    "uuid": "string",
    "vd_num": 0,
    "vendor": "string"
  }
}

Get Physical Drive List Belonging to The Specified Drive Group

Method	Path
GET	/drive_groups/{uuid}/physical_drives

Parameters (Required Path): uuid (string)

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "assumed_clean": true,
      "critical_warning": 0,
      "dev_path": "string",
      "global_hotspare": true,
      "guid": "string",
      "hotspare_targets": [
        "string"
      ],
      "id": 0,
      "is_locating": true,
      "model": "string",
      "numa_node": 0,
      "nvme_smart_Info": {
        "available_spare": "string",
        "available_spare_threshold": "string",
        "composite_temperature": "string",
        "controller_busy_time": "string",
        "critical_composite_temperature_time": "string",
        "critical_warning": "string",
        "data_units_read": "string",
        "data_units_written": "string",
        "endurance_group_critical_warning_summary": "string",
        "host_reads_commands": "string",
        "host_writes_commands": "string",
        "media_and_data_integrity_errors": "string",
        "number_of_error_information_log_entries": "string",
        "percent_used": "string",
        "power_cycles": "string",
        "power_on_hours": "string",
        "thermal_temperature_t1_total_time": "string",
        "thermal_temperature_t1_transition_count": "string",
        "thermal_temperature_t2_total_time": "string",
        "thermal_temperature_t2_transition_count": "string",
        "unsafe_shutdown": "string",
        "warning_composite_temperature_time": "string"
      },
      "rebuild_estimate_time": 0,
      "rebuild_progress": 0,
      "rebuild_status": "string",
      "serial_number": "string",
      "size": 0,
      "slot_id": 0,
      "state": "string",
      "uuid": "string",
      "wearout": 0
    }
  ]
}

Get Virtual Drive list of a Drive Group

Method	Path
GET	/drive_groups/{uuid}/virtual_drives

Parameters (Required path): uuid (string)

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "backend_dg_id": 0,
      "backend_uuid": "string",
      "backend_vd_id": 0,
      "cache_dg_id": 0,
      "cache_state": "string",
      "cache_uuid": "string",
      "cache_vd_id": 0,
      "dev_path": "string",
      "dg_id": 0,
      "dg_uuid": "string",
      "export_targets": [
        {
          "addr_fam": "string",
          "id": 0,
          "iface": "string",
          "iface_ip": "string",
          "service_id": "string",
          "spdk": true,
          "subsystems": [
            {
              "dev_path": "string",
              "name": "string",
              "vd_uuid": "string"
            }
          ],
          "trans_type": "string",
          "uuid": "string"
        }
      ],
      "id": 0,
      "serial": "string",
      "size": 0,
      "spdk": true,
      "spdk_512e": true,
      "state": "string",
      "uuid": "string"
    }
  ]
}

Create a Drive Group

Method	Path
POST	/drive_groups

Parameters (Required Model): raid.DriveGroupCreateRequest

{
  "init_type": "default|background|foreground",
  "journal": "default|on|off",
  "mode": "raid0",
  "pd_uuids": [
    "string"
  ],
  "prefer_controller_uuid": "string",
  "strip_size": 4
}

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "dg_uuid": "string"
  }
}

Import Linux MD

Method	Path
POST	/drive_groups/md

Parameters (Required Model): raid.DriveGroupMdImportRequest

{
  "device_1": "\<DEVICE_PATH\>|\<NQN\>|\<WWID\>",
  "device_2": "\<DEVICE_PATH\>|\<NQN\>|\<WWID\>"
}

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "dg_uuid": "string"
  }
}

Delete a Drive Group

Method	Path
DELETE	/drive_groups/{uuid}

Parameters (Required Path): uuid (string)
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Enable/disable auto failover of a drive group

Method	Path
PUT	/drive_groups/{uuid}/auto_failover

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.DriveGroupSetAutoFailoverRequest
```
{
  "enable": false
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Adjust the Consistency Check Speed of a Drive Group

Method	Path
PUT	/drive_groups/{uuid}/cc_speed

Parameters (Required path): uuid (string)
Parameters (Required Model): raid.DriveGroupSetSpeedRequest
```
{
  "speed": "low|normal|high|extreme"
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Set the Controller of a Drive Group

Method	Path
PUT	/drive_groups/{uuid}/controller

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.DriveGroupSetCxRequest
```
{
  "cx_uuid": "string"
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Adjust the Copyback Speed of a Drive Group

Method	Path
PUT	/drive_groups/{uuid}/copyback_speed

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.DriveGroupSetSpeedRequest
```
{
  "speed": "low|normal|high|extreme"
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Adjust the Init Speed of a Drive Group

Method	Path
PUT	/drive_groups/{uuid}/init_speed

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.DriveGroupSetSpeedRequest
```
{
  "speed": "low|normal|high|extreme"
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Set Journal Mode of a Drive Group

Method	Path
PUT	/drive_groups/{uuid}/journal

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.DriveGroupSetJournalModeRequest
```
{
  "mode": "always_on|always_off|degrade_only"
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Adjust the Rebuild Speed of a Drive Group

Method	Path
PUT	/drive_groups/{uuid}/rebuild_speed

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.DriveGroupSetSpeedRequest
```
{
  "speed": "low|normal|high|extreme"
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Enable the Rescue Mode of a Drive Group

Method	Path
PUT	/drive_groups/{uuid}/rescue_mode

Parameters (Required path): uuid (string)
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Adjust the Resync Speed of a Drive Group

Method	Path
PUT	/drive_groups/{uuid}/resync_speed

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.DriveGroupSetSpeedRequest
```
{
  "speed": "low|normal|high|extreme"
}
```
Responses:200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Enable/Disable SPDK of a Drive Group

Method	Path
PUT	/drive_groups/{uuid}/spdk_bdev

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.DriveGroupSetAutoFailoverRequest
```
{
  "enable": false
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Adjust the VD Transform Speed of a Drive Group

Method	Path
PUT	/drive_groups/{uuid}/transform_speed

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.DriveGroupSetSpeedRequest
```
{
  "speed": "low|normal|high|extreme"
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Locate a Drive Group

Method	Path
POST	/drive_groups/{uuid}/locate

Parameters (Required Path): uuid (string)
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Unlocate a Drive Group

Method	Path
DELETE	/drive_groups/{uuid}/locate

Parameters (Required Path): uuid (string)
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Start a Task for Copyback

Method	Path
POST	/drive_groups/{uuid}/copyback

Parameters (Required Path): uuid (string)

Parameters (Required Model): raid.DriveGroupStartCopyback

{
  "dst_pd_uuid": "string",
  "spare": true,
  "src_pd_uuid": "string"
}

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Stop a Task for Copyback

Method	Path
DELETE	/drive_groups/{uuid}/copyback

Parameters (Required Path): uuid (string)
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Virtual Drives

Get Virtual Drive List

Method	Path
GET	/virtual_drives

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "backend_dg_id": 0,
      "backend_uuid": "string",
      "backend_vd_id": 0,
      "cache_dg_id": 0,
      "cache_state": "string",
      "cache_uuid": "string",
      "cache_vd_id": 0,
      "dev_path": "string",
      "dg_id": 0,
      "dg_uuid": "string",
      "export_targets": [
        {
          "addr_fam": "string",
          "id": 0,
          "iface": "string",
          "iface_ip": "string",
          "service_id": "string",
          "spdk": true,
          "subsystems": [
            {
              "dev_path": "string",
              "name": "string",
              "vd_uuid": "string"
            }
          ],
          "trans_type": "string",
          "uuid": "string"
        }
      ],
      "id": 0,
      "serial": "string",
      "size": 0,
      "spdk": true,
      "spdk_512e": true,
      "state": "string",
      "uuid": "string"
    }
  ]
}

Get Virtual Drive Description

Method	Path
GET	/virtual_drives/{uuid}

Parameters (Required Path): uuid (string)

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "backend_dg_id": 0,
    "backend_uuid": "string",
    "backend_vd_id": 0,
    "cache_dg_id": 0,
    "cache_state": "string",
    "cache_uuid": "string",
    "cache_vd_id": 0,
    "dev_path": "string",
    "dg_id": 0,
    "dg_uuid": "string",
    "export_targets": [
      {
        "addr_fam": "string",
        "id": 0,
        "iface": "string",
        "iface_ip": "string",
        "service_id": "string",
        "spdk": true,
        "subsystems": [
          {
            "dev_path": "string",
            "name": "string",
            "vd_uuid": "string"
          }
        ],
        "trans_type": "string",
        "uuid": "string"
      }
    ],
    "id": 0,
    "serial": "string",
    "size": 0,
    "spdk": true,
    "spdk_512e": true,
    "state": "string",
    "uuid": "string"
  }
}

Create a Virtual Drive

Method	Path
POST	/virtual_drives

Parameters (Required Model): raid.VirtualDriveCreateRequest

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "vd_uuid": "string"
  }
}

Delete a virtual drive

Method	Path
DELETE	/virtual_drives/{uuid}

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.VirtualDriveDeleteRequest
```
{
  "force": false
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Add Cache to a Virtual Drive

Method	Path
POST	/virtual_drives/{uuid}/cache

Parameters (Required Path): uuid (string)

Parameters (Required Model): raid.VirtualDriveAddCacheRequest

{
  "cache_vd_uuid": "string",
  "indirection_unit_size": 0
}

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Remove Cache from a Virtual Drive

Method	Path
DELETE	/virtual_drives/{uuid}/cache)

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.VirtualDriveRemoveCacheRequest
```
{
  "force": false
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Export a Virtual Drive to NVMe-oF Targets

Method	Path
PUT	/virtual_drives/{uuid}/export

Parameters (Required Path): uuid (string)

Parameters (Required Model): raid.VirtualDriveExportRequest

{
  "et_uuids": [
    "string"
  ],
  "spdk_512e": true
}

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Unexport a Virtual Drive from NVMe-oF Targets

Method	Path
PUT	/virtual_drives/{uuid}/unexport

Parameters (Required Path): uuid (string)

Parameters (Required Body): virtual_drives/{uuid}/unexport

{
  "et_uuids": [
    "string"
  ],
  "spdk_512e": true
}

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

NVMe Drives

Get NVMe Drive List for Physical Drive PD Candidates

Method	Path
GET	/nvme_devices

Responses:

200: OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "address": "string",
      "capacity": 0,
      "dev_path": "string",
      "fw_rev": "string",
      "model": "string",
      "nqn": "string",
      "nsid": 0,
      "numa_node": 0,
      "serial": "string",
      "vendor": "string"
    }
  ]
}

Get NVMe Drive List of Specified NUMA Node for Physical Drive Candidates

Method	Path
GET	/nvme_devices/numa/

Parameters (Required path): node (integer)

Responses: 200: OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "address": "string",
      "capacity": 0,
      "dev_path": "string",
      "fw_rev": "string",
      "model": "string",
      "nqn": "string",
      "nsid": 0,
      "numa_node": 0,
      "serial": "string",
      "vendor": "string"
    }
  ]
}

SCSI Drives

Get SCSI Drive List for Physical Drive Candidates

Method	Path
GET	/scsi_devices)

Responses: 200 OK (please refer to the status code section)


{
  "code": 0,
  "data": [
    {
      "capacity": 0,
      "dev_path": "string",
      "model": "string",
      "wwid": "string"
    }
  ]
}

Controller

Get controller list

Method	Path
GET	/controllers

Responses:

200: OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "fullname": "string",
      "gpu_uuid": "string",
      "id": 0,
      "is_expired": true,
      "license_key": "string",
      "numa_node": 0,
      "running_dg_uuids": [
        "string"
      ],
      "serial_number": "string",
      "state": "string",
      "uuid": "string"
    }
  ]
}

Get controller

Method	Path
GET	/controllers/{uuid}

Parameters (Required Path): uuid (string)

Responses:

200: OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "fullname": "string",
    "gpu_uuid": "string",
    "id": 0,
    "is_expired": true,
    "license_key": "string",
    "numa_node": 0,
    "running_dg_uuids": [
      "string"
    ],
    "serial_number": "string",
    "state": "string",
    "uuid": "string"
  }
}

Delete controller

Method	Path
DELETE	/controllers/{uuid}

Parameters (Required path): uuid (string)
Responses:
- 200: OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Disable a Controller

Method	Path
PUT	/controllers/{uuid}/disable

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.ControllerDisableRequest
```
{
  "force": false
}
```
Responses:
- 200: OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Enable a Controller

Method	Path
PUT	/controllers/{uuid}/enable

Parameters (Required path): uuid (string)
Responses:
- 200: OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Replace a Controller with License Key

Method	Path
PUT	/controllers/{uuid}/replace

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.ControllerReplaceRequest
Responses:
- 200: OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Export target

Get NVMe-oF Target List

Method	Path
GET	/export_targets

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "addr_fam": "string",
      "id": 0,
      "iface": "string",
      "iface_ip": "string",
      "service_id": "string",
      "spdk": true,
      "subsystems": [
        {
          "dev_path": "string",
          "name": "string",
          "vd_uuid": "string"
        }
      ],
      "trans_type": "string",
      "uuid": "string"
    }
  ]
}

Get NVMe-oF Target Description

Method	Path
GET	/export_targets/{uuid}

Parameters (Required Path): uuid (string)

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "addr_fam": "string",
    "id": 0,
    "iface": "string",
    "iface_ip": "string",
    "service_id": "string",
    "spdk": true,
    "subsystems": [
      {
        "dev_path": "string",
        "name": "string",
        "vd_uuid": "string"
      }
    ],
    "trans_type": "string",
    "uuid": "string"
  }
}

Create the NVMe-oF Target Port

Method	Path
POST	/export_targets

Parameters (Required Model): raid.NVMeoFCreateRequest

{
  "addr_fam": "ipv4",
  "iface_name": "ens160",
  "service_id": "4420",
  "spdk": true,
  "trans_type": "tcp | rdma"
}

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "et_uuid": "string"
  }
}

Delete a NVMe-oF Target

Method	Path
DELETE	/export_targets/{uuid}

Parameters (Required Path): uuid (string)
Parameters (Required Model): raid.NVMeoFDeleteRequest
```
{
  "force": false
}
```

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "et_uuid": "string"
  }
}

Remote target

Get Remote NVMe-oF Targets List

Method	Path
GET	/remote_targets

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "addr_fam": "string",
      "service_id": "string",
      "trans_addr": "string",
      "trans_type": "string",
      "uuid": "string"
    }
  ]
}

Get a Remote NVMe-oF Target

Method	Path
GET	/remote_targets/{uuid}

Parameters (Required Path): uuid (string)

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "addr_fam": "string",
    "service_id": "string",
    "trans_addr": "string",
    "trans_type": "string",
    "uuid": "string"
  }
}

Connect to Remote NVMe-oF Target

Method	Path
POST	/remote_targets

Parameters (Required Model): raid.RemoteTargetConnectRequest

{
  "addr_fam": "ipv4|ipv6",
  "service_id": "4260",
  "trans_addr": "1.2.3.4",
  "trans_type": "tcp|rdma|fc"
}

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "rt_uuid": "string"
  }
}

Disconnect a Remote NVMe-oF Target

Method	Path
DELETE	/remote_targets/{uuid}

Parameters (Required Path): uuid (string)
Responses:200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Consistency Check

Get Consistent Check Tasks

Method	Path
GET	/consistency_check/tasks

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": [
    {
      "aborted": true,
      "ctlr_uuid": "string",
      "cur_pos": 0,
      "dg_uuid": "string",
      "end_epoch": 0,
      "end_pos": 0,
      "manual": true,
      "nr_cc_errors": 0,
      "policy": "string",
      "running": true,
      "started_epoch": 0
    }
  ]
}

Start Consistency Check Manually

Method	Path
POST	/consistency_check/tasks

Parameters (Required Model): raid.CcStartManualTaskRequest

{
  "dg_uuids": [
    "string"
  ],
  "policy": "stop_on_error | auto_fix"
}

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Stop Current Consistency Check

Method	Path
DELETE	/consistency_check/tasks

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Get Consistent Check Setting

Method	Path
GET	/consistency_check/config

Responses: 200 OK (please refer to the status code section)

{
  "code": 0,
  "data": {
    "excluded_dgs": [
      "string"
    ],
    "next_schedule_epoch": 0,
    "policy": "string",
    "schedule_base_epoch": 0,
    "schedule_mode": "string"
  }
}

Set Excluded DGs in Consistency Check

Method	Path
PUT	/consistency_check/config/excluded_dgs

Parameters (Required Model): raid.CcSetConfigExcludedDgsRequest
```
{
  "dg_uuids": [
    "string"
  ]
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Set Consistent Check Policy

Method	Path
PUT	/consistency_check/config/policy

Parameters (Required Model): raid.CcSetConfigPolicyRequest
```
{
  "policy": "stop_on_error | auto_fix"
}
```
Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Set Consistent Check Schedule

Method	Path
PUT	/consistency_check/config/schedule

Parameters (Required Model): raid.CcSetConfigScheduleRequest

{
  "base_epoch": 1698768000,
  "mode": "off | continuously | hourly | daily | weekly | monthly"
}

Responses: 200 OK (please refer to the status code section)
```
{
  "code": 0,
  "data": {}
}
```

Models

auth.GenerateTokenRequest

Property	Type	Description
`password`	string	required

auth.GenerateTokenResponse

Property	Type	Description
`expired_timestamp`	integer
`token`	string

auth.SetupAuthRequest

Property	Type	Description
`host_token`	string
`password`	string

common.NVMeSMARTInfo

Property	Type	Description
`available_spare`	string
`available_spare_threshold`	string
`composite_temperature`	string
`controller_busy_time`	string
`critical_composite_temperature_time`	string
`critical_warning`	string
`data_units_read`	string
`data_units_written`	string
`endurance_group_critical_warning_summary`	string
`host_reads_commands`	string
`host_writes_commands`	string
`media_and_data_integrity_errors`	string
`number_of_error_information_log_entries`	string
`percent_used`	string
`power_cycles`	string
`power_on_hours`	string
`thermal_temperature_t1_total_time`	string
`thermal_temperature_t1_transition_count`	string
`thermal_temperature_t2_total_time`	string
`thermal_temperature_t2_transition_count`	string
`unsafe_shutdown`	string
`warning_composite_temperature_time`	string

common.UserInfo

Property	Type	Description
`account`	string
`created_at`	integer	required
`email`	string	example: example@example.com
`id`	string ($uint32)	example: 0
`modified_at`	integer
`name`	string
`notification`	common.UserNotification	required
`permissions`		required
`role`	string	required

common.UserNotification

Property	Type	Description
`categories`	string	required
`on`	boolean
`severity`	string	required

events.Event

Property	Type	Description
`category`	string
`is_checked`	boolean
`message`	string
`severity`	string
`timestamp`	integer
`uuid`	string

events.EventDeleteRequest

Property	Type	Description
`category`	string	example: raid
`end_time`	integer
`severity`	string	example: info\|warning\|error\|critical\|all
`start_time`	integer

meta.Version

Property	Type	Description
`gpuraid`	string	example: 9.9.9-999.g12345678.999
`graidmgr`	string	example: 1.0.1

meta.Version

Property	Type	Description
`gpuraid`	string	example: 9.9.9-999.g12345678.999
`graidmgr`	string	example: 1.0.1

mo.Option-string

raid.ApplyLicenseRequest

Property	Type	Description
`key`	string	required

raid.CcSetConfigExcludedDgsRequest

Property	Type	Description
`dg_uuids`	string	required

raid.CcSetConfigPolicyRequest

Property	Type	Description
`policy`	string	required. example: stop_on_error\|auto_fix

raid.CcSetConfigScheduleRequest

Property	Type	Description
`base_epoch`	integer	example: 1698768000
`mode`	integer	required. example: off\|continuously\|hourly\|daily\|weekly\|monthly

raid.CcStartManualTaskRequest

Property	Type	Description
`dg_uuids`	string
`policy`	string	example: stop_on_error\|auto_fix

raid.ConsistencyCheckSetting

Property	Type	Description
`excluded_dgs`	string	required
`next_schedule_epoch`	integer	required
`policy`	string	required
`schedule_base_epoch`	integer	required
`schedule_mode`	string	required

raid.ConsistencyCheckTask

Property	Type	Description
`aborted`	boolean	required
`ctlr_uuid`	string	required
`cur_pos`	integer	required
`dg_uuid`	string	required
`end_epoch`	integer	required
`end_pos`	integer	required
`manual`	boolean	required
`nr_cc_errors`	integer	required
`policy`	string	required
`running`	boolean	required
`started_epoch`	integer	required

raid.ControllerDisableRequest

Property	Type	Description
`force`	boolean	default: false

raid.ControllerInfo

Property	Type	Description
`fullname`	string	required
`gpu_uuid`	string	required
`id`	integer	required
`is_expired`	boolean	required
`license_key`	string	required
`numa_node`	integer	required
`running_dg_uuids`	string	required
`serial_number`	string	required
`state`	string	required
`uuid`	string	required

raid.ControllerReplaceRequest

Property	Type	Description
`license_key`	string	required

raid.DriveGroupCreateRequest

Property	Type	Description
`init_type`	string	required. example: default\|background\|foreground
`journal`	string	required. example: default\|on\|off
`mode`	string	required. default: raid0
`pd_uuids`	string	required
`prefer_controller_uuid`	string
`strip_size`	integer	default: 4, example: 4

raid.DriveGroupCreateResult

Property	Type	Description
`dg_uuid`	string

raid.DriveGroupInfo

Property	Type	Description
`assume_clean`	boolean
`auto_failover`	boolean
`cc_error`	boolean
`cc_running`	boolean
`cc_speed`	string
`copyback_dst_pd_uuid`	string
`copyback_running`	boolean
`copyback_spare`	boolean
`copyback_speed`	string
`copyback_src_pd_uuid`	string
`free`	integer
`fw_rev`	string
`id`	integer
`init_speed`	string
`journal_mode`	string
`journal_support`	boolean
`mode`	string
`model`	string
`nqn`	string
`pd_uuids`	string
`prefer_controller`	string
`rebuild_speed`	string
`resync_speed`	string
`running_controller`	string
`serial`	string
`size`	integer
`spdk_bdev`	boolean
`state`	string
`strip_size`	integer
`sync_estimate_time`	integer
`sync_progress`	number
`used_size`	integer
`uuid`	string
`vd_num`	integer
`vendor`	string

raid.DriveGroupMdImportRequest

Property	Type	Description
`device_1`	string	required. example: <DEVICE_PATH>\|<NQN>\|<WWID>
`device_2`	string	required. example: <DEVICE_PATH>\|<NQN>\|<WWID>

raid.DriveGroupSetAutoFailoverRequest

Property	Type	Description
`enable`	boolean	default: false

raid.DriveGroupSetCxRequest

Property	Type	Description
`cx_uuid`	string	required

raid.DriveGroupSetJournalModeRequest

Property	Type	Description
`mode`	string	default: degrade_only, example: always_on\|always_off\|degrade_only

raid.DriveGroupSetSpeedRequest

Property	Type	Description
`speed`	string	required. example: low\|normal\|high\|extreme

raid.DriveGroupStartCopyback

Property	Type	Description
`dst_pd_uuid`	string	required.
`spare`	boolean
`src_pd_uuid`	string	required.

raid.ExportTargetInfo

Property	Type	Description
`addr_fam`	string	required.
`id`	integer	required.
`iface`	string	required.
`iface_ip`	string	required.
`service_id`	string	required.
`spdk`	boolean
`subsystems`	raid.ExportTargetSubsystem	required
`trans_type`	string	required.
`uuid`	string	required.

raid.ExportTargetSubsystem

Property	Type	Description
`dev_path`	string	required
`name`	string	required
`vd_uuid`	string	required

raid.LicenseInfo

Property	Type	Description
`active`	boolean	required
`expired`	boolean	required
`ha`	boolean	required
`keys`	raid.LicenseKey	required
`nvmeof`	boolean	required
`pd_num`	integer	required
`raid5`	boolean	required
`raid6`	boolean	required

raid.LicenseKey

Property	Type	Description
`expired_date`	string	required
`expired_remain_days`	integer	required
`ha`	boolean	required
`key`	string	required
`nvmeof`	boolean	required
`pd_num`	integer	required
`raid5`	boolean	required
`raid6`	boolean	required

raid.NVMeDriveInfo

Property	Type	Description
`address`	string
`capacity`	integer
`dev_path`	string
`fw_rev`	string
`model`	string
`nqn`	string
`nsid`	integer
`numa_node`	integer
`serial`	string
`vendor`	string

raid.NVMeoFCreateRequest

Property	Type	Description
`addr_fam`	string	example: ipv4
`iface_name`	string	example: ens160
`service_id`	string	example: 4420
`spdk`	boolean
`trans_type`	string	example: tcp \| rdma

raid.NVMeoFCreateResult

Property	Type	Description
`et_uuid`	string	required

raid.NVMeoFDeleteRequest

Property	Type	Description
`force`	boolean	default: false

raid.PhysicalDriveCreateRequest

Property	Type	Description
`device`	string	required. example: <DEVICE_PATH>\|<NQN>\|<WWID>

raid.PhysicalDriveCreateResult

Property	Type	Description
`pd_uuid`	string

raid.PhysicalDriveInfo

Property	Type	Description
`assumed_clean`	boolean
`critical_warning`	integer
`dev_path`	string	required
`global_hotspare`	boolean	required
`guid`	string	required
`hotspare_targets`	string	required
`id`	integer	required
`is_locating`	boolean	required
`model`	string	required
`numa_node`	integer	required
`nvme_smart_Info`	common.NVMeSMARTInfo
`rebuild_estimate_time`	integer	required
`rebuild_progress`	number	required
`rebuild_status`	string
`serial_number`	string
`size`	integer	required
`slot_id`	integer	required
`state`	string	required
`uuid`	string	required
`wearout`	integer	required

raid.PhysicalDriveMarkerRequest

Property	Type	Description
`marker`	string	required. example: online \| offline \| good \| bad

raid.PhysicalDriveReplaceRequest

Property	Type	Description
`new_device`	string	required. example: <DEVICE_PATH>\|<NQN>\|<WWID>

raid.PhysicalDriveSetHotspareRequest

Property	Type	Description
`dg_uuids`	string

raid.RemoteTargetConnectRequest

Property	Type	Description
`addr_fam`	string	example: ipv4\|ipv6
`service_id`	string	example: 4260
`trans_addr`	string	example: 1.2.3.4
`trans_type`	string	example: tcp\|rdma\|fc

raid.RemoteTargetConnectResult

Property	Type	Description
rt_uuid*	string	required

raid.RemoteTargetInfo

Property	Type	Description
`addr_fam`	string	required
`service_id`	string	required
`trans_addr`	string	required
`trans_type`	string	required
`uuid`	string	required

raid.SCSiDriveInfo

Property	Type	Description
`capacity`	integer
`dev_path`	string
`model`	string
`wwid`	string

raid.VirtualDriveAddCacheRequest

Property	Type	Description
`cache_vd_uuid`	string
`indirection_unit_size`	integer	example: 0

raid.VirtualDriveCreateRequest

Property	Type	Description
`dg_uuid`	string	required
`serial`	string
`size`	integer	default: 0

raid.VirtualDriveCreateResult

Property	Type	Description
`vd_uuid`	string	required

raid.VirtualDriveDeleteRequest

Property	Type	Description
`force`	boolean	default: false

raid.VirtualDriveExportRequest

Property	Type	Description
`et_uuids`	string	required
`spdk_512e`	boolean

raid.VirtualDriveInfo

Property	Type	Description
`backend_dg_id`	integer	required
`backend_uuid`	string	required
`backend_vd_id`	integer	required
`cache_dg_id`	integer	required
`cache_state`	string	required
`cache_uuid`	string	required
`cache_vd_id`	integer	required
`dev_path`	string	required
`dg_id`	integer	required
`dg_uuid`	string	required
`export_targets`	raid.ExportTargetInfo	required
`id`	integer	required
`serial`	string	required
`size`	integer	required
`spdk`	boolean
`spdk_512e`	boolean
`state`	string	required
`uuid`	string	required

raid.VirtualDriveRemoveCacheRequest

Property	Type	Description
`force`	boolean	default: false

users.UserCreateRequest

Property	Type	Description
`account`	string	required. example: user1
`admin`	boolean
`email`	string	example: example@example.com
`name`	string	required. example: user1
`password`	string	required. example: password1

users.UserEditRequest

Property	Type	Description
`email`	mo.Option-string
`name`	mo.Option-string
`password`	mo.Option-string
`role`	mo.Option-string

users.UserNotificationEditRequest

Property	Type	Description
`categories`	string	required. example: List [ "gpuraid", "task" ]
`on`	boolean	example: false
`severity`	string	required. example: info\|warning\|error\|critical

Status Codes

Code	Description
0	The operation was successful.
1	The operation has been submitted for processing.
2	The operation has been submitted for processing and return with metadata.
200	The internal error occurred during the operation.
201	The provided arguments are invalid.
202	The operation is not permitted due to insufficient permissions.
203	The operation is forbidden.
300	The user login attempt failed.
301	The provided user token is invalid.
302	The specified user was not found.
303	The user already exists.
304	The provided user password is incorrect.
305	The email for the user is not verified.
306	The user isn't authorized to access this host.
307	There is no user authorized to access this host.
308	This account is reserved and cannot be used.
309	The number of users has reached the upper limit.
400	The deployment failed due to insufficient resources.
401	The host token is invalid.
402	The host is already bound with host token.
403	The host token has not been bound; please set up authentication.
500	The specified task was not found.
600	The specified event was not found.
700	We can't access the internet service of subscription.
701	The user hasn't completed the challenge.
702	Reactviate failed due to the user's subscription being inactive.
703	The inactive subscription cannot be bound for activating SE MGR.
1000	The specified controller was not found.
1001	The system disallows deleting the current controller.
1004	The controller is currently busy and cannot be disabled.
1005	The controller is not allowed to disable when in current state.
1006	The controller is not allowed to enable when in current state.
1007	The controller is not allowed to replace when in Online state.
1008	The controller is not allowed to replace a license in use.
1100	The specified NVMe drive was not found.
1200	The specified SCSI drive was not found.
1300	The specified physical drive was not found.
1302	The maximum number of physical drives has been reached.
1303	The selected drive is invalid for creating physical drive.
1304	The MD physical drive cannot perform the requested operation.
1306	The physical drive is currently in use.
1307	The hotspare setting for the physical drive is not allowed.
1309	The replacement is not allowed in current physical drive condition.
1313	The selected physical drive cannot be marked in current state.
1315	The replacement device is incompatible with the existing physical drive.
1400	The specified drive group was not found.
1404	The specified strip size is not supported for the chosen RAID mode.
1405	The number of physical drives is invalid for the chosen RAID mode.
1407	The chosen RAID mode does not support journaling.
1408	The physical drive size is insufficient for the drive group configuration.
1409	The maximum number of drive groups has been reached.
1410	The requested operation cannot be performed on an imported MD drive group.
1420	Existing state does not allow rescue mode to be enabled.
1421	The current configuration of the drive group does not support journaling.
1422	The drive group is currently busy and cannot be deleted.
1423	The specified devices are invalid for setting up multiple devices.
1426	The selected controller for the drive group is not online.
1429	The selected physical drive cannot be used to create a drive group.
1430	The selected drive group requires enabling the SPDK option before use.
1431	The physical drives comprising the target do not support this operation.
1432	The Physical Drives comprising the target are forcibly enabled.
1433	The selected drive group cannot be onlined manually.
1434	The physical drive for source of copyback is not found.
1435	The physical drive for destination of copyback is not found.
1436	The physical drive for source of copyback is not in the drive group.
1437	The specified physical drive cannot be the destination of copyback.
1438	The requested operation cannot be performed because drive group state mismatches.
1500	The specified virtual drive was not found.
1501	The maximum number of virtual drives has been reached.
1502	The specified serial number for the virtual drive is already in use.
1503	The virtual drive is currently busy and cannot be deleted.
1504	The requested operation cannot be performed because the target is an imported MD.
1505	The virtual drive cannot be utilized as a stripecache backend.
1506	Cache settings for the virtual drive have not been configured.
1507	The virtual drive cannot be utilized as a stripecache target.
1513	Stripecache does not support the specified indirection unit.
1515	The virtual drive export failed due to system errors.
1516	The virtual drive has already been exported to the current target.
1518	The cache of Virtual Drive is not clean so cannot be removed.
1519	The cache cannot be removed because it is currently unavailable.
1520	The cache cannot be removed because it is currently failed.
1521	The selected export target not exported, cannot unexport.
1522	Target drive group has insufficient free space for the virtual drive's capacity.
1523	The setting of SPDK512e for exporting virtual drives is not allowed.
1600	The specified export target was not found.
1601	Export target is busy and cannot be modified or deleted.
1602	The specified configuration already exists.
1700	The remote target was not found.
1701	Remote target is busy and cannot be modified or deleted.
1702	Remote target cannot be the same as the local device.
1703	The remote target is already connected to the system.
2003	The requested feature is not supported by the license.
2004	The maximum limit for the license has been reached.
2005	The license cannot be applied.
2008	The license cannot be applied since it's expired.
2011	The license format is invalid.
2051	Operation forbidden since the license is expired.
2052	Operation forbidden since the license hasn't been applied.
2053	Product line is not matched with the driver on the host.
2054	Product version is not supported with the driver on the host.
2055	Product model is not matched with the driver on the host.
2101	Configuration of consistency check scheduling is invalid.
2103	The consistency check target is invalid.
2104	Consistency check is in progress; only one task can run at a time.
2105	Consistency check cannot be performed because no target is defined.
3005	Address family and IP address for the host do not match.
3007	IP address for the specified network interface was not found.
3008	Specified block device for the host was not found.
3009	Specified block device for the host is currently busy.
3010	Required multi-drive configurations are unavailable for the host.
3011	Provided path for the block device is invalid.