SAN Storage API
SAN arrays, candidates, pools, and stats (v2.10)
Overview
Commands go to POST https://api.rackcorp.net/api/rest/v2.10/json.php
with Authorization: Bearer YOUR_JWT_TOKEN.
SAN records describe an array attached to a storage domain. Block volumes that use that array are managed with the Block Storage API.
POST storage.san.getall
List SAN records visible to the caller. Optional resStart and resWindow.
{
"cmd": "storage.san.getall",
"resStart": 0,
"resWindow": 50
}
POST storage.san.get
Retrieve one SAN. Pass sanid or id. The record is returned under results.
{
"cmd": "storage.san.get",
"sanid": 10
}
POST storage.san.create
{
"cmd": "storage.san.create",
"name": "syd-truenas-1",
"customerid": 456,
"storagedomainid": 3,
"type": "TRUENAS"
}
| Parameter | Required | Description |
|---|---|---|
name | Yes | Up to 64 characters. |
customerid | Yes | Customer id. |
storagedomainid | Yes | Storage domain this SAN belongs to. |
type | No | TRUENAS (default), CEPH, HITACHISDS, DELL_POWERSTORE_EXTERNAL, or HUAWEI_OCEANSTOR_EXTERNAL. |
apiuri | No | Management API URI, up to 128 characters. |
blocksize | No | Block size in bytes. |
The new record starts ACTIVE with operational status PENDING. The response includes id.
POST storage.san.candidates.getall
Hosts that can back a SAN for a customer in a datacentre. Both fields are required.
{
"cmd": "storage.san.candidates.getall",
"customerid": 456,
"dcid": 2
}
Status, pools, and stats
| Command | Purpose |
|---|---|
storage.san.status.get | Current SAN status |
storage.san.pools.get | Pools on the SAN |
storage.san.stats.get | Capacity and usage stats |
storage.san.truenas.detail | Stored TrueNAS pool usage, active volumes allocated or reported on the SAN, and datasets the poller last saw whose volume was deleted or no longer located on that SAN. Read only. Does not call TrueNAS. |
Status, pools, and stats take sanid or id.
{
"cmd": "storage.san.pools.get",
"sanid": 10
}