REST API reference

The TrueFTP REST API lets you manage your account programmatically — create FTP users, read the audit event stream, and configure webhooks. It is available on paid plans only.

This is distinct from the S3-compatible API: the REST API uses a tftp_ Bearer token, while the S3 API uses an AKIA… access key + secret.

Base URL

https://www.trueftp.com/api/ext/v1

Authentication

Create an API key in the dashboard under API Keys. The token is shown once — store it securely. Send it as a Bearer token:

curl https://www.trueftp.com/api/ext/v1/account \
  -H "Authorization: Bearer tftp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

The account is derived from the key — you never pass an account ID.

Scopes

Each key has scopes:

• read — all GET endpoints
• write — create / update / delete

A request lacking the required scope returns 403.

Rate limits

Each key has an hourly limit (default 1000/hour). Responses include X-RateLimit-Limit and X-RateLimit-Remaining; exceeding it returns 429 with a Retry-After header.

Endpoints

Create an FTP user

curl -X POST https://www.trueftp.com/api/ext/v1/ftp-users \
  -H "Authorization: Bearer tftp_..." \
  -H "Content-Type: application/json" \
  -d '{"username":"pipeline","password":"a-strong-secret","can_write":true}'

List events (pagination)

List endpoints return a consistent envelope:

curl "https://www.trueftp.com/api/ext/v1/events?limit=50&offset=0" \
  -H "Authorization: Bearer tftp_..."

{ "data": [ /* … */ ], "limit": 50, "offset": 0, "total": 1287 }

Errors

Errors are JSON with an error field:

{ "error": "missing required scope: write" }