Protocol
Status codes
APIStatus values returned in Blazeauth responses.
Most Blazeauth responses include a numeric status field (APIStatus).
1 means success (OK).
0 means no status and is primarily used for file-transfer chunks.
| Code | Name | Meaning |
|---|
| 0 | none | No status (used for streaming chunks). |
| 1 | ok | Success. |
| 2 | invalid_api_key | API key is invalid or has an invalid format. |
| 3 | not_authorized | Operation requires authorization but the session is not authorized. |
| 4 | already_initialized | initialize was called more than once for the same connection. |
| 5 | too_many_requests | Per-endpoint throttle (used by create_account). |
| 6 | internal_server_error | Server-side error. |
| 7 | session_value_not_found | Requested session key is missing or expired. |
| 8 | already_authorized | Authorization was already performed for the session. |
| 9 | rate_limited | Global rate limit was hit. |
| 10 | sessions_quota_exceeded | Plan quota for authorized sessions was exceeded. |
| 11 | blacklists_quota_exceeded | Plan quota for blacklist entries was exceeded. |
| 12 | accounts_quota_exceeded | Plan quota for accounts was exceeded. |
| Code | Name | Meaning |
|---|
| 100 | license_invalid | License key does not exist or cannot be used. |
| 101 | license_expired | License is expired (time left is <= 0). |
| 102 | license_paused | License is paused (temporarily disabled). |
| 103 | license_blacklisted | License is blacklisted. |
| 104 | license_already_linked | License is already linked to an account. |
| 105 | license_already_activated | License is already activated. |
| Code | Name | Meaning |
|---|
| 200 | account_not_found | Account does not exist or credentials are wrong. |
| 201 | account_blacklisted | Account is blacklisted. |
| 202 | account_already_exists | Cannot create account because login/email is already taken. |
| 203 | account_has_no_valid_licenses | Account requires a license, but no active licenses were found. |
| 204 | account_requires_license | Application requires a license for account creation, but none was provided. |
| 205 | account_login_too_long | Login/email is too long. |
| 206 | account_login_too_short | Login/email is too short. |
| 207 | account_password_too_long | Password is too long. |
| 208 | account_password_too_short | Password is too short. |
| 209 | account_email_invalid | Email is not a valid email address (email credentials type only). |
| 210 | account_credentials_type_invalid | Unknown credentials type. |
| Code | Name | Meaning |
|---|
| 300 | file_not_found | File does not exist. |
| 301 | file_invalid_name | File name is invalid (too short). |
| 302 | file_checksum_mismatch | File integrity check failed. |
| 303 | file_invalid_resume_offset | Resume offset is out of bounds. |
| 304 | file_storage_quota_exceeded | Storage/transfer quota was exceeded during streaming. |
| 305 | file_tokens_quota_exceeded | Resume token quota was exceeded. |
| 306 | file_not_being_transferred | Tried to stop a file transfer that is not active in this session. |
| 307 | file_invalid_resume_token | Resume token does not exist or is invalid. |
| 308 | file_transfer_stopped | File transfer was stopped (see stop_file_transfer). |
| Code | Name | Meaning |
|---|
| 400 | variable_not_found | Variable does not exist. |
| 401 | variable_invalid_name | Variable name is invalid (too short). |
| Code | Name | Meaning |
|---|
| 500 | client_id_too_long | Client id is too long. |
| 501 | client_id_mismatch | Client id does not match the one bound to the license/account. |
| 502 | client_id_blacklisted | Client id is blacklisted. |
| Code | Name | Meaning |
|---|
| 600 | app_not_found | Application for the provided API key was not found. |
| 601 | app_paused | Application is paused. |