Skip to main content
GET
/
api
/
disks
/
{id}
Get disk details
curl --request GET \
  --url https://control.green.us-east-1.aws.prod.archil.com/api/disks/{id} \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "data": {
    "id": "dsk-0123456789abcdef",
    "name": "<string>",
    "organization": "<string>",
    "provider": "<string>",
    "region": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "fsHandlerStatus": "<string>",
    "lastAccessed": "2023-11-07T05:31:56Z",
    "dataSize": 1,
    "monthlyUsage": "<string>",
    "mounts": [
      {
        "id": "<string>",
        "path": "<string>",
        "name": "<string>",
        "accessMode": "rw",
        "config": {
          "bucketName": "<string>",
          "bucketEndpoint": "<string>",
          "bucketPrefix": "<string>",
          "sessionId": "<string>"
        },
        "authError": "<string>"
      }
    ],
    "metrics": {
      "dataTransfer": "<string>",
      "requests": "<string>",
      "avgResponseTime": "<string>"
    },
    "connectedClients": [
      {
        "id": "<string>",
        "ipAddress": "<string>",
        "connectedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "authorizedUsers": [
      {
        "principal": "<string>",
        "nickname": "<string>",
        "tokenSuffix": "<string>",
        "token": "<string>",
        "identifier": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API key (format key-{API_KEY})

Path Parameters

​
id
string
required

Disk ID (format dsk-{16 hex chars})

Pattern: ^dsk-[0-9a-f]{16}$
Example:

"dsk-0123456789abcdef"

Response

Disk details

​
success
boolean
required
Example:

true

​
data
object
required