The Dotfile API returns the following status codes:
| Code | Description |
|---|---|
| 200 - OK | Everything worked as expected. |
| 201 - Created | The resource was created successfully. |
| 204 - No content | The resource was deleted successfully. |
| 400 - Bad Request | The request could not be accepted, due to missing or incorrect parameters. The response body names what to fix. |
| 401 - Unauthorized | No API key was provided, or the key is not valid. |
| 403 - Forbidden | The API key is valid but the call comes from an IP outside the allowlist configured on that key. |
| 404 - Not Found | The requested resource could not be found. |
| 409 - Conflict | The request failed due to the current state of the resource. |
| 413 - Payload Too Large | The uploaded file is too large. The maximum is 20MB on POST /files/upload. |
| 415 - Unsupported Media Type | The uploaded file type is not supported. |
| 429 - Too Many Requests | The rate limit was exceeded. Retry after a pause and space out the calls that follow. |
| 500 - Internal Server Error | The Dotfile API encountered an internal error. The failure is reported automatically and does not need to be raised with support. |
| 502 - Bad Gateway | A third party Dotfile calls in the request path is unavailable. The request is safe to retry. |
Rate limits
The limit is counted per workspace API key, and reads have a larger budget than writes:
| Requests | Average | Burst |
|---|---|---|
GET | 800 per minute | 200 |
POST, PATCH, DELETE | 300 per minute | 100 |
The average is the sustained rate. The burst is how many requests may arrive at once, above that
rate, before the limiter starts refusing them: a bucket depth, not a per-second rate.
A request over the limit returns 429 Too Many Requests. Retry it after a short pause and space
out the calls that follow. An integration that needs a higher limit should raise it with
[email protected].