Status codes
API status codes, what they mean, and when they can be returned.
status (in JSON response) and WebSocket close codes are different things:
statusdescribes result of one API operation.- close code ends the whole socket session.
Status codes
| Code | Status | When it can be returned |
|---|---|---|
0 | None | Reserved value to indicate no status. |
1 | Ok | Operation completed successfully. |
2 | InvalidAPIKey | websocket_api_key has invalid format/length. |
3 | NotAuthorized | Operation requires authorization, but current session is not authorized for it. |
4 | AlreadyInitialized | Initialize was called on an already initialized session. |
5 | TooManyRequests | Request exceeded operation-specific request limits (for example account creation limit from one IP). |
6 | InternalServerError | Server failed to process request due to an internal error. |
7 | AlreadyAuthorized | Authorization was requested for a session that is already authorized. |
8 | RateLimited | Reserved status for API throttling responses. Current documented WebSocket flows mainly surface throttling through HTTP 429, close code 4201, or packet-specific TooManyRequests. |
100 | LicenseNotFound | Provided license was not found in the application. |
101 | LicenseTooShort | Provided license is shorter than allowed minimum length. |
102 | LicenseTooLong | Provided license is longer than allowed maximum length. |
103 | LicenseExpired | License exists but is expired at validation/read time. |
104 | LicensePaused | License exists but is paused. |
105 | LicenseBlacklisted | License exists but is blacklisted. |
106 | LicenseAlreadyLinked | License is already linked to an account and cannot be linked again. |
107 | LicenseAlreadyActivated | License is already activated and cannot be activated again in this flow. |
200 | AppUserNotFound | Application user was not found (or provided credentials are invalid in auth flows). |
201 | AppUserBlacklisted | Application user is blacklisted. |
202 | AppUserAlreadyExists | Account creation failed because account already exists. |
203 | AppUserHasNoValidLicenses | User has no active licenses required for requested operation. |
204 | AppUserRequiresLicense | Operation requires non-empty license input, but request does not provide valid license value. |
205 | AppUserLoginTooShort | login is shorter than allowed minimum length. |
206 | AppUserLoginTooLong | login is longer than allowed maximum length. |
207 | AppUserPasswordTooShort | password is shorter than allowed minimum length. |
208 | AppUserPasswordTooLong | password is longer than allowed maximum length. |
209 | AppUserEmailInvalid | login is not a valid email format when email credentials mode is used. |
210 | AppUserCredentialsTypeInvalid | credentials_type contains unsupported value. |
300 | FileNotFound | Requested file was not found. |
301 | FileInvalidName | filename has invalid value (for example too short). |
302 | FileChecksumMismatch | File checksum validation failed on client side after transfer. |
303 | FileInvalidResumeOffset | resume_at is outside valid file range for resume. |
304 | FileStorageQuotaExceeded | File transfer/storage quota was exceeded. |
305 | FileNotBeingTransferred | Stop-transfer request was sent for a file that has no active transfer in this session. |
306 | FileTransferStopped | Active file transfer was stopped before completion. |
400 | VariableNotFound | Requested application variable was not found. |
401 | VariableInvalidName | Variable name has invalid value (for example too short). |
500 | ClientIDTooShort | client_id is shorter than allowed minimum length. |
501 | ClientIDTooLong | client_id is longer than allowed maximum length. |
502 | ClientIDMismatch | License/account is bound to a different client_id than current session. |
503 | ClientIDBlacklisted | client_id is blacklisted for the application. |
600 | AppNotFound | Application was not found for provided API key. |
601 | AppPaused | Application is paused. |
602 | AppSessionsQuotaExceeded | Authorized sessions count reached the application plan limit. |
603 | AppAccountsQuotaExceeded | Accounts quota reached for the application plan. |
604 | AppBlacklistsQuotaExceeded | Blacklist entries quota reached for the application plan. |
700 | StoreValueNotFound | Session store value for requested key is missing or expired. |
701 | StoreOutOfMemory | Session store memory limit is exceeded for this write. |
702 | StoreOutOfEntries | Session store entries count limit is exceeded for this write. |
Special cases
Noneis used only for intermediate stream chunks inTransfer file.FileChecksumMismatchis a client-side status and is not sent by server.