Storage API

Object, file, SAN, and block storage on API v2.10

Overview

Storage is split into separate APIs. Each product has its own commands under https://api.rackcorp.net/api/rest/v2.10/json.php. Authenticate with Authorization: Bearer YOUR_JWT_TOKEN.

Send a JSON body with a cmd field. Successful calls return code: "OK". Field names are product-specific (s3BucketId, sftpcustomerid, and so on). Do not reuse one product's identifiers on another.

Products

Section What it manages Command prefix
S3 Object Storage Buckets, access keys, regions, zone replication, pull import, and dedicated S3 servers storage.s3.*
SFTP SFTP hosts, regions, and users storage.sftp.*
SAN SAN arrays, candidate hosts, pools, status, and stats storage.san.*
Block Storage Volumes, attachment, snapshots, move, and failover storage.block.*
Storage Domains Placement pools: datacentres, hosts, and volume groups storage.domain.*
Storage Fabric Platform replication network for high-availability volumes storage.fabric.*

Storage domains

A storage domain is the placement pool for block volumes: datacentres, VM hosts, and volume groups. Create, list, and membership calls are on the Storage Domains page. Host free-space bytes for capacity planning stay on the monitoring page (storage.vmhstorage.getall).

S3 in short

S3 is the customer object-storage API. A typical integration lists regions, creates a bucket, creates a credential bound to that bucket, then reads the secret once and talks to the endpoint returned on the bucket (s3RegionEndpoint).

  • High Speed (HIGHSPEED) buckets live on an S3 server in a region. Replication, pull import, and Object Lock apply here.
  • Archive (ARCHIVE) buckets use https://s3.rackcorp.com.
  • Dedicated servers are customer-owned S3 VMs. Public servers use your hostname; inherit: "Y" lets child customers place buckets on them.

Full request fields, limits, and examples are on the S3 Object Storage page.

Errors

Validation failures return code: "FAULT" with a message, and often an error object keyed by field:

{
  "code": "FAULT",
  "message": "S3 dedicated server not created (vpcId: Required)",
  "error": {
    "vpcId": "Required"
  }
}