In conjunction with proper HTTP status codes, non-2xx responses will have the following schema:
1 2{ code: string; // "INVALID_KEY_FORMAT" message: string; // "Invalid key format" }
Each 400 Bad Request response will be accompanied by an error code containing more information. The following tables lists all possible error codes, what they mean, and what you can do to address each one:
Forge hosted storage capabilities are subject to limits, usage, and syntax constraints. These include limits to the number of operations, key lengths, and object depth. Any request that exceeds a quota or limit will return a
429 status with an error code of RATE_LIMIT_EXCEEDED.
See Storage quotas and Storage limits for details about relevant constraints.
| Error code | Description |
|---|---|
| EMPTY_KEY | Key cannot be empty. |
| INVALID_KEY | The provided key does not match the regex: /^(?!\s+$)[a-zA-Z0-9:._\s-#]+$/ |
| KEY_TOO_LONG | The provided key has exceeded the maximum 500 characters. |
| NOT_FOUND | The specified key does not exist. |
| Error code | Description |
|---|---|
| MAX_SIZE | The provided value has exceeded the maximum size limit. |
| MAX_DEPTH | The provided value has exceeded the maximum object depth (32) limit. |
| Error code | Description |
|---|---|
| ENTITY_TYPE_TOO_SHORT | The provided key needs to be more than 3 characters. |
| ENTITY_TYPE_TOO_LARGE | The provided key has exceeded the maximum 60 characters. |
| INVALID_ENTITY_TYPE | The provided key does not match the regex: /^(?![\.\-])(?!.*\.{2})[a-z0-9:\-.]*(?<![.])$/. |
| INVALID_ENTITY_VALUE | Entity values must match one of the types defined in Custom Entities. |
| INVALID_ENTITY_ATTRIBUTE | The specified attribute name is a reserved value and cannot be utilized. |
| INVALID_ENTITY_INDEX | The custom entity index provided is invalid. The index name is a reserved value and cannot be utilized. |
| Error code | Description |
|---|---|
| COMPLEX_QUERY_PAGE_LIMIT_NOT_IN_RANGE | The page limit must be set between 1 and 100. |
| EMPTY_FILTER_OPERATOR | Filter operators "and" and "or" cannot be empty. |
| INVALID_FILTER_OPERATORS_COMBINATION | Filter operators "and" and "or" cannot be present at the same level. |
| INSUFFICIENT_FILTER_VALUES | The specified condition needs at least two values. |
Rate this page: