Constants

Roxy provides a number of predefined constants to make scripting easier.
These constants are available in Lua, Python, and JavaScript (Boa) engines.

Method

HTTP request methods:

Method = {
  CONNECT = "CONNECT",
  DELETE  = "DELETE",
  GET     = "GET",
  HEAD    = "HEAD",
  OPTIONS = "OPTIONS",
  PATCH   = "PATCH",
  POST    = "POST",
  PUT     = "PUT",
  TRACE   = "TRACE",
}

if flow.request.method == Method.GET then
  flow.request.method = Method.POST
end

Protocol

Protocol = {
  HTTP  = "http",
  HTTPS = "https",
}

if flow.request.url.protocol == Protocol.HTTP then
  flow.request.url.protocol = Protocol.HTTPS
end

Version

Version = {
  HTTP09 = "HTTP/0.9",
  HTTP10 = "HTTP/1.0",
  HTTP11 = "HTTP/1.1",
  HTTP2  = "HTTP/2",
  HTTP3  = "HTTP/3",
}

if flow.request.version == Version.HTTP11 then
  flow.request.version == Version.HTTP10
end

Constants

Status = {
  CONTINUE                      = 100,
  SWITCHING_PROTOCOLS           = 101,
  PROCESSING                    = 102,
  OK                            = 200,
  CREATED                       = 201,
  ACCEPTED                      = 202,
  NON_AUTHORITATIVE_INFORMATION = 203,
  NO_CONTENT                    = 204,
  RESET_CONTENT                 = 205,
  PARTIAL_CONTENT               = 206,
  MULTI_STATUS                  = 207,
  ALREADY_REPORTED              = 208,
  IM_USED                       = 226,
  MULTIPLE_CHOICES              = 300,
  MOVED_PERMANENTLY             = 301,
  FOUND                         = 302,
  SEE_OTHER                     = 303,
  NOT_MODIFIED                  = 304,
  USE_PROXY                     = 305,
  TEMPORARY_REDIRECT            = 307,
  PERMANENT_REDIRECT            = 308,
  BAD_REQUEST                   = 400,
  UNAUTHORIZED                  = 401,
  PAYMENT_REQUIRED              = 402,
  FORBIDDEN                     = 403,
  NOT_FOUND                     = 404,
  METHOD_NOT_ALLOWED            = 405,
  NOT_ACCEPTABLE                = 406,
  PROXY_AUTHENTICATION_REQUIRED = 407,
  REQUEST_TIMEOUT               = 408,
  CONFLICT                      = 409,
  GONE                          = 410,
  LENGTH_REQUIRED               = 411,
  PRECONDITION_FAILED           = 412,
  PAYLOAD_TOO_LARGE             = 413,
  URI_TOO_LONG                  = 414,
  UNSUPPORTED_MEDIA_TYPE        = 415,
  RANGE_NOT_SATISFIABLE         = 416,
  EXPECTATION_FAILED            = 417,
  IM_A_TEAPOT                   = 418,
  MISDIRECTED_REQUEST           = 421,
  UNPROCESSABLE_ENTITY          = 422,
  LOCKED                        = 423,
  FAILED_DEPENDENCY             = 424,
  TOO_EARLY                     = 425,
  UPGRADE_REQUIRED              = 426,
  PRECONDITION_REQUIRED         = 428,
  TOO_MANY_REQUESTS             = 429,
  REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
  UNAVAILABLE_FOR_LEGAL_REASONS = 451,
  INTERNAL_SERVER_ERROR         = 500,
  NOT_IMPLEMENTED               = 501,
  BAD_GATEWAY                   = 502,
  SERVICE_UNAVAILABLE           = 503,
  GATEWAY_TIMEOUT               = 504,
  HTTP_VERSION_NOT_SUPPORTED    = 505,
  VARIANT_ALSO_NEGOTIATES       = 506,
  INSUFFICIENT_STORAGE          = 507,
  LOOP_DETECTED                 = 508,
  NOT_EXTENDED                  = 510,
  NETWORK_AUTHENTICATION_REQUIRED = 511,
}

if response.status == Status.NOT_FOUND then
  notify(2, "Got a 404!")
end