Documentation
Everything you need to integrate Cirrus Files into your workflow.
Quick start
- Create a workspace and generate an API token under Settings → Tokens.
- Install the CLI:
brew install cirrus/tap/cirrusor download a static binary. - Authenticate with
cirrus loginand upload withcirrus put ./file.
REST API
| Method | Endpoint | Description |
|---|---|---|
| GET | /v2/objects | List objects in a bucket |
| PUT | /v2/objects/{key} | Upload or replace an object |
| POST | /v2/shares | Create a share link |
| DELETE | /v2/objects/{key} | Move an object to trash |
S3 compatibility
Point any S3 client at the regional endpoint and use your workspace token as the access key. Multipart uploads, presigned URLs and lifecycle rules are supported.