For the complete documentation index, see llms.txt. This page is also available as Markdown.

Errors

RedirHub uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted or was invalid). Codes in the 5xx range indicate an error with our servers.

Generally speaking, API errors are broken into the following categories:

  • Request Validation Errors - A request was made with invalid parameters. This can be because of a missing parameter, an invalid parameter, or a parameter that is not allowed.

  • Rate Limit Error - The request was made too many times in a given amount of time.

  • Billing/Subscription Errors(fixed code: 482) - The action need higher grade subscription or the corresponding account does not have an active subscription.

  • Permissions Errors - You do not have sufficient permissions to invoke the request API endpoint, and/or access the requested resource.

Some 4xx errors will include a list of errors with additional attributes. This may be useful to programatically handle the error or display an error message in your own UI.

{
  "message": "Invalid Request",
  "errors": [
    {
      "resource": "rule",
      "param": "forward_params",
      "code": "invalid_option",
      "message": "Must be true or false"
    }
  ]
}

Last updated