cURL
curl --request GET \ --url https://control.green.us-east-1.aws.prod.archil.com/api/disks \ --header 'Authorization: <api-key>'
{ "success": true, "data": [ { "id": "dsk-0123456789abcdef", "name": "<string>", "organization": "<string>", "status": "available", "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>", "type": "s3", "path": "<string>", "name": "<string>", "accessMode": "rw", "config": { "bucketName": "<string>", "bucketEndpoint": "<string>", "bucketPrefix": "<string>" }, "connectionStatus": "connected", "authError": "<string>", "authorizationType": "iam" } ], "metrics": { "dataTransfer": "<string>", "requests": "<string>", "avgResponseTime": "<string>" }, "connectedClients": [ { "id": "<string>", "ipAddress": "<string>", "connectedAt": "2023-11-07T05:31:56Z" } ], "authorizedUsers": [ { "type": "token", "principal": "<string>", "nickname": "<string>", "tokenSuffix": "<string>", "createdAt": "2023-11-07T05:31:56Z" } ] } ] }
Returns all disks owned by the authenticated account.
API key (format key-{API_KEY})
key-{API_KEY}
Maximum number of items to return
x <= 100
Pagination cursor from a previous response
List of disks
All API responses use a standard envelope with success: boolean and data (on success) or error: string (on failure). The ApiResponse_* schemas each define the specific data shape for their endpoint.
success: boolean
data
error: string
true
Show child attributes
Was this page helpful?