The Archil Control Plane API provides programmatic access to manage disks, mounts, and API keys in the Archil distributed filesystem platform.Documentation Index
Fetch the complete documentation index at: https://docs.archil.com/llms.txt
Use this file to discover all available pages before exploring further.
API keys vs. disk tokens. API keys authenticate requests to this Control Plane API and are scoped to your account. Disk tokens are a separate kind of credential, scoped to a single disk, used by clients when mounting. The two are not interchangeable.
Base URL
Each region has its own control plane endpoint:| Region | Region ID | Endpoint |
|---|---|---|
| AWS US East (N. Virginia) | aws-us-east-1 | control.green.us-east-1.aws.prod.archil.com |
| AWS EU West (Ireland) | aws-eu-west-1 | control.green.eu-west-1.aws.prod.archil.com |
| AWS US West (Oregon) | aws-us-west-2 | control.green.us-west-2.aws.prod.archil.com |
| GCP US Central (Iowa) | gcp-us-central1 | control.blue.us-central1.gcp.prod.archil.com |
Authentication
All endpoints require an API key:Response Format
All responses use a consistent envelope:HTTP Status Codes
| Code | Description |
|---|---|
200 | Success |
400 | Bad request (validation error) |
403 | Forbidden (auth failure or access denied) |
404 | Not found |
500 | Internal server error |
Disk ID Format
Disks are identified by a unique ID in the format:dsk-0123456789abcdef
Getting Started
Signing up for Archil is free with no credit card required. Create your free account to get an API key and start building.
- Create an API key in the console or via API
- Use the key in the
Authorizationheader for all requests - Create your first disk