Skip to content

Latest commit

History

History
26 lines (19 loc) · 1.54 KB

File metadata and controls

26 lines (19 loc) · 1.54 KB

APIError

Properties

NameTypeDescriptionNotes
codeCodeEnumError code: * server_error - Internal server error. * invalid_parameter - Validation error, parameter will contain invalid field and message will contain the reason. * invalid_body - Body could not be parsed, message will contain the reason. * invalid_request - Validation error, the protocol used to make the request was not https. * unauthorized - Credentials were found but permissions were not sufficient. * unauthenticated - Credentials were not found or were not valid. * not_found - The requested resource was not found. * rate_limited - The request was refused because a rate limit was exceeded. There is an account wide rate limit of 3600 requests per-minute, although that is subject to change. The current remaining rate limit can be viewed by checking the X-Ratelimit-Remaining header.[optional]
messageStringHuman readable error message[optional]
parameterStringThe invalid parameter, if 'code' is invalid_parameter[optional]

Enum: CodeEnum

NameValue
SERVER_ERROR"server_error"
INVALID_PARAMETER"invalid_parameter"
INVALID_BODY"invalid_body"
INVALID_REQUEST"invalid_request"
UNAUTHORIZED"unauthorized"
UNAUTHENTICATED"unauthenticated"
NOT_FOUND"not_found"
RATE_LIMITED"rate_limited"