Storage API

Manage storage resources including S3, SFTP, SAN, and Block Storage

Overview

The Storage API provides access to various storage services including S3 object storage, SFTP file storage, SAN storage, and block storage devices. Each storage type has its own set of endpoints for managing resources.

S3 Storage API

GET List S3 Buckets

Retrieve a list of S3 buckets.

Request

GET https://api.rackcorp.net/api/rest/v2.9/json.php?cmd=storage.s3.bucket.getall&resStart=0&resWindow=50&s3BucketName=my-bucket&s3BucketStatus=ACTIVE
Authorization: Bearer YOUR_JWT_TOKEN

Parameters

Parameter Type Required Description
cmd string Yes Must be "storage.s3.bucket.getall"
resStart integer No Pagination start offset (default: 0)
resWindow integer No Number of results per page (default: 20, minimum: 20)
stdname string No Filter by customer standard name
s3BucketName string No Filter by bucket name
s3BucketStatus string No Filter by bucket status (e.g., "ACTIVE")

POST Create S3 Bucket

Create a new S3 bucket.

Request

POST https://api.rackcorp.net/api/rest/v2.9/json.php
Content-Type: application/json
Authorization: Bearer YOUR_JWT_TOKEN

{
  "cmd": "storage.s3.bucket.create",
  "s3BucketName": "my-bucket",
  "customerid": 456,
  "s3RegionID": 1
}

DELETE Delete S3 Bucket

Delete an S3 bucket.

Request

DELETE https://api.rackcorp.net/api/rest/v2.9/json.php
Content-Type: application/json
Authorization: Bearer YOUR_JWT_TOKEN

{
  "cmd": "storage.s3.bucket.delete",
  "s3BucketID": 123
}

GET List S3 Credentials

Retrieve a list of S3 credentials.

Request

GET https://api.rackcorp.net/api/rest/v2.9/json.php?cmd=storage.s3.credential.getall&resStart=0&resWindow=50&s3CredentialName=my-credential&s3CredentialStatus=ACTIVE
Authorization: Bearer YOUR_JWT_TOKEN

GET Get S3 Credential

Retrieve a single S3 credential by ID.

Request

GET https://api.rackcorp.net/api/rest/v2.9/json.php?cmd=storage.s3.credential.get&id=123
Authorization: Bearer YOUR_JWT_TOKEN

DELETE Delete S3 Credential

Delete an S3 credential.

Request

DELETE https://api.rackcorp.net/api/rest/v2.9/json.php
Content-Type: application/json
Authorization: Bearer YOUR_JWT_TOKEN

{
  "cmd": "storage.s3.credential.delete",
  "id": 123
}

GET List S3 Regions

Retrieve a list of available S3 regions.

Request

GET https://api.rackcorp.net/api/rest/v2.9/json.php?cmd=storage.s3.region.getall
Authorization: Bearer YOUR_JWT_TOKEN

SFTP Storage API

GET List SFTP Hosts

Retrieve a list of SFTP storage hosts.

Request

GET https://api.rackcorp.net/api/rest/v2.9/json.php?cmd=storage.sftp.getall&resStart=0&resWindow=50&sftpname=my-sftp&sftpstatus=ACTIVE
Authorization: Bearer YOUR_JWT_TOKEN

Parameters

Parameter Type Required Description
cmd string Yes Must be "storage.sftp.getall"
resStart integer No Pagination start offset (default: 0)
resWindow integer No Number of results per page (default: 20, minimum: 20)
stdname string No Filter by customer standard name
sftpname string No Filter by SFTP host name
sftpstatus string No Filter by SFTP status (e.g., "ACTIVE")

GET List SFTP Users

Retrieve a list of SFTP users.

Request

GET https://api.rackcorp.net/api/rest/v2.9/json.php?cmd=storage.sftp.users.getall&resStart=0&resWindow=50&sftpusername=myuser&sftpuserstatus=ACTIVE
Authorization: Bearer YOUR_JWT_TOKEN

DELETE Delete SFTP User

Delete an SFTP user.

Request

DELETE https://api.rackcorp.net/api/rest/v2.9/json.php
Content-Type: application/json
Authorization: Bearer YOUR_JWT_TOKEN

{
  "cmd": "storage.sftp.users.delete",
  "id": 123
}

GET List SFTP Regions

Retrieve a list of available SFTP regions.

Request

GET https://api.rackcorp.net/api/rest/v2.9/json.php?cmd=storage.sftp.region.getall
Authorization: Bearer YOUR_JWT_TOKEN

SAN Storage API

GET List SAN Storage

Retrieve a list of SAN storage resources.

Request

GET https://api.rackcorp.net/api/rest/v2.9/json.php?cmd=storage.san.getall&resStart=0&resWindow=50
Authorization: Bearer YOUR_JWT_TOKEN

Block Storage API

GET List Block Storage

Retrieve a list of block storage devices.

Request

GET https://api.rackcorp.net/api/rest/v2.9/json.php?cmd=storage.block.getall&resStart=0&resWindow=50&stdname=Example&name=block-01
Authorization: Bearer YOUR_JWT_TOKEN

Parameters

Parameter Type Required Description
cmd string Yes Must be "storage.block.getall"
resStart integer No Pagination start offset (default: 0)
resWindow integer No Number of results per page (default: 20, minimum: 20)
stdname string No Filter by customer standard name
name string No Filter by block storage name

Error Responses

If an error occurs, the API will return a response with code: "FAULT":

{
  "code": "FAULT",
  "message": "Error message",
  "error": {
    "field1": "Error message 1",
    "field2": "Error message 2"
  }
}