Storpool API Reference

1. Peers
1. List Peers
2. Tasks
1. List tasks
3. Services
1. List all Storpool services
2. List all blocked Storpool servers
4. Servers
1. List all Storpool servers
2. List all disks on server
3. Describe a disk on server
5. Clients
1. Get current configuration for all clients
2. Wait until client updates to current configuration
3. List all active requests on client
6. Disks
1. List all disks
2. Describe a disk
3. Get disk info
4. Eject a disk
5. Foget a disk
6. Soft-eject a disk
7. Pause disk soft-eject
8. Cancel disk soft-eject
9. Set a disk's description
10. List all active requests on disk
7. Volumes
1. List all volumes
2. Get volume and snapshot status
3. List a single volume
4. Describe a volume
5. Get volume info
6. List parent snapshots for volume
7. Create a new volume
8. Update a volume
9. Freeze a volume
10. Rebase a volume
11. Delete a volume
8. Snapshots
1. List all snapshots
2. List a single snapshots
3. Describe a snapshot
4. Get snapshot info
5. Snapshot a volume
6. Update snapshot
7. Rebase snapshot
8. Delete snapshot
9. Volume Rights
1. List all Attachments
2. Reassign volumes and/or snapshots
10. Placement Groups
1. List all placement groups
2. Describe single placement group
3. Create and/or update placement group
4. Delete placement group
11. Volume Templates
1. List all volume templates
2. Describe single volume template
3. Create volume template
4. Update volume template
5. Delete volume template
12. Volume Relocator
1. Turn-ON relocator
2. Turn-OFF relocator
3. Get relocator status
13. Balancer
1. Turn-ON balancer
2. Turn-OFF balancer
3. Get balancer status

Peers

List Peers (NetworkPeersList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/NetworkPeersList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/NetworkPeersList
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "PeerID": {
           "networks": {
             "NetID": {
               "mac": MAC Address
             }, ...}
         }, ...}
     }
     

   • Response Data: A dict from PeerID to PeerDesc
     • Key type: PeerID, integer, 0 <= value <= 65535
     • Value type: PeerDesc
       • networks: A dict from NetID to NetDesc
         • Key type: NetID, integer, 0 <= value <= 3
         • Value type: NetDesc
           • mac: MAC Address, string, regex ^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$

Tasks

List tasks (TasksList)

List currently active recovery tasks.

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/TasksList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/TasksList
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "allObjects": int,
         "completedObjects": int,
         "diskId": DiskID,
         "dispatchedObjects": int,
         "transactionId": long,
         "unresolvedObjects": int
       }, ...]
     }
     

   • Response Data: A list of Task
     Element type: Task
     • allObjects: int, An integer value.
     • completedObjects: int, An integer value.
     • diskId: DiskID, integer, 0 <= value <= 4095
     • dispatchedObjects: int, An integer value.
     • transactionId: long, A long integer value.
     • unresolvedObjects: int, An integer value.

Services

List all Storpool services (ServicesList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ServicesList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ServicesList
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "clients": {
           "CientID": {
             "id": CientID,
             "nodeId": NodeID,
             "status": ClientStatus,
             "version": string
           }, ...},
         "mgmt": {
           "id": 65535,
           "nodeId": NodeID,
           "status": ClientStatus,
           "version": string
         },
         "servers": {
           "ServerID": {
             "id": ServerID,
             "missingDisks": [DiskID, ...],
             "nodeId": NodeID,
             "pendingDisks": [DiskID, ...],
             "status": ServerStatus,
             "version": string
           }, ...}
       }
     }
     

   • Response Data: ClusterStatus
     • clients: A dict from CientID to Client
       • Key type: CientID, integer, 1 <= value <= 32768
       • Value type: Client
         • id: CientID, integer, 1 <= value <= 32768
         • nodeId: NodeID, integer, 0 <= value <= 63
         • status: ClientStatus, One of {running, down}
         • version: string, A string value.
     • mgmt: Mgmt
       • id: 65535, The constant value 65535.
       • nodeId: NodeID, integer, 0 <= value <= 63
       • status: ClientStatus, One of {running, down}
       • version: string, A string value.
     • servers: A dict from ServerID to Server
       • Key type: ServerID, integer, 1 <= value <= 32768
       • Value type: Server
         • id: ServerID, integer, 1 <= value <= 32768
         • missingDisks: A list of DiskID
           Element type: DiskID, integer, 0 <= value <= 4095
         • nodeId: NodeID, integer, 0 <= value <= 63
         • pendingDisks: A list of DiskID
           Element type: DiskID, integer, 0 <= value <= 4095
         • status: ServerStatus, One of {running, waiting, booting, down}
         • version: string, A string value.

List all blocked Storpool servers (ServersListBlocked)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ServersListBlocked HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ServersListBlocked
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "clients": {
           "CientID": {
             "id": CientID,
             "nodeId": NodeID,
             "status": ClientStatus,
             "version": string
           }, ...},
         "mgmt": {
           "id": 65535,
           "nodeId": NodeID,
           "status": ClientStatus,
           "version": string
         },
         "servers": {
           "ServerID": {
             "id": ServerID,
             "missingDisks": [DiskID, ...],
             "nodeId": NodeID,
             "pendingDisks": [DiskID, ...],
             "status": ServerStatus,
             "version": string
           }, ...}
       }
     }
     

   • Response Data: ClusterStatus
     • clients: A dict from CientID to Client
       • Key type: CientID, integer, 1 <= value <= 32768
       • Value type: Client
         • id: CientID, integer, 1 <= value <= 32768
         • nodeId: NodeID, integer, 0 <= value <= 63
         • status: ClientStatus, One of {running, down}
         • version: string, A string value.
     • mgmt: Mgmt
       • id: 65535, The constant value 65535.
       • nodeId: NodeID, integer, 0 <= value <= 63
       • status: ClientStatus, One of {running, down}
       • version: string, A string value.
     • servers: A dict from ServerID to Server
       • Key type: ServerID, integer, 1 <= value <= 32768
       • Value type: Server
         • id: ServerID, integer, 1 <= value <= 32768
         • missingDisks: A list of DiskID
           Element type: DiskID, integer, 0 <= value <= 4095
         • nodeId: NodeID, integer, 0 <= value <= 63
         • pendingDisks: A list of DiskID
           Element type: DiskID, integer, 0 <= value <= 4095
         • status: ServerStatus, One of {running, waiting, booting, down}
         • version: string, A string value.

Servers

List all Storpool servers (ServersList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ServersList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ServersList
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "clients": {
           "CientID": {
             "id": CientID,
             "nodeId": NodeID,
             "status": ClientStatus,
             "version": string
           }, ...},
         "mgmt": {
           "id": 65535,
           "nodeId": NodeID,
           "status": ClientStatus,
           "version": string
         },
         "servers": {
           "ServerID": {
             "id": ServerID,
             "missingDisks": [DiskID, ...],
             "nodeId": NodeID,
             "pendingDisks": [DiskID, ...],
             "status": ServerStatus,
             "version": string
           }, ...}
       }
     }
     

   • Response Data: ClusterStatus
     • clients: A dict from CientID to Client
       • Key type: CientID, integer, 1 <= value <= 32768
       • Value type: Client
         • id: CientID, integer, 1 <= value <= 32768
         • nodeId: NodeID, integer, 0 <= value <= 63
         • status: ClientStatus, One of {running, down}
         • version: string, A string value.
     • mgmt: Mgmt
       • id: 65535, The constant value 65535.
       • nodeId: NodeID, integer, 0 <= value <= 63
       • status: ClientStatus, One of {running, down}
       • version: string, A string value.
     • servers: A dict from ServerID to Server
       • Key type: ServerID, integer, 1 <= value <= 32768
       • Value type: Server
         • id: ServerID, integer, 1 <= value <= 32768
         • missingDisks: A list of DiskID
           Element type: DiskID, integer, 0 <= value <= 4095
         • nodeId: NodeID, integer, 0 <= value <= 63
         • pendingDisks: A list of DiskID
           Element type: DiskID, integer, 0 <= value <= 4095
         • status: ServerStatus, One of {running, waiting, booting, down}
         • version: string, A string value.

List all disks on server (ServerDisksList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ServerDisksList/{serverId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ServerDisksList/{serverId}
   • Arguments:
     • serverId - ServerID: integer, 1 <= value <= 32768
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "DiskID": {
           "agAllocated": int,
           "agCount": int,
           "agFree": int,
           "agFreeing": int,
           "agFull": int,
           "agMaxSizeFull": int,
           "agMaxSizePartial": int,
           "agPartial": int,
           "description": DiskDescritpion,
           "device": string,
           "empty": bool,
           "entriesAllocated": int,
           "entriesCount": int,
           "entriesFree": int,
           "generationLeft": long,
           "id": DiskID,
           "model": string,
           "objectsAllocated": int,
           "objectsCount": int,
           "objectsFree": int,
           "objectsOnDiskSize": long,
           "sectorsCount": long,
           "serial": string,
           "serverId": ServerID,
           "softEject": DiskSoftEjectStatus,
           "ssd": bool
         }, ...}
     }
     

   • Response Data: A dict from DiskID to DiskSummary
     • Key type: DiskID, integer, 0 <= value <= 4095
     • Value type: DiskSummary
       • agAllocated: int, An integer value.
       • agCount: int, An integer value.
       • agFree: int, An integer value.
       • agFreeing: int, An integer value.
       • agFull: int, An integer value.
       • agMaxSizeFull: int, An integer value.
       • agMaxSizePartial: int, An integer value.
       • agPartial: int, An integer value.
       • description: DiskDescritpion, string, regex ^[A-Za-z0-9_\- ]{,30}$
       • device: string, A string value.
       • empty: bool, true or false.
       • entriesAllocated: int, An integer value.
       • entriesCount: int, An integer value.
       • entriesFree: int, An integer value.
       • generationLeft: long, A long integer value.
       • id: DiskID, integer, 0 <= value <= 4095
       • model: string, A string value.
       • objectsAllocated: int, An integer value.
       • objectsCount: int, An integer value.
       • objectsFree: int, An integer value.
       • objectsOnDiskSize: long, A long integer value.
       • sectorsCount: long, A long integer value.
       • serial: string, A string value.
       • serverId: ServerID, integer, 1 <= value <= 32768
       • softEject: DiskSoftEjectStatus, One of {on, off, paused}
       • ssd: bool, true or false.

Describe a disk on server (ServerDiskDescribe)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ServerDiskDescribe/{serverId}/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ServerDiskDescribe/{serverId}/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
     • serverId - ServerID: integer, 1 <= value <= 32768
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "agAllocated": int,
         "agCount": int,
         "agFree": int,
         "agFreeing": int,
         "agFull": int,
         "agMaxSizeFull": int,
         "agMaxSizePartial": int,
         "agPartial": int,
         "description": DiskDescritpion,
         "device": string,
         "empty": bool,
         "entriesAllocated": int,
         "entriesCount": int,
         "entriesFree": int,
         "generationLeft": long,
         "id": DiskID,
         "model": string,
         "objects": {
           "int": {
             "generation": long,
             "objectId": int,
             "onDiskSize": int,
             "parentVolume": string,
             "state": ObjectState,
             "storedSize": int,
             "version": long,
             "volume": string,
             "volumeId": long
           }, ...},
         "objectsAllocated": int,
         "objectsCount": int,
         "objectsFree": int,
         "objectsOnDiskSize": long,
         "sectorsCount": long,
         "serial": string,
         "serverId": ServerID,
         "softEject": DiskSoftEjectStatus,
         "ssd": bool
       }
     }
     

   • Response Data: Disk
     • agAllocated: int, An integer value.
     • agCount: int, An integer value.
     • agFree: int, An integer value.
     • agFreeing: int, An integer value.
     • agFull: int, An integer value.
     • agMaxSizeFull: int, An integer value.
     • agMaxSizePartial: int, An integer value.
     • agPartial: int, An integer value.
     • description: DiskDescritpion, string, regex ^[A-Za-z0-9_\- ]{,30}$
     • device: string, A string value.
     • empty: bool, true or false.
     • entriesAllocated: int, An integer value.
     • entriesCount: int, An integer value.
     • entriesFree: int, An integer value.
     • generationLeft: long, A long integer value.
     • id: DiskID, integer, 0 <= value <= 4095
     • model: string, A string value.
     • objects: A dict from int to DiskObject
       • Key type: int, An integer value.
       • Value type: DiskObject
         • generation: long, A long integer value.
         • objectId: int, An integer value.
         • onDiskSize: int, An integer value.
         • parentVolume: string, A string value.
         • state: ObjectState, ObjectState, enumeration from 0 to 9
         • storedSize: int, An integer value.
         • version: long, A long integer value.
         • volume: string, A string value.
         • volumeId: long, A long integer value.
     • objectsAllocated: int, An integer value.
     • objectsCount: int, An integer value.
     • objectsFree: int, An integer value.
     • objectsOnDiskSize: long, A long integer value.
     • sectorsCount: long, A long integer value.
     • serial: string, A string value.
     • serverId: ServerID, integer, 1 <= value <= 32768
     • softEject: DiskSoftEjectStatus, One of {on, off, paused}
     • ssd: bool, true or false.

Clients

Get current configuration for all clients (ClientsConfigDump)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ClientsConfigDump HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ClientsConfigDump
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "clientGeneration": long,
         "configStatus": client status,
         "delay": int,
         "generation": long,
         "id": CientID
       }, ...]
     }
     

   • Response Data: A list of ClientConfigStatus
     Element type: ClientConfigStatus
     • clientGeneration: long, A long integer value.
     • configStatus: client status, One of {ok, updating, down}
     • delay: int, An integer value.
     • generation: long, A long integer value.
     • id: CientID, integer, 1 <= value <= 32768

Wait until client updates to current configuration (ClientConfigWait)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ClientConfigWait/{clientId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ClientConfigWait/{clientId}
   • Arguments:
     • clientId - CientID: integer, 1 <= value <= 32768
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "clientGeneration": long,
         "configStatus": client status,
         "delay": int,
         "generation": long,
         "id": CientID
       }, ...]
     }
     

   • Response Data: A list of ClientConfigStatus
     Element type: ClientConfigStatus
     • clientGeneration: long, A long integer value.
     • configStatus: client status, One of {ok, updating, down}
     • delay: int, An integer value.
     • generation: long, A long integer value.
     • id: CientID, integer, 1 <= value <= 32768

List all active requests on client (ClientActiveRequests)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/ClientActiveRequests/{clientId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/ClientActiveRequests/{clientId}
   • Arguments:
     • clientId - CientID: integer, 1 <= value <= 32768
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "clientId": CientID,
         "requests": [{
           "address": long,
           "drOp": string,
           "msecActive": int,
           "op": RequestOp,
           "prevState": string,
           "requestId": string,
           "requestIdx": int,
           "size": int,
           "state": string,
           "volumeId": long
         }, ...]
       }
     }
     

   • Response Data: ClientActiveRequests
     • clientId: CientID, integer, 1 <= value <= 32768
     • requests: A list of ActiveRequestDesc
       Element type: ActiveRequestDesc
       • address: long, A long integer value.
       • drOp: string, A string value.
       • msecActive: int, An integer value.
       • op: RequestOp, One of {read, write, merge, system, entries flush, #bad_state, #bad_drOp}
       • prevState: string, A string value.
       • requestId: string, A string value.
       • requestIdx: int, An integer value.
       • size: int, An integer value.
       • state: string, A string value.
       • volumeId: long, A long integer value.

Disks

List all disks (DisksList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/DisksList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/DisksList
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "DiskID": {
           "agAllocated": int,
           "agCount": int,
           "agFree": int,
           "agFreeing": int,
           "agFull": int,
           "agMaxSizeFull": int,
           "agMaxSizePartial": int,
           "agPartial": int,
           "description": DiskDescritpion,
           "device": string,
           "empty": bool,
           "entriesAllocated": int,
           "entriesCount": int,
           "entriesFree": int,
           "generationLeft": long,
           "id": DiskID,
           "model": string,
           "objectsAllocated": int,
           "objectsCount": int,
           "objectsFree": int,
           "objectsOnDiskSize": long,
           "sectorsCount": long,
           "serial": string,
           "serverId": ServerID,
           "softEject": DiskSoftEjectStatus,
           "ssd": bool
         }, ...}
     }
     

   • Response Data: A dict from DiskID to DiskSummary
     • Key type: DiskID, integer, 0 <= value <= 4095
     • Value type: DiskSummary
       • agAllocated: int, An integer value.
       • agCount: int, An integer value.
       • agFree: int, An integer value.
       • agFreeing: int, An integer value.
       • agFull: int, An integer value.
       • agMaxSizeFull: int, An integer value.
       • agMaxSizePartial: int, An integer value.
       • agPartial: int, An integer value.
       • description: DiskDescritpion, string, regex ^[A-Za-z0-9_\- ]{,30}$
       • device: string, A string value.
       • empty: bool, true or false.
       • entriesAllocated: int, An integer value.
       • entriesCount: int, An integer value.
       • entriesFree: int, An integer value.
       • generationLeft: long, A long integer value.
       • id: DiskID, integer, 0 <= value <= 4095
       • model: string, A string value.
       • objectsAllocated: int, An integer value.
       • objectsCount: int, An integer value.
       • objectsFree: int, An integer value.
       • objectsOnDiskSize: long, A long integer value.
       • sectorsCount: long, A long integer value.
       • serial: string, A string value.
       • serverId: ServerID, integer, 1 <= value <= 32768
       • softEject: DiskSoftEjectStatus, One of {on, off, paused}
       • ssd: bool, true or false.

Describe a disk (DiskDescribe)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/DiskDescribe/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/DiskDescribe/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "agAllocated": int,
         "agCount": int,
         "agFree": int,
         "agFreeing": int,
         "agFull": int,
         "agMaxSizeFull": int,
         "agMaxSizePartial": int,
         "agPartial": int,
         "description": DiskDescritpion,
         "device": string,
         "empty": bool,
         "entriesAllocated": int,
         "entriesCount": int,
         "entriesFree": int,
         "generationLeft": long,
         "id": DiskID,
         "model": string,
         "objects": {
           "int": {
             "generation": long,
             "objectId": int,
             "onDiskSize": int,
             "parentVolume": string,
             "state": ObjectState,
             "storedSize": int,
             "version": long,
             "volume": string,
             "volumeId": long
           }, ...},
         "objectsAllocated": int,
         "objectsCount": int,
         "objectsFree": int,
         "objectsOnDiskSize": long,
         "sectorsCount": long,
         "serial": string,
         "serverId": ServerID,
         "softEject": DiskSoftEjectStatus,
         "ssd": bool
       }
     }
     

   • Response Data: Disk
     • agAllocated: int, An integer value.
     • agCount: int, An integer value.
     • agFree: int, An integer value.
     • agFreeing: int, An integer value.
     • agFull: int, An integer value.
     • agMaxSizeFull: int, An integer value.
     • agMaxSizePartial: int, An integer value.
     • agPartial: int, An integer value.
     • description: DiskDescritpion, string, regex ^[A-Za-z0-9_\- ]{,30}$
     • device: string, A string value.
     • empty: bool, true or false.
     • entriesAllocated: int, An integer value.
     • entriesCount: int, An integer value.
     • entriesFree: int, An integer value.
     • generationLeft: long, A long integer value.
     • id: DiskID, integer, 0 <= value <= 4095
     • model: string, A string value.
     • objects: A dict from int to DiskObject
       • Key type: int, An integer value.
       • Value type: DiskObject
         • generation: long, A long integer value.
         • objectId: int, An integer value.
         • onDiskSize: int, An integer value.
         • parentVolume: string, A string value.
         • state: ObjectState, ObjectState, enumeration from 0 to 9
         • storedSize: int, An integer value.
         • version: long, A long integer value.
         • volume: string, A string value.
         • volumeId: long, A long integer value.
     • objectsAllocated: int, An integer value.
     • objectsCount: int, An integer value.
     • objectsFree: int, An integer value.
     • objectsOnDiskSize: long, A long integer value.
     • sectorsCount: long, A long integer value.
     • serial: string, A string value.
     • serverId: ServerID, integer, 1 <= value <= 32768
     • softEject: DiskSoftEjectStatus, One of {on, off, paused}
     • ssd: bool, true or false.

Get disk info (DiskGetInfo)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/DiskGetInfo/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/DiskGetInfo/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "agAllocated": int,
         "agCount": int,
         "agFree": int,
         "agFreeing": int,
         "agFull": int,
         "agMaxSizeFull": int,
         "agMaxSizePartial": int,
         "agPartial": int,
         "description": DiskDescritpion,
         "device": string,
         "empty": bool,
         "entriesAllocated": int,
         "entriesCount": int,
         "entriesFree": int,
         "generationLeft": long,
         "id": DiskID,
         "model": string,
         "objectStates": {
           "ObjectState": int, ...},
         "objectsAllocated": int,
         "objectsCount": int,
         "objectsFree": int,
         "objectsOnDiskSize": long,
         "sectorsCount": long,
         "serial": string,
         "serverId": ServerID,
         "softEject": DiskSoftEjectStatus,
         "ssd": bool,
         "volumeInfos": {
           "string": {
             "name": string,
             "objectStates": {
               "ObjectState": int, ...},
             "objectsCount": long,
             "onDiskSize": long,
             "storedSize": long
           }, ...}
       }
     }
     

   • Response Data: DiskInfo
     • agAllocated: int, An integer value.
     • agCount: int, An integer value.
     • agFree: int, An integer value.
     • agFreeing: int, An integer value.
     • agFull: int, An integer value.
     • agMaxSizeFull: int, An integer value.
     • agMaxSizePartial: int, An integer value.
     • agPartial: int, An integer value.
     • description: DiskDescritpion, string, regex ^[A-Za-z0-9_\- ]{,30}$
     • device: string, A string value.
     • empty: bool, true or false.
     • entriesAllocated: int, An integer value.
     • entriesCount: int, An integer value.
     • entriesFree: int, An integer value.
     • generationLeft: long, A long integer value.
     • id: DiskID, integer, 0 <= value <= 4095
     • model: string, A string value.
     • objectStates: A dict from ObjectState to int
       • Key type: ObjectState, ObjectState, enumeration from 0 to 9
       • Value type: int, An integer value.
     • objectsAllocated: int, An integer value.
     • objectsCount: int, An integer value.
     • objectsFree: int, An integer value.
     • objectsOnDiskSize: long, A long integer value.
     • sectorsCount: long, A long integer value.
     • serial: string, A string value.
     • serverId: ServerID, integer, 1 <= value <= 32768
     • softEject: DiskSoftEjectStatus, One of {on, off, paused}
     • ssd: bool, true or false.
     • volumeInfos: A dict from str to DiskVolumeInfo
       • Key type: string, A string value.
       • Value type: DiskVolumeInfo
         • name: string, A string value.
         • objectStates: A dict from ObjectState to int
           • Key type: ObjectState, ObjectState, enumeration from 0 to 9
           • Value type: int, An integer value.
         • objectsCount: long, A long integer value.
         • onDiskSize: long, A long integer value.
         • storedSize: long, A long integer value.

Eject a disk (DiskEject)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskEject/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/DiskEject/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Foget a disk (DiskForget)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskForget/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/DiskForget/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Soft-eject a disk (DiskSoftEject)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskSoftEject/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/DiskSoftEject/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Pause disk soft-eject (DiskSoftEjectPause)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskSoftEjectPause/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/DiskSoftEjectPause/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Cancel disk soft-eject (DiskSoftEjectCancel)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskSoftEjectCancel/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/DiskSoftEjectCancel/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Set a disk's description (DiskSetDescription)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/DiskSetDescription/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "description": DiskDescritpion
     }

   • Method: POST
   • Path: /ctrl/1.0/DiskSetDescription/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • Json: DiskDescUpdate
     • description: DiskDescritpion, string, regex ^[A-Za-z0-9_\- ]{,30}$
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

List all active requests on disk (DiskActiveRequests)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/DiskActiveRequests/{diskId} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/DiskActiveRequests/{diskId}
   • Arguments:
     • diskId - DiskID: integer, 0 <= value <= 4095
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "diskId": DiskID,
         "requests": [{
           "address": long,
           "drOp": string,
           "msecActive": int,
           "op": RequestOp,
           "prevState": string,
           "requestId": string,
           "requestIdx": int,
           "size": int,
           "state": string,
           "volumeId": long
         }, ...]
       }
     }
     

   • Response Data: DiskActiveRequests
     • diskId: DiskID, integer, 0 <= value <= 4095
     • requests: A list of ActiveRequestDesc
       Element type: ActiveRequestDesc
       • address: long, A long integer value.
       • drOp: string, A string value.
       • msecActive: int, An integer value.
       • op: RequestOp, One of {read, write, merge, system, entries flush, #bad_state, #bad_drOp}
       • prevState: string, A string value.
       • requestId: string, A string value.
       • requestIdx: int, An integer value.
       • size: int, An integer value.
       • state: string, A string value.
       • volumeId: long, A long integer value.

Volumes

List all volumes (VolumesList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumesList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumesList
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int,
         "id": long,
         "iops": IOPS,
         "name": VolumeName,
         "objectsCount": int,
         "originalParentVolumeId": long,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }, ...]
     }
     

   • Response Data: A list of VolumeSummary
     Element type: VolumeSummary
     • bw: Bandwidth, positive integer or '-' for unlimited
     • creationTimestamp: long, A long integer value.
     • flags: int, An integer value.
     • id: long, A long integer value.
     • iops: IOPS, positive integer or '-' for unlimited
     • name: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • objectsCount: int, An integer value.
     • originalParentVolumeId: long, A long integer value.
     • parentName: Value must be from one of the following types: "", SnapshotName.
       Subtypes:
       • "", The constant value "".
       • SnapshotName, string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
     • parentVolumeId: long, A long integer value.
     • placeAll: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • placeTail: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • replication: Replication, integer, 1 <= value <= 3
     • size: Size, positive integer, divisible by 512
     • templateName: Value must be from one of the following types: "", VolumeTemplateName.
       Subtypes:
       • "", The constant value "".
       • VolumeTemplateName, string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
     • visibleVolumeId: long, A long integer value.

Get volume and snapshot status (VolumesGetStatus)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumesGetStatus HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumesGetStatus
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "VolumeName": {
           "balancerBlocked": bool,
           "decreasedRedundancy": bool,
           "downBytes": int,
           "downDrives": [DiskID, ...],
           "migrating": bool,
           "missingDrives": [DiskID, ...],
           "missingTargetDrives": [DiskID, ...],
           "name": VolumeName,
           "onDiskSize": int,
           "replication": Replication,
           "size": Size,
           "softEjectingDrives": [DiskID, ...],
           "status": string,
           "storedSize": int,
           "syncingDataBytes": int,
           "syncingMetaObjects": int
         }, ...}
     }
     

   • Response Data: A dict from VolumeName to VolumeStatus
     • Key type: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • Value type: VolumeStatus
       • balancerBlocked: bool, true or false.
       • decreasedRedundancy: bool, true or false.
       • downBytes: int, An integer value.
       • downDrives: A list of DiskID
         Element type: DiskID, integer, 0 <= value <= 4095
       • migrating: bool, true or false.
       • missingDrives: A list of DiskID
         Element type: DiskID, integer, 0 <= value <= 4095
       • missingTargetDrives: A list of DiskID
         Element type: DiskID, integer, 0 <= value <= 4095
       • name: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
       • onDiskSize: int, An integer value.
       • replication: Replication, integer, 1 <= value <= 3
       • size: Size, positive integer, divisible by 512
       • softEjectingDrives: A list of DiskID
         Element type: DiskID, integer, 0 <= value <= 4095
       • status: string, A string value.
       • storedSize: int, An integer value.
       • syncingDataBytes: int, An integer value.
       • syncingMetaObjects: int, An integer value.

List a single volume (Volume)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/Volume/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/Volume/{volumeName}
   • Arguments:
     • volumeName - VolumeName: string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int,
         "id": long,
         "iops": IOPS,
         "name": VolumeName,
         "objectsCount": int,
         "originalParentVolumeId": long,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }, ...]
     }
     

   • Response Data: A list of VolumeSummary
     Element type: VolumeSummary
     • bw: Bandwidth, positive integer or '-' for unlimited
     • creationTimestamp: long, A long integer value.
     • flags: int, An integer value.
     • id: long, A long integer value.
     • iops: IOPS, positive integer or '-' for unlimited
     • name: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • objectsCount: int, An integer value.
     • originalParentVolumeId: long, A long integer value.
     • parentName: Value must be from one of the following types: "", SnapshotName.
       Subtypes:
       • "", The constant value "".
       • SnapshotName, string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
     • parentVolumeId: long, A long integer value.
     • placeAll: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • placeTail: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • replication: Replication, integer, 1 <= value <= 3
     • size: Size, positive integer, divisible by 512
     • templateName: Value must be from one of the following types: "", VolumeTemplateName.
       Subtypes:
       • "", The constant value "".
       • VolumeTemplateName, string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
     • visibleVolumeId: long, A long integer value.

Describe a volume (VolumeDescribe)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeDescribe/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeDescribe/{volumeName}
   • Arguments:
     • volumeName - VolumeName: string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int,
         "id": long,
         "iops": IOPS,
         "name": VolumeName,
         "objects": [[DiskID, ...], ...],
         "objectsCount": int,
         "originalParentVolumeId": long,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "targetDiskSets": [[DiskID, ...], ...],
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }
     }
     

   • Response Data: Volume
     • bw: Bandwidth, positive integer or '-' for unlimited
     • creationTimestamp: long, A long integer value.
     • flags: int, An integer value.
     • id: long, A long integer value.
     • iops: IOPS, positive integer or '-' for unlimited
     • name: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • objects: A list of [DiskID]
       Element type: A list of DiskID
       Element type: DiskID, integer, 0 <= value <= 4095
     • objectsCount: int, An integer value.
     • originalParentVolumeId: long, A long integer value.
     • parentName: Value must be from one of the following types: "", SnapshotName.
       Subtypes:
       • "", The constant value "".
       • SnapshotName, string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
     • parentVolumeId: long, A long integer value.
     • placeAll: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • placeTail: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • replication: Replication, integer, 1 <= value <= 3
     • size: Size, positive integer, divisible by 512
     • targetDiskSets: A list of [DiskID]
       Element type: A list of DiskID
       Element type: DiskID, integer, 0 <= value <= 4095
     • templateName: Value must be from one of the following types: "", VolumeTemplateName.
       Subtypes:
       • "", The constant value "".
       • VolumeTemplateName, string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
     • visibleVolumeId: long, A long integer value.

Get volume info (VolumeGetInfo)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeGetInfo/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeGetInfo/{volumeName}
   • Arguments:
     • volumeName - VolumeName: string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "bw": Bandwidth,
         "creationTimestamp": long,
         "disksCount": int,
         "flags": int,
         "id": long,
         "iops": IOPS,
         "name": VolumeName,
         "objectsCount": int,
         "objectsPerChain": [{
           "count": int,
           "disks": [DiskID, ...]
         }, ...],
         "objectsPerDisk": {
           "DiskID": int, ...},
         "objectsPerDiskSet": [{
           "count": int,
           "disks": [DiskID, ...]
         }, ...],
         "originalParentVolumeId": long,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }
     }
     

   • Response Data: VolumeInfo
     • bw: Bandwidth, positive integer or '-' for unlimited
     • creationTimestamp: long, A long integer value.
     • disksCount: int, An integer value.
     • flags: int, An integer value.
     • id: long, A long integer value.
     • iops: IOPS, positive integer or '-' for unlimited
     • name: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • objectsCount: int, An integer value.
     • objectsPerChain: A list of VolumeChainStat
       Element type: VolumeChainStat
       • count: int, An integer value.
       • disks: A list of DiskID
         Element type: DiskID, integer, 0 <= value <= 4095
     • objectsPerDisk: A dict from DiskID to int
       • Key type: DiskID, integer, 0 <= value <= 4095
       • Value type: int, An integer value.
     • objectsPerDiskSet: A list of VolumeChainStat
       Element type: VolumeChainStat
       • count: int, An integer value.
       • disks: A list of DiskID
         Element type: DiskID, integer, 0 <= value <= 4095
     • originalParentVolumeId: long, A long integer value.
     • parentName: Value must be from one of the following types: "", SnapshotName.
       Subtypes:
       • "", The constant value "".
       • SnapshotName, string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
     • parentVolumeId: long, A long integer value.
     • placeAll: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • placeTail: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • replication: Replication, integer, 1 <= value <= 3
     • size: Size, positive integer, divisible by 512
     • templateName: Value must be from one of the following types: "", VolumeTemplateName.
       Subtypes:
       • "", The constant value "".
       • VolumeTemplateName, string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
     • visibleVolumeId: long, A long integer value.

List parent snapshots for volume (VolumeListSnapshots)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeListSnapshots/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeListSnapshots/{volumeName}
   • Arguments:
     • volumeName - VolumeName: string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int,
         "id": long,
         "iops": IOPS,
         "name": VolumeName,
         "objectsCount": int,
         "onVolume": VolumeName,
         "originalParentVolumeId": long,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }, ...]
     }
     

   • Response Data: A list of SnapshotSummary
     Element type: SnapshotSummary
     • bw: Bandwidth, positive integer or '-' for unlimited
     • creationTimestamp: long, A long integer value.
     • flags: int, An integer value.
     • id: long, A long integer value.
     • iops: IOPS, positive integer or '-' for unlimited
     • name: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • objectsCount: int, An integer value.
     • onVolume: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • originalParentVolumeId: long, A long integer value.
     • parentName: Value must be from one of the following types: "", SnapshotName.
       Subtypes:
       • "", The constant value "".
       • SnapshotName, string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
     • parentVolumeId: long, A long integer value.
     • placeAll: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • placeTail: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • replication: Replication, integer, 1 <= value <= 3
     • size: Size, positive integer, divisible by 512
     • templateName: Value must be from one of the following types: "", VolumeTemplateName.
       Subtypes:
       • "", The constant value "".
       • VolumeTemplateName, string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
     • visibleVolumeId: long, A long integer value.

Create a new volume (VolumeCreate)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeCreate HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "bw": Optional(Bandwidth),
       "iops": Optional(IOPS),
       "name": VolumeName,
       "parent": Optional(SnapshotName),
       "placeAll": Optional(PlacementGroupName),
       "placeTail": Optional(PlacementGroupName),
       "replication": Optional(Replication),
       "size": Size,
       "template": Optional(VolumeTemplateName)
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeCreate
   • Arguments: No arguments
   • Json: VolumeCreateDesc
     • bw: Optional(Bandwidth), If present must be of type Bandwidth
     • iops: Optional(IOPS), If present must be of type IOPS
     • name: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • parent: Optional(SnapshotName), If present must be of type SnapshotName
     • placeAll: Optional(PlacementGroupName), If present must be of type PlacementGroupName
     • placeTail: Optional(PlacementGroupName), If present must be of type PlacementGroupName
     • replication: Optional(Replication), If present must be of type Replication
     • size: Size, positive integer, divisible by 512
     • template: Optional(VolumeTemplateName), If present must be of type VolumeTemplateName
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Update a volume (VolumeUpdate)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeUpdate/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "bw": Optional(Bandwidth),
       "iops": Optional(IOPS),
       "placeAll": Optional(PlacementGroupName),
       "placeTail": Optional(PlacementGroupName),
       "rename": Optional(VolumeName),
       "replication": Optional(Replication),
       "size": Optional(Size),
       "sizeAdd": Optional(SizeAdd),
       "template": Optional(VolumeTemplateName)
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeUpdate/{volumeName}
   • Arguments:
     • volumeName - VolumeName: string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
   • Json: VolumeUpdateDesc
     • bw: Optional(Bandwidth), If present must be of type Bandwidth
     • iops: Optional(IOPS), If present must be of type IOPS
     • placeAll: Optional(PlacementGroupName), If present must be of type PlacementGroupName
     • placeTail: Optional(PlacementGroupName), If present must be of type PlacementGroupName
     • rename: Optional(VolumeName), If present must be of type VolumeName
     • replication: Optional(Replication), If present must be of type Replication
     • size: Optional(Size), If present must be of type Size
     • sizeAdd: Optional(SizeAdd), If present must be of type SizeAdd
     • template: Optional(VolumeTemplateName), If present must be of type VolumeTemplateName
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Freeze a volume (VolumeFreeze)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeFreeze/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeFreeze/{volumeName}
   • Arguments:
     • volumeName - VolumeName: string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Rebase a volume (VolumeRebase)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeRebase/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "parentName": Optional(SnapshotName)
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeRebase/{volumeName}
   • Arguments:
     • volumeName - VolumeName: string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
   • Json: VolumeRebaseDesc
     • parentName: Optional(SnapshotName), If present must be of type SnapshotName
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Delete a volume (VolumeDelete)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeDelete/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeDelete/{volumeName}
   • Arguments:
     • volumeName - VolumeName: string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Snapshots

List all snapshots (SnapshotsList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/SnapshotsList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/SnapshotsList
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int,
         "id": long,
         "iops": IOPS,
         "name": VolumeName,
         "objectsCount": int,
         "onVolume": VolumeName,
         "originalParentVolumeId": long,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }, ...]
     }
     

   • Response Data: A list of SnapshotSummary
     Element type: SnapshotSummary
     • bw: Bandwidth, positive integer or '-' for unlimited
     • creationTimestamp: long, A long integer value.
     • flags: int, An integer value.
     • id: long, A long integer value.
     • iops: IOPS, positive integer or '-' for unlimited
     • name: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • objectsCount: int, An integer value.
     • onVolume: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • originalParentVolumeId: long, A long integer value.
     • parentName: Value must be from one of the following types: "", SnapshotName.
       Subtypes:
       • "", The constant value "".
       • SnapshotName, string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
     • parentVolumeId: long, A long integer value.
     • placeAll: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • placeTail: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • replication: Replication, integer, 1 <= value <= 3
     • size: Size, positive integer, divisible by 512
     • templateName: Value must be from one of the following types: "", VolumeTemplateName.
       Subtypes:
       • "", The constant value "".
       • VolumeTemplateName, string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
     • visibleVolumeId: long, A long integer value.

List a single snapshots (Snapshot)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/Snapshot/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/Snapshot/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int,
         "id": long,
         "iops": IOPS,
         "name": VolumeName,
         "objectsCount": int,
         "onVolume": VolumeName,
         "originalParentVolumeId": long,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }, ...]
     }
     

   • Response Data: A list of SnapshotSummary
     Element type: SnapshotSummary
     • bw: Bandwidth, positive integer or '-' for unlimited
     • creationTimestamp: long, A long integer value.
     • flags: int, An integer value.
     • id: long, A long integer value.
     • iops: IOPS, positive integer or '-' for unlimited
     • name: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • objectsCount: int, An integer value.
     • onVolume: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • originalParentVolumeId: long, A long integer value.
     • parentName: Value must be from one of the following types: "", SnapshotName.
       Subtypes:
       • "", The constant value "".
       • SnapshotName, string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
     • parentVolumeId: long, A long integer value.
     • placeAll: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • placeTail: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • replication: Replication, integer, 1 <= value <= 3
     • size: Size, positive integer, divisible by 512
     • templateName: Value must be from one of the following types: "", VolumeTemplateName.
       Subtypes:
       • "", The constant value "".
       • VolumeTemplateName, string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
     • visibleVolumeId: long, A long integer value.

Describe a snapshot (SnapshotDescribe)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/SnapshotDescribe/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/SnapshotDescribe/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "bw": Bandwidth,
         "creationTimestamp": long,
         "flags": int,
         "id": long,
         "iops": IOPS,
         "name": VolumeName,
         "objects": [[DiskID, ...], ...],
         "objectsCount": int,
         "originalParentVolumeId": long,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "targetDiskSets": [[DiskID, ...], ...],
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }
     }
     

   • Response Data: Volume
     • bw: Bandwidth, positive integer or '-' for unlimited
     • creationTimestamp: long, A long integer value.
     • flags: int, An integer value.
     • id: long, A long integer value.
     • iops: IOPS, positive integer or '-' for unlimited
     • name: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • objects: A list of [DiskID]
       Element type: A list of DiskID
       Element type: DiskID, integer, 0 <= value <= 4095
     • objectsCount: int, An integer value.
     • originalParentVolumeId: long, A long integer value.
     • parentName: Value must be from one of the following types: "", SnapshotName.
       Subtypes:
       • "", The constant value "".
       • SnapshotName, string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
     • parentVolumeId: long, A long integer value.
     • placeAll: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • placeTail: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • replication: Replication, integer, 1 <= value <= 3
     • size: Size, positive integer, divisible by 512
     • targetDiskSets: A list of [DiskID]
       Element type: A list of DiskID
       Element type: DiskID, integer, 0 <= value <= 4095
     • templateName: Value must be from one of the following types: "", VolumeTemplateName.
       Subtypes:
       • "", The constant value "".
       • VolumeTemplateName, string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
     • visibleVolumeId: long, A long integer value.

Get snapshot info (SnapshotGetInfo)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/SnapshotGetInfo/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/SnapshotGetInfo/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "bw": Bandwidth,
         "creationTimestamp": long,
         "disksCount": int,
         "flags": int,
         "id": long,
         "iops": IOPS,
         "name": VolumeName,
         "objectsCount": int,
         "objectsPerChain": [{
           "count": int,
           "disks": [DiskID, ...]
         }, ...],
         "objectsPerDisk": {
           "DiskID": int, ...},
         "objectsPerDiskSet": [{
           "count": int,
           "disks": [DiskID, ...]
         }, ...],
         "originalParentVolumeId": long,
         "parentName": Either("", SnapshotName),
         "parentVolumeId": long,
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Replication,
         "size": Size,
         "templateName": Either("", VolumeTemplateName),
         "visibleVolumeId": long
       }
     }
     

   • Response Data: VolumeInfo
     • bw: Bandwidth, positive integer or '-' for unlimited
     • creationTimestamp: long, A long integer value.
     • disksCount: int, An integer value.
     • flags: int, An integer value.
     • id: long, A long integer value.
     • iops: IOPS, positive integer or '-' for unlimited
     • name: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • objectsCount: int, An integer value.
     • objectsPerChain: A list of VolumeChainStat
       Element type: VolumeChainStat
       • count: int, An integer value.
       • disks: A list of DiskID
         Element type: DiskID, integer, 0 <= value <= 4095
     • objectsPerDisk: A dict from DiskID to int
       • Key type: DiskID, integer, 0 <= value <= 4095
       • Value type: int, An integer value.
     • objectsPerDiskSet: A list of VolumeChainStat
       Element type: VolumeChainStat
       • count: int, An integer value.
       • disks: A list of DiskID
         Element type: DiskID, integer, 0 <= value <= 4095
     • originalParentVolumeId: long, A long integer value.
     • parentName: Value must be from one of the following types: "", SnapshotName.
       Subtypes:
       • "", The constant value "".
       • SnapshotName, string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
     • parentVolumeId: long, A long integer value.
     • placeAll: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • placeTail: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • replication: Replication, integer, 1 <= value <= 3
     • size: Size, positive integer, divisible by 512
     • templateName: Value must be from one of the following types: "", VolumeTemplateName.
       Subtypes:
       • "", The constant value "".
       • VolumeTemplateName, string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
     • visibleVolumeId: long, A long integer value.

Snapshot a volume (VolumeSnapshot)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeSnapshot/{volumeName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "name": Optional(VolumeName)
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeSnapshot/{volumeName}
   • Arguments:
     • volumeName - VolumeName: string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
   • Json: VolumeSnapshotDesc
     • name: Optional(VolumeName), If present must be of type VolumeName
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Update snapshot (SnapshotUpdate)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/SnapshotUpdate/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "bw": Optional(Bandwidth),
       "iops": Optional(IOPS),
       "placeAll": Optional(PlacementGroupName),
       "placeTail": Optional(PlacementGroupName),
       "rename": Optional(VolumeName),
       "replication": Optional(Replication),
       "size": Optional(Size),
       "sizeAdd": Optional(SizeAdd),
       "template": Optional(VolumeTemplateName)
     }

   • Method: POST
   • Path: /ctrl/1.0/SnapshotUpdate/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
   • Json: VolumeUpdateDesc
     • bw: Optional(Bandwidth), If present must be of type Bandwidth
     • iops: Optional(IOPS), If present must be of type IOPS
     • placeAll: Optional(PlacementGroupName), If present must be of type PlacementGroupName
     • placeTail: Optional(PlacementGroupName), If present must be of type PlacementGroupName
     • rename: Optional(VolumeName), If present must be of type VolumeName
     • replication: Optional(Replication), If present must be of type Replication
     • size: Optional(Size), If present must be of type Size
     • sizeAdd: Optional(SizeAdd), If present must be of type SizeAdd
     • template: Optional(VolumeTemplateName), If present must be of type VolumeTemplateName
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Rebase snapshot (SnapshotRebase)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/SnapshotRebase/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "parentName": Optional(SnapshotName)
     }

   • Method: POST
   • Path: /ctrl/1.0/SnapshotRebase/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
   • Json: VolumeRebaseDesc
     • parentName: Optional(SnapshotName), If present must be of type SnapshotName
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Delete snapshot (SnapshotDelete)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/SnapshotDelete/{snapshotName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/SnapshotDelete/{snapshotName}
   • Arguments:
     • snapshotName - SnapshotName: string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Volume Rights

List all Attachments (AttachmentsList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/AttachmentsList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/AttachmentsList
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "client": CientID,
         "pos": AttachmentPos,
         "rights": AttachmentRights,
         "snapshot": bool,
         "volume": VolumeName
       }, ...]
     }
     

   • Response Data: A list of AttachmentDesc
     Element type: AttachmentDesc
     • client: CientID, integer, 1 <= value <= 32768
     • pos: AttachmentPos, integer, 0 <= value <= 1023
     • rights: AttachmentRights, One of {rw, ro}
     • snapshot: bool, true or false.
     • volume: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}

Reassign volumes and/or snapshots (VolumesReassign)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumesReassign HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     [Either({
       "detach": Optional(Either("all", [CientID])),
       "force": bool, default=False,
       "ro": Optional([CientID]),
       "rw": Optional([CientID]),
       "volume": VolumeName
     }, {
       "detach": Optional(Either("all", [CientID])),
       "force": bool, default=False,
       "ro": Optional([CientID]),
       "snapshot": SnapshotName
     }), ...]

   • Method: POST
   • Path: /ctrl/1.0/VolumesReassign
   • Arguments: No arguments
   • Json: A list of Either(VolumeReassignDesc, SnapshotReassignDesc)
     Element type: Value must be from one of the following types: VolumeReassignDesc, SnapshotReassignDesc.
     Subtypes:
     • VolumeReassignDesc
       • detach: Optional(Either("all", [CientID])), If present must be of type Either("all", [CientID])
       • force: bool, default=False, A value of type bool. Default value = False.
       • ro: Optional([CientID]), If present must be of type [CientID]
       • rw: Optional([CientID]), If present must be of type [CientID]
       • volume: VolumeName, string(200), matching ^[A-Za-z0-9_\-.:]+$, except {list, status}
     • SnapshotReassignDesc
       • detach: Optional(Either("all", [CientID])), If present must be of type Either("all", [CientID])
       • force: bool, default=False, A value of type bool. Default value = False.
       • ro: Optional([CientID]), If present must be of type [CientID]
       • snapshot: SnapshotName, string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Placement Groups

List all placement groups (PlacementGroupsList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/PlacementGroupsList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/PlacementGroupsList
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "PlacementGroupName": {
           "disks": [DiskID, ...],
           "id": int,
           "name": PlacementGroupName,
           "servers": [ServerID, ...]
         }, ...}
     }
     

   • Response Data: A dict from PlacementGroupName to PlacementGroup
     • Key type: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • Value type: PlacementGroup
       • disks: A set of DiskID
         Element type: DiskID, integer, 0 <= value <= 4095
       • id: int, An integer value.
       • name: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
       • servers: A set of ServerID
         Element type: ServerID, integer, 1 <= value <= 32768

Describe single placement group (PlacementGroupDescribe)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/PlacementGroupDescribe/{placementGroupName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/PlacementGroupDescribe/{placementGroupName}
   • Arguments:
     • placementGroupName - PlacementGroupName: string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "disks": [DiskID, ...],
         "id": int,
         "name": PlacementGroupName,
         "servers": [ServerID, ...]
       }
     }
     

   • Response Data: PlacementGroup
     • disks: A set of DiskID
       Element type: DiskID, integer, 0 <= value <= 4095
     • id: int, An integer value.
     • name: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • servers: A set of ServerID
       Element type: ServerID, integer, 1 <= value <= 32768

Create and/or update placement group (PlacementGroupUpdate)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/PlacementGroupUpdate/{placementGroupName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "addDisks": [DiskID, ...],
       "addServers": [ServerID, ...],
       "rename": Optional(PlacementGroupName),
       "rmDisks": [DiskID, ...],
       "rmServers": [ServerID, ...]
     }

   • Method: POST
   • Path: /ctrl/1.0/PlacementGroupUpdate/{placementGroupName}
   • Arguments:
     • placementGroupName - PlacementGroupName: string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
   • Json: PlacementGroupUpdateDesc
     • addDisks: A set of DiskID
       Element type: DiskID, integer, 0 <= value <= 4095
     • addServers: A set of ServerID
       Element type: ServerID, integer, 1 <= value <= 32768
     • rename: Optional(PlacementGroupName), If present must be of type PlacementGroupName
     • rmDisks: A set of DiskID
       Element type: DiskID, integer, 0 <= value <= 4095
     • rmServers: A set of ServerID
       Element type: ServerID, integer, 1 <= value <= 32768
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Delete placement group (PlacementGroupDelete)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/PlacementGroupDelete/{placementGroupName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/PlacementGroupDelete/{placementGroupName}
   • Arguments:
     • placementGroupName - PlacementGroupName: string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Volume Templates

List all volume templates (VolumeTemplatesList)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeTemplatesList HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeTemplatesList
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": [{
         "bw": Bandwidth,
         "iops": IOPS,
         "name": VolumeTemplateName,
         "parentName": Either("", SnapshotName),
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Either("-", Replication),
         "size": Either("-", Size)
       }, ...]
     }
     

   • Response Data: A list of VolumeTemplateDesc
     Element type: VolumeTemplateDesc
     • bw: Bandwidth, positive integer or '-' for unlimited
     • iops: IOPS, positive integer or '-' for unlimited
     • name: VolumeTemplateName, string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
     • parentName: Value must be from one of the following types: "", SnapshotName.
       Subtypes:
       • "", The constant value "".
       • SnapshotName, string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
     • placeAll: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • placeTail: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • replication: Value must be from one of the following types: "-", Replication.
       Subtypes:
       • "-", The constant value "-".
       • Replication, integer, 1 <= value <= 3
     • size: Value must be from one of the following types: "-", Size.
       Subtypes:
       • "-", The constant value "-".
       • Size, positive integer, divisible by 512

Describe single volume template (VolumeTemplateDescribe)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeTemplateDescribe/{templateName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeTemplateDescribe/{templateName}
   • Arguments:
     • templateName - VolumeTemplateName: string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "bw": Bandwidth,
         "iops": IOPS,
         "name": VolumeTemplateName,
         "parentName": Either("", SnapshotName),
         "placeAll": PlacementGroupName,
         "placeTail": PlacementGroupName,
         "replication": Either("-", Replication),
         "size": Either("-", Size)
       }
     }
     

   • Response Data: VolumeTemplateDesc
     • bw: Bandwidth, positive integer or '-' for unlimited
     • iops: IOPS, positive integer or '-' for unlimited
     • name: VolumeTemplateName, string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
     • parentName: Value must be from one of the following types: "", SnapshotName.
       Subtypes:
       • "", The constant value "".
       • SnapshotName, string(200), matching ^[A-Za-z0-9_\-.@:]+$, except {list, status}
     • placeAll: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • placeTail: PlacementGroupName, string(128), matching ^[A-Za-z0-9_\-]+$, except {list}
     • replication: Value must be from one of the following types: "-", Replication.
       Subtypes:
       • "-", The constant value "-".
       • Replication, integer, 1 <= value <= 3
     • size: Value must be from one of the following types: "-", Size.
       Subtypes:
       • "-", The constant value "-".
       • Size, positive integer, divisible by 512

Create volume template (VolumeTemplateCreate)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeTemplateCreate HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "bw": Optional(Bandwidth),
       "iops": Optional(IOPS),
       "name": VolumeTemplateName,
       "parent": Optional(SnapshotName),
       "placeAll": Optional(PlacementGroupName),
       "placeTail": Optional(PlacementGroupName),
       "replication": Optional(Replication),
       "size": Optional(Size)
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeTemplateCreate
   • Arguments: No arguments
   • Json: VolumeTemplateCreateDesc
     • bw: Optional(Bandwidth), If present must be of type Bandwidth
     • iops: Optional(IOPS), If present must be of type IOPS
     • name: VolumeTemplateName, string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
     • parent: Optional(SnapshotName), If present must be of type SnapshotName
     • placeAll: Optional(PlacementGroupName), If present must be of type PlacementGroupName
     • placeTail: Optional(PlacementGroupName), If present must be of type PlacementGroupName
     • replication: Optional(Replication), If present must be of type Replication
     • size: Optional(Size), If present must be of type Size
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Update volume template (VolumeTemplateUpdate)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeTemplateUpdate/{templateName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     {
       "bw": Optional(Bandwidth),
       "iops": Optional(IOPS),
       "parent": Optional(SnapshotName),
       "placeAll": Optional(PlacementGroupName),
       "placeTail": Optional(PlacementGroupName),
       "rename": Optional(VolumeTemplateName),
       "replication": Optional(Replication),
       "size": Optional(Size)
     }

   • Method: POST
   • Path: /ctrl/1.0/VolumeTemplateUpdate/{templateName}
   • Arguments:
     • templateName - VolumeTemplateName: string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
   • Json: VolumeTemplateUpdateDesc
     • bw: Optional(Bandwidth), If present must be of type Bandwidth
     • iops: Optional(IOPS), If present must be of type IOPS
     • parent: Optional(SnapshotName), If present must be of type SnapshotName
     • placeAll: Optional(PlacementGroupName), If present must be of type PlacementGroupName
     • placeTail: Optional(PlacementGroupName), If present must be of type PlacementGroupName
     • rename: Optional(VolumeTemplateName), If present must be of type VolumeTemplateName
     • replication: Optional(Replication), If present must be of type Replication
     • size: Optional(Size), If present must be of type Size
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Delete volume template (VolumeTemplateDelete)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeTemplateDelete/{templateName} HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeTemplateDelete/{templateName}
   • Arguments:
     • templateName - VolumeTemplateName: string(200), matching ^[A-Za-z0-9_\-]+$, except {list}
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Volume Relocator

Turn-ON relocator (VolumeRelocatorOn)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeRelocatorOn HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeRelocatorOn
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Turn-OFF relocator (VolumeRelocatorOff)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeRelocatorOff HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeRelocatorOff
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Get relocator status (VolumeRelocatorStatus)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeRelocatorStatus HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeRelocatorStatus
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "status": RelocatorStatus
       }
     }
     

   • Response Data: VolumeRelocatorStatus
     • status: RelocatorStatus, One of {on, off, blocked}

Balancer

Turn-ON balancer (VolumeBalancerOn)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeBalancerOn HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeBalancerOn
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Turn-OFF balancer (VolumeBalancerOff)

1. Request:
   • Example HTTP Request:

     POST /ctrl/1.0/VolumeBalancerOff HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: POST
   • Path: /ctrl/1.0/VolumeBalancerOff
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "generation": long,
         "ok": true
       }
     }
     

   • Response Data: ApiOk
     • generation: long, A long integer value.
     • ok: true, The constant value true.

Get balancer status (VolumeBalancerStatus)

1. Request:
   • Example HTTP Request:

     GET /ctrl/1.0/VolumeBalancerStatus HTTP/1.0
     Host: SP_API_HOST:SP_API_PORT
     Authorization: Storpool v1:SP_AUTH_TOKEN
     Content-Length: LENGTH
     
     

   • Method: GET
   • Path: /ctrl/1.0/VolumeBalancerStatus
   • Arguments: No arguments
   • Json: Either no JSON or {}
2. Response:
   • Example HTTP Response:

     HTTP/1.0 200 OK
     Connection: close
     Content-Type: application/json
     Cache-control: private
     Content-Length: LENGTH
     
     {
       "generation": generation,
       "data": {
         "status": BalancerStatus
       }
     }
     

   • Response Data: VolumeBalancerStatus
     • status: BalancerStatus, One of {on, off, blocked}