Skip to main content
POST
/
api
/
disks
Create a new disk
curl --request POST \
  --url https://control.green.us-east-1.aws.prod.archil.com/api/disks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-data-disk",
  "mounts": [
    {
      "type": "s3",
      "bucketName": "my-bucket",
      "accessKeyId": "<string>",
      "secretAccessKey": "<string>",
      "sessionToken": "<string>",
      "bucketPrefix": "data/"
    }
  ],
  "authMethods": [
    {
      "type": "token",
      "principal": "<string>",
      "nickname": "<string>",
      "tokenSuffix": "<string>"
    }
  ]
}
'
{
  "success": true,
  "data": {
    "diskId": "dsk-0123456789abcdef"
  }
}

Authorizations

​
Authorization
string
header
required

API key (format key-{API_KEY})

Body

application/json
​
name
string
required

Disk name (alphanumeric, dashes, underscores)

Required string length: 1 - 100
Example:

"my-data-disk"

​
mounts
(S3 · object | Google Cloud Storage · object | Cloudflare R2 · object | S3-Compatible · object | Azure Blob Storage · object)[]
required

Storage mount to attach (exactly one required)

Required array length: 1 element

Mount configuration for Amazon S3 buckets

​
authMethods
object[]

Authentication methods for disk access

Response

Disk created successfully

​
success
boolean
required
Example:

true

​
data
object
required