# flockfs API

**Canonical:** https://apis.io/apis/flockfs-com/flockfs-com-api/  
**Provider:** flockfs — https://apis.io/providers/flockfs-com/  
**Documentation:** https://flockfs.com/docs/api

flockfs API is one of 2 APIs that [flockfs](https://apis.io/providers/flockfs-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

flockfs API as documented publicly: 90 operations. Contract generated from the documentation by API Evangelist (2026-11-08); not the provider's own document.

## Operations (60 of 90)

| Method | Path | Summary |
|---|---|---|
| GET | `/access` | Access : the caller's own level at a path |
| GET | `/api/access` | any Access |
| GET | `/api/billing` | Billing |
| POST | `/api/billing/checkout` | Checkout |
| POST | `/api/billing/portal` | Portal |
| POST | `/api/billing/webhook` | Webhook |
| POST | `/api/browser-session` | local key {ticket, expires_in: 60} (local mode only) |
| GET | `/api/drives` | GET /api/drives lists drives the caller can open. |
| POST | `/api/drives` | POST /api/drives creates a new drive (owner only). |
| GET | `/api/drives/research-k3vzq2m7xa4b/files/{id}/raw` | GET /api/drives/{drive}/files/{id}/raw streams the body of a file. |
| GET | `/api/drives/research/entries` | GET /api/drives/{drive}/entries returns a consistent snapshot of entries. |
| DELETE | `/api/drives/{drive}` | DELETE /api/drives/{drive} soft‑deletes a drive. |
| PATCH | `/api/drives/{drive}` | PATCH /api/drives/{drive} updates a drive's name or slug. |
| POST | `/api/drives/{drive}/copy-to` | Copy paths from one drive to another |
| GET | `/api/drives/{drive}/export` | Export a drive as a zip archive |
| POST | `/api/drives/{drive}/fork` | Create a fork (duplicate) of a drive |
| POST | `/api/drives/{drive}/oauth/consent` | OAuth consent page for a drive |
| POST | `/api/drives/{drive}/restore` | POST /api/drives/{drive}/restore restores a soft‑deleted drive. |
| GET | `/api/files/{id}/raw` | streams the body |
| PUT | `/api/files/{id}/raw` | replaces a body |
| DELETE | `/api/grants` | manage at path ShareListing ( 404 if there was no grant on exactly that path) |
| GET | `/api/grants` | manage at path ShareListing |
| PUT | `/api/grants` | Create or update a grant on a folder |
| GET | `/api/invites` | GET /api/invites |
| DELETE | `/api/invites/{email}` | DELETE /api/invites/{email} |
| PUT | `/api/invites/{email}` | PUT /api/invites/{email} |
| GET | `/api/me` | GET /api/me |
| GET | `/api/members` | GET /api/members |
| POST | `/api/members` | Add member |
| DELETE | `/api/members/{userid}` | DELETE /api/members/{userId} |
| POST | `/api/onboard` | POST /api/onboard creates an idempotent personal free drive for a verified human account. |
| GET | `/api/org/members` | List organization members |
| DELETE | `/api/org/members/{userid}` | Remove a member from the organization |
| PUT | `/api/org/members/{userid}` | Update a member's role in the organization |
| PUT | `/api/org/plan` | Update the organization's plan |
| GET | `/api/pricing` | Pricing |
| GET | `/api/s/{token}` | Anonymous read of a shared entry (folder or file) |
| GET | `/api/s/{token}/file` | One file as JSON (content, encoding) |
| GET | `/api/s/{token}/raw` | The body, streamed, with optional download disposition |
| GET | `/api/timeline/export` | Export the timeline and sessions (audit export) |
| GET | `/api/tokens` | GET /api/tokens |
| POST | `/api/tokens` | POST /api/tokens |
| DELETE | `/api/tokens/{id}` | owner {ok} (idempotent; 404 for an unknown id) |
| POST | `/api/upload` | creates a file from the request body |
| POST | `/api/uploads` | Upload (chunked upload, see Chunked uploads ) |
| GET | `/api/uploads/{id}` | GET /api/uploads/{id} shows an upload (registered chunks). |
| POST | `/api/uploads/{id}/chunks` | POST /api/uploads/{id}/chunks registers the chunk list in order, at most 4096 per request. |
| PUT | `/api/uploads/{id}/chunks/{hash}` | PUT /api/uploads/{id}/chunks/{hash} with the chunk's bytes (204). |
| POST | `/api/uploads/{id}/complete` | POST /api/uploads/{id}/complete writes the file and returns its Entry. |
| GET | `/api/usage` | Read current usage and limits |
| POST | `/api/waitlist` | Join waitlist |
| POST | `/api/waitlist/admit` | POST /api/waitlist/admit |
| GET | `/api/waitlist/{code}` | Check waitlist entry |
| POST | `/auth/browser-session` | none {ticket} {token} — single-use, 60 s (local mode only) |
| GET | `/auth/config` | GET /auth/config |
| GET | `/changes` | GET /changes Event[] |
| GET | `/entries` | API |
| POST | `/entries` | API |
| DELETE | `/files/{id}` | DELETE /files/{id} {deleted} |
| GET | `/files/{id}` | API |

…and 30 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/flockfs-com/openapi/_ae-authored/flockfs-com-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/flockfs-com/json-schema/flockfs-com-post-api-tokens-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/flockfs-com/json-schema/flockfs-com-post-share-links-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/flockfs-com/json-schema/flockfs-com-get-api-billing-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/flockfs-com/json-schema/flockfs-com-get-api-me-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/flockfs-com/json-schema/flockfs-com-post-entries-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/flockfs-com/json-schema/flockfs-com-get-api-stoken-response-schema.json

## Other flockfs APIs (1)

- [FlockFS API](https://apis.io/apis/flockfs-com/flockfs-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/flockfs-com/flockfs-com-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/flockfs-com/.