http-status-codes
- Version 2.3.0
- Published
- 223 kB
- No dependencies
- MIT license
Install
npm i http-status-codes
yarn add http-status-codes
pnpm add http-status-codes
Overview
Constants enumerating the HTTP status codes. Based on the Java Apache HttpStatus API.
Index
Variables
- _default
- ACCEPTED
- BAD_GATEWAY
- BAD_REQUEST
- CONFLICT
- CONTINUE
- CREATED
- EXPECTATION_FAILED
- FAILED_DEPENDENCY
- FORBIDDEN
- GATEWAY_TIMEOUT
- getStatusText
- GONE
- HTTP_VERSION_NOT_SUPPORTED
- IM_A_TEAPOT
- INSUFFICIENT_SPACE_ON_RESOURCE
- INSUFFICIENT_STORAGE
- INTERNAL_SERVER_ERROR
- LENGTH_REQUIRED
- LOCKED
- METHOD_FAILURE
- METHOD_NOT_ALLOWED
- MOVED_PERMANENTLY
- MOVED_TEMPORARILY
- MULTI_STATUS
- MULTIPLE_CHOICES
- NETWORK_AUTHENTICATION_REQUIRED
- NO_CONTENT
- NON_AUTHORITATIVE_INFORMATION
- NOT_ACCEPTABLE
- NOT_FOUND
- NOT_IMPLEMENTED
- NOT_MODIFIED
- OK
- PARTIAL_CONTENT
- PAYMENT_REQUIRED
- PERMANENT_REDIRECT
- PRECONDITION_FAILED
- PRECONDITION_REQUIRED
- PROCESSING
- PROXY_AUTHENTICATION_REQUIRED
- REQUEST_HEADER_FIELDS_TOO_LARGE
- REQUEST_TIMEOUT
- REQUEST_TOO_LONG
- REQUEST_URI_TOO_LONG
- REQUESTED_RANGE_NOT_SATISFIABLE
- RESET_CONTENT
- SEE_OTHER
- SERVICE_UNAVAILABLE
- SWITCHING_PROTOCOLS
- TEMPORARY_REDIRECT
- TOO_MANY_REQUESTS
- UNAUTHORIZED
- UNPROCESSABLE_ENTITY
- UNSUPPORTED_MEDIA_TYPE
- USE_PROXY
Functions
Enums
ReasonPhrases
- ACCEPTED
- BAD_GATEWAY
- BAD_REQUEST
- CONFLICT
- CONTINUE
- CREATED
- EARLY_HINTS
- EXPECTATION_FAILED
- FAILED_DEPENDENCY
- FORBIDDEN
- GATEWAY_TIMEOUT
- GONE
- HTTP_VERSION_NOT_SUPPORTED
- IM_A_TEAPOT
- INSUFFICIENT_SPACE_ON_RESOURCE
- INSUFFICIENT_STORAGE
- INTERNAL_SERVER_ERROR
- LENGTH_REQUIRED
- LOCKED
- METHOD_FAILURE
- METHOD_NOT_ALLOWED
- MISDIRECTED_REQUEST
- MOVED_PERMANENTLY
- MOVED_TEMPORARILY
- MULTI_STATUS
- MULTIPLE_CHOICES
- NETWORK_AUTHENTICATION_REQUIRED
- NO_CONTENT
- NON_AUTHORITATIVE_INFORMATION
- NOT_ACCEPTABLE
- NOT_FOUND
- NOT_IMPLEMENTED
- NOT_MODIFIED
- OK
- PARTIAL_CONTENT
- PAYMENT_REQUIRED
- PERMANENT_REDIRECT
- PRECONDITION_FAILED
- PRECONDITION_REQUIRED
- PROCESSING
- PROXY_AUTHENTICATION_REQUIRED
- REQUEST_HEADER_FIELDS_TOO_LARGE
- REQUEST_TIMEOUT
- REQUEST_TOO_LONG
- REQUEST_URI_TOO_LONG
- REQUESTED_RANGE_NOT_SATISFIABLE
- RESET_CONTENT
- SEE_OTHER
- SERVICE_UNAVAILABLE
- SWITCHING_PROTOCOLS
- TEMPORARY_REDIRECT
- TOO_MANY_REQUESTS
- UNAUTHORIZED
- UNAVAILABLE_FOR_LEGAL_REASONS
- UNPROCESSABLE_ENTITY
- UNSUPPORTED_MEDIA_TYPE
- UPGRADE_REQUIRED
- USE_PROXY
StatusCodes
- ACCEPTED
- BAD_GATEWAY
- BAD_REQUEST
- CONFLICT
- CONTINUE
- CREATED
- EARLY_HINTS
- EXPECTATION_FAILED
- FAILED_DEPENDENCY
- FORBIDDEN
- GATEWAY_TIMEOUT
- GONE
- HTTP_VERSION_NOT_SUPPORTED
- IM_A_TEAPOT
- INSUFFICIENT_SPACE_ON_RESOURCE
- INSUFFICIENT_STORAGE
- INTERNAL_SERVER_ERROR
- LENGTH_REQUIRED
- LOCKED
- METHOD_FAILURE
- METHOD_NOT_ALLOWED
- MISDIRECTED_REQUEST
- MOVED_PERMANENTLY
- MOVED_TEMPORARILY
- MULTI_STATUS
- MULTIPLE_CHOICES
- NETWORK_AUTHENTICATION_REQUIRED
- NO_CONTENT
- NON_AUTHORITATIVE_INFORMATION
- NOT_ACCEPTABLE
- NOT_FOUND
- NOT_IMPLEMENTED
- NOT_MODIFIED
- OK
- PARTIAL_CONTENT
- PAYMENT_REQUIRED
- PERMANENT_REDIRECT
- PRECONDITION_FAILED
- PRECONDITION_REQUIRED
- PROCESSING
- PROXY_AUTHENTICATION_REQUIRED
- REQUEST_HEADER_FIELDS_TOO_LARGE
- REQUEST_TIMEOUT
- REQUEST_TOO_LONG
- REQUEST_URI_TOO_LONG
- REQUESTED_RANGE_NOT_SATISFIABLE
- RESET_CONTENT
- SEE_OTHER
- SERVICE_UNAVAILABLE
- SWITCHING_PROTOCOLS
- TEMPORARY_REDIRECT
- TOO_MANY_REQUESTS
- UNAUTHORIZED
- UNAVAILABLE_FOR_LEGAL_REASONS
- UNPROCESSABLE_ENTITY
- UNSUPPORTED_MEDIA_TYPE
- UPGRADE_REQUIRED
- USE_PROXY
Variables
variable _default
const _default: { getStatusCode: typeof getStatusCode; getStatusText: typeof import('./utils-functions').getReasonPhrase; ACCEPTED: number; BAD_GATEWAY: number; BAD_REQUEST: number; CONFLICT: number; CONTINUE: number; CREATED: number; EXPECTATION_FAILED: number; FORBIDDEN: number; GATEWAY_TIMEOUT: number; GONE: number; HTTP_VERSION_NOT_SUPPORTED: number; IM_A_TEAPOT: number; INSUFFICIENT_SPACE_ON_RESOURCE: number; INSUFFICIENT_STORAGE: number; INTERNAL_SERVER_ERROR: number; LENGTH_REQUIRED: number; LOCKED: number; METHOD_FAILURE: number; METHOD_NOT_ALLOWED: number; MOVED_PERMANENTLY: number; MOVED_TEMPORARILY: number; MULTI_STATUS: number; MULTIPLE_CHOICES: number; NETWORK_AUTHENTICATION_REQUIRED: number; NO_CONTENT: number; NON_AUTHORITATIVE_INFORMATION: number; NOT_ACCEPTABLE: number; NOT_FOUND: number; NOT_IMPLEMENTED: number; NOT_MODIFIED: number; OK: number; PARTIAL_CONTENT: number; PAYMENT_REQUIRED: number; PERMANENT_REDIRECT: number; PRECONDITION_FAILED: number; PRECONDITION_REQUIRED: number; PROCESSING: number; PROXY_AUTHENTICATION_REQUIRED: number; REQUEST_HEADER_FIELDS_TOO_LARGE: number; REQUEST_TIMEOUT: number; REQUEST_TOO_LONG: number; REQUEST_URI_TOO_LONG: number; REQUESTED_RANGE_NOT_SATISFIABLE: number; RESET_CONTENT: number; SEE_OTHER: number; SERVICE_UNAVAILABLE: number; SWITCHING_PROTOCOLS: number; TEMPORARY_REDIRECT: number; TOO_MANY_REQUESTS: number; UNAUTHORIZED: number; UNPROCESSABLE_ENTITY: number; UNSUPPORTED_MEDIA_TYPE: number; USE_PROXY: number;};
variable ACCEPTED
const ACCEPTED: number;
Deprecated
Please use StatusCodes.ACCEPTED
variable BAD_GATEWAY
const BAD_GATEWAY: number;
Deprecated
Please use StatusCodes.BAD_GATEWAY
variable BAD_REQUEST
const BAD_REQUEST: number;
Deprecated
Please use StatusCodes.BAD_REQUEST
variable CONFLICT
const CONFLICT: number;
Deprecated
Please use StatusCodes.CONFLICT
variable CONTINUE
const CONTINUE: number;
Deprecated
Please use StatusCodes.CONTINUE
variable CREATED
const CREATED: number;
Deprecated
Please use StatusCodes.CREATED
variable EXPECTATION_FAILED
const EXPECTATION_FAILED: number;
Deprecated
Please use StatusCodes.EXPECTATION_FAILED
variable FAILED_DEPENDENCY
const FAILED_DEPENDENCY: number;
Deprecated
Please use StatusCodes.FAILED_DEPENDENCY
variable FORBIDDEN
const FORBIDDEN: number;
Deprecated
Please use StatusCodes.FORBIDDEN
variable GATEWAY_TIMEOUT
const GATEWAY_TIMEOUT: number;
Deprecated
Please use StatusCodes.GATEWAY_TIMEOUT
variable getStatusText
const getStatusText: (statusCode: string | number) => string;
Parameter statusCode
The HTTP status code
Returns
{string|undefined} The associated reason phrase (e.g. "Bad Request", "OK")
Deprecated
Returns the reason phrase for the given status code. If the given status code does not exist, undefined is returned.
Deprecated in favor of getReasonPhrase
variable GONE
const GONE: number;
Deprecated
Please use StatusCodes.GONE
variable HTTP_VERSION_NOT_SUPPORTED
const HTTP_VERSION_NOT_SUPPORTED: number;
Deprecated
Please use StatusCodes.HTTP_VERSION_NOT_SUPPORTED
variable IM_A_TEAPOT
const IM_A_TEAPOT: number;
Deprecated
Please use StatusCodes.IM_A_TEAPOT
variable INSUFFICIENT_SPACE_ON_RESOURCE
const INSUFFICIENT_SPACE_ON_RESOURCE: number;
Deprecated
Please use StatusCodes.INSUFFICIENT_SPACE_ON_RESOURCE
variable INSUFFICIENT_STORAGE
const INSUFFICIENT_STORAGE: number;
Deprecated
Please use StatusCodes.INSUFFICIENT_STORAGE
variable INTERNAL_SERVER_ERROR
const INTERNAL_SERVER_ERROR: number;
Deprecated
Please use StatusCodes.INTERNAL_SERVER_ERROR
variable LENGTH_REQUIRED
const LENGTH_REQUIRED: number;
Deprecated
Please use StatusCodes.LENGTH_REQUIRED
variable LOCKED
const LOCKED: number;
Deprecated
Please use StatusCodes.LOCKED
variable METHOD_FAILURE
const METHOD_FAILURE: number;
Deprecated
Please use StatusCodes.METHOD_FAILURE
variable METHOD_NOT_ALLOWED
const METHOD_NOT_ALLOWED: number;
Deprecated
Please use StatusCodes.METHOD_NOT_ALLOWED
variable MOVED_PERMANENTLY
const MOVED_PERMANENTLY: number;
Deprecated
Please use StatusCodes.MOVED_PERMANENTLY
variable MOVED_TEMPORARILY
const MOVED_TEMPORARILY: number;
Deprecated
Please use StatusCodes.MOVED_TEMPORARILY
variable MULTI_STATUS
const MULTI_STATUS: number;
Deprecated
Please use StatusCodes.MULTI_STATUS
variable MULTIPLE_CHOICES
const MULTIPLE_CHOICES: number;
Deprecated
Please use StatusCodes.MULTIPLE_CHOICES
variable NETWORK_AUTHENTICATION_REQUIRED
const NETWORK_AUTHENTICATION_REQUIRED: number;
Deprecated
Please use StatusCodes.NETWORK_AUTHENTICATION_REQUIRED
variable NO_CONTENT
const NO_CONTENT: number;
Deprecated
Please use StatusCodes.NO_CONTENT
variable NON_AUTHORITATIVE_INFORMATION
const NON_AUTHORITATIVE_INFORMATION: number;
Deprecated
Please use StatusCodes.NON_AUTHORITATIVE_INFORMATION
variable NOT_ACCEPTABLE
const NOT_ACCEPTABLE: number;
Deprecated
Please use StatusCodes.NOT_ACCEPTABLE
variable NOT_FOUND
const NOT_FOUND: number;
Deprecated
Please use StatusCodes.NOT_FOUND
variable NOT_IMPLEMENTED
const NOT_IMPLEMENTED: number;
Deprecated
Please use StatusCodes.NOT_IMPLEMENTED
variable NOT_MODIFIED
const NOT_MODIFIED: number;
Deprecated
Please use StatusCodes.NOT_MODIFIED
variable OK
const OK: number;
Deprecated
Please use StatusCodes.OK
variable PARTIAL_CONTENT
const PARTIAL_CONTENT: number;
Deprecated
Please use StatusCodes.PARTIAL_CONTENT
variable PAYMENT_REQUIRED
const PAYMENT_REQUIRED: number;
Deprecated
Please use StatusCodes.PAYMENT_REQUIRED
variable PERMANENT_REDIRECT
const PERMANENT_REDIRECT: number;
Deprecated
Please use StatusCodes.PERMANENT_REDIRECT
variable PRECONDITION_FAILED
const PRECONDITION_FAILED: number;
Deprecated
Please use StatusCodes.PRECONDITION_FAILED
variable PRECONDITION_REQUIRED
const PRECONDITION_REQUIRED: number;
Deprecated
Please use StatusCodes.PRECONDITION_REQUIRED
variable PROCESSING
const PROCESSING: number;
Deprecated
Please use StatusCodes.PROCESSING
variable PROXY_AUTHENTICATION_REQUIRED
const PROXY_AUTHENTICATION_REQUIRED: number;
Deprecated
Please use StatusCodes.PROXY_AUTHENTICATION_REQUIRED
variable REQUEST_HEADER_FIELDS_TOO_LARGE
const REQUEST_HEADER_FIELDS_TOO_LARGE: number;
Deprecated
Please use StatusCodes.REQUEST_HEADER_FIELDS_TOO_LARGE
variable REQUEST_TIMEOUT
const REQUEST_TIMEOUT: number;
Deprecated
Please use StatusCodes.REQUEST_TIMEOUT
variable REQUEST_TOO_LONG
const REQUEST_TOO_LONG: number;
Deprecated
Please use StatusCodes.REQUEST_TOO_LONG
variable REQUEST_URI_TOO_LONG
const REQUEST_URI_TOO_LONG: number;
Deprecated
Please use StatusCodes.REQUEST_URI_TOO_LONG
variable REQUESTED_RANGE_NOT_SATISFIABLE
const REQUESTED_RANGE_NOT_SATISFIABLE: number;
Deprecated
Please use StatusCodes.REQUESTED_RANGE_NOT_SATISFIABLE
variable RESET_CONTENT
const RESET_CONTENT: number;
Deprecated
Please use StatusCodes.RESET_CONTENT
variable SEE_OTHER
const SEE_OTHER: number;
Deprecated
Please use StatusCodes.SEE_OTHER
variable SERVICE_UNAVAILABLE
const SERVICE_UNAVAILABLE: number;
Deprecated
Please use StatusCodes.SERVICE_UNAVAILABLE
variable SWITCHING_PROTOCOLS
const SWITCHING_PROTOCOLS: number;
Deprecated
Please use StatusCodes.SWITCHING_PROTOCOLS
variable TEMPORARY_REDIRECT
const TEMPORARY_REDIRECT: number;
Deprecated
Please use StatusCodes.TEMPORARY_REDIRECT
variable TOO_MANY_REQUESTS
const TOO_MANY_REQUESTS: number;
Deprecated
Please use StatusCodes.TOO_MANY_REQUESTS
variable UNAUTHORIZED
const UNAUTHORIZED: number;
Deprecated
Please use StatusCodes.UNAUTHORIZED
variable UNPROCESSABLE_ENTITY
const UNPROCESSABLE_ENTITY: number;
Deprecated
Please use StatusCodes.UNPROCESSABLE_ENTITY
variable UNSUPPORTED_MEDIA_TYPE
const UNSUPPORTED_MEDIA_TYPE: number;
Deprecated
Please use StatusCodes.UNSUPPORTED_MEDIA_TYPE
variable USE_PROXY
const USE_PROXY: number;
Deprecated
Please use StatusCodes.USE_PROXY
Functions
function getReasonPhrase
getReasonPhrase: (statusCode: number | string) => string;
Returns the reason phrase for the given status code. If the given status code does not exist, an error is thrown.
Parameter statusCode
The HTTP status code
Returns
{string} The associated reason phrase (e.g. "Bad Request", "OK")
function getStatusCode
getStatusCode: (reasonPhrase: string) => number;
Returns the status code for the given reason phrase. If the given reason phrase does not exist, undefined is returned.
Parameter reasonPhrase
The HTTP reason phrase (e.g. "Bad Request", "OK")
Returns
{string} The associated status code
Enums
enum ReasonPhrases
enum ReasonPhrases { ACCEPTED = 'Accepted', BAD_GATEWAY = 'Bad Gateway', BAD_REQUEST = 'Bad Request', CONFLICT = 'Conflict', CONTINUE = 'Continue', CREATED = 'Created', EXPECTATION_FAILED = 'Expectation Failed', FAILED_DEPENDENCY = 'Failed Dependency', FORBIDDEN = 'Forbidden', GATEWAY_TIMEOUT = 'Gateway Timeout', GONE = 'Gone', HTTP_VERSION_NOT_SUPPORTED = 'HTTP Version Not Supported', IM_A_TEAPOT = "I'm a teapot", INSUFFICIENT_SPACE_ON_RESOURCE = 'Insufficient Space on Resource', INSUFFICIENT_STORAGE = 'Insufficient Storage', INTERNAL_SERVER_ERROR = 'Internal Server Error', LENGTH_REQUIRED = 'Length Required', LOCKED = 'Locked', METHOD_FAILURE = 'Method Failure', METHOD_NOT_ALLOWED = 'Method Not Allowed', MOVED_PERMANENTLY = 'Moved Permanently', MOVED_TEMPORARILY = 'Moved Temporarily', MULTI_STATUS = 'Multi-Status', MULTIPLE_CHOICES = 'Multiple Choices', NETWORK_AUTHENTICATION_REQUIRED = 'Network Authentication Required', NO_CONTENT = 'No Content', NON_AUTHORITATIVE_INFORMATION = 'Non Authoritative Information', NOT_ACCEPTABLE = 'Not Acceptable', NOT_FOUND = 'Not Found', NOT_IMPLEMENTED = 'Not Implemented', NOT_MODIFIED = 'Not Modified', OK = 'OK', PARTIAL_CONTENT = 'Partial Content', PAYMENT_REQUIRED = 'Payment Required', PERMANENT_REDIRECT = 'Permanent Redirect', PRECONDITION_FAILED = 'Precondition Failed', PRECONDITION_REQUIRED = 'Precondition Required', PROCESSING = 'Processing', EARLY_HINTS = 'Early Hints', UPGRADE_REQUIRED = 'Upgrade Required', PROXY_AUTHENTICATION_REQUIRED = 'Proxy Authentication Required', REQUEST_HEADER_FIELDS_TOO_LARGE = 'Request Header Fields Too Large', REQUEST_TIMEOUT = 'Request Timeout', REQUEST_TOO_LONG = 'Request Entity Too Large', REQUEST_URI_TOO_LONG = 'Request-URI Too Long', REQUESTED_RANGE_NOT_SATISFIABLE = 'Requested Range Not Satisfiable', RESET_CONTENT = 'Reset Content', SEE_OTHER = 'See Other', SERVICE_UNAVAILABLE = 'Service Unavailable', SWITCHING_PROTOCOLS = 'Switching Protocols', TEMPORARY_REDIRECT = 'Temporary Redirect', TOO_MANY_REQUESTS = 'Too Many Requests', UNAUTHORIZED = 'Unauthorized', UNAVAILABLE_FOR_LEGAL_REASONS = 'Unavailable For Legal Reasons', UNPROCESSABLE_ENTITY = 'Unprocessable Entity', UNSUPPORTED_MEDIA_TYPE = 'Unsupported Media Type', USE_PROXY = 'Use Proxy', MISDIRECTED_REQUEST = 'Misdirected Request',}
member ACCEPTED
ACCEPTED = 'Accepted'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.3
The request has been received but not yet acted upon. It is non-committal, meaning that there is no way in HTTP to later send an asynchronous response indicating the outcome of processing the request. It is intended for cases where another process or server handles the request, or for batch processing.
member BAD_GATEWAY
BAD_GATEWAY = 'Bad Gateway'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.3
This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.
member BAD_REQUEST
BAD_REQUEST = 'Bad Request'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.1
This response means that server could not understand the request due to invalid syntax.
member CONFLICT
CONFLICT = 'Conflict'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.8
This response is sent when a request conflicts with the current state of the server.
member CONTINUE
CONTINUE = 'Continue'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.2.1
This interim response indicates that everything so far is OK and that the client should continue with the request or ignore it if it is already finished.
member CREATED
CREATED = 'Created'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.2
The request has succeeded and a new resource has been created as a result of it. This is typically the response sent after a PUT request.
member EARLY_HINTS
EARLY_HINTS = 'Early Hints'
Official Documentation @ https://www.rfc-editor.org/rfc/rfc8297#page-3
This code indicates to the client that the server is likely to send a final response with the header fields included in the informational response.
member EXPECTATION_FAILED
EXPECTATION_FAILED = 'Expectation Failed'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.14
This response code means the expectation indicated by the Expect request header field can't be met by the server.
member FAILED_DEPENDENCY
FAILED_DEPENDENCY = 'Failed Dependency'
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.5
The request failed due to failure of a previous request.
member FORBIDDEN
FORBIDDEN = 'Forbidden'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.3
The client does not have access rights to the content, i.e. they are unauthorized, so server is rejecting to give proper response. Unlike 401, the client's identity is known to the server.
member GATEWAY_TIMEOUT
GATEWAY_TIMEOUT = 'Gateway Timeout'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.5
This error response is given when the server is acting as a gateway and cannot get a response in time.
member GONE
GONE = 'Gone'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.9
This response would be sent when the requested content has been permenantly deleted from server, with no forwarding address. Clients are expected to remove their caches and links to the resource. The HTTP specification intends this status code to be used for "limited-time, promotional services". APIs should not feel compelled to indicate resources that have been deleted with this status code.
member HTTP_VERSION_NOT_SUPPORTED
HTTP_VERSION_NOT_SUPPORTED = 'HTTP Version Not Supported'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.6
The HTTP version used in the request is not supported by the server.
member IM_A_TEAPOT
IM_A_TEAPOT = "I'm a teapot"
Official Documentation @ https://tools.ietf.org/html/rfc2324#section-2.3.2
Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout.
member INSUFFICIENT_SPACE_ON_RESOURCE
INSUFFICIENT_SPACE_ON_RESOURCE = 'Insufficient Space on Resource'
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.6
The 507 (Insufficient Storage) status code means the method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. This condition is considered to be temporary. If the request which received this status code was the result of a user action, the request MUST NOT be repeated until it is requested by a separate user action.
member INSUFFICIENT_STORAGE
INSUFFICIENT_STORAGE = 'Insufficient Storage'
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.6
The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.
member INTERNAL_SERVER_ERROR
INTERNAL_SERVER_ERROR = 'Internal Server Error'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.1
The server encountered an unexpected condition that prevented it from fulfilling the request.
member LENGTH_REQUIRED
LENGTH_REQUIRED = 'Length Required'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.10
The server rejected the request because the Content-Length header field is not defined and the server requires it.
member LOCKED
LOCKED = 'Locked'
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.4
The resource that is being accessed is locked.
member METHOD_FAILURE
METHOD_FAILURE = 'Method Failure'
Deprecated
Official Documentation @ https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt
A deprecated response used by the Spring Framework when a method has failed.
member METHOD_NOT_ALLOWED
METHOD_NOT_ALLOWED = 'Method Not Allowed'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.5
The request method is known by the server but has been disabled and cannot be used. For example, an API may forbid DELETE-ing a resource. The two mandatory methods, GET and HEAD, must never be disabled and should not return this error code.
member MISDIRECTED_REQUEST
MISDIRECTED_REQUEST = 'Misdirected Request'
Official Documentation @ https://datatracker.ietf.org/doc/html/rfc7540#section-9.1.2
Defined in the specification of HTTP/2 to indicate that a server is not able to produce a response for the combination of scheme and authority that are included in the request URI.
member MOVED_PERMANENTLY
MOVED_PERMANENTLY = 'Moved Permanently'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.2
This response code means that URI of requested resource has been changed. Probably, new URI would be given in the response.
member MOVED_TEMPORARILY
MOVED_TEMPORARILY = 'Moved Temporarily'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.3
This response code means that URI of requested resource has been changed temporarily. New changes in the URI might be made in the future. Therefore, this same URI should be used by the client in future requests.
member MULTI_STATUS
MULTI_STATUS = 'Multi-Status'
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.2
A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate.
member MULTIPLE_CHOICES
MULTIPLE_CHOICES = 'Multiple Choices'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.1
The request has more than one possible responses. User-agent or user should choose one of them. There is no standardized way to choose one of the responses.
member NETWORK_AUTHENTICATION_REQUIRED
NETWORK_AUTHENTICATION_REQUIRED = 'Network Authentication Required'
Official Documentation @ https://tools.ietf.org/html/rfc6585#section-6
The 511 status code indicates that the client needs to authenticate to gain network access.
member NO_CONTENT
NO_CONTENT = 'No Content'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.5
There is no content to send for this request, but the headers may be useful. The user-agent may update its cached headers for this resource with the new ones.
member NON_AUTHORITATIVE_INFORMATION
NON_AUTHORITATIVE_INFORMATION = 'Non Authoritative Information'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.4
This response code means returned meta-information set is not exact set as available from the origin server, but collected from a local or a third party copy. Except this condition, 200 OK response should be preferred instead of this response.
member NOT_ACCEPTABLE
NOT_ACCEPTABLE = 'Not Acceptable'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.6
This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content following the criteria given by the user agent.
member NOT_FOUND
NOT_FOUND = 'Not Found'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.4
The server can not find requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. This response code is probably the most famous one due to its frequent occurence on the web.
member NOT_IMPLEMENTED
NOT_IMPLEMENTED = 'Not Implemented'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.2
The request method is not supported by the server and cannot be handled. The only methods that servers are required to support (and therefore that must not return this code) are GET and HEAD.
member NOT_MODIFIED
NOT_MODIFIED = 'Not Modified'
Official Documentation @ https://tools.ietf.org/html/rfc7232#section-4.1
This is used for caching purposes. It is telling to client that response has not been modified. So, client can continue to use same cached version of response.
member OK
OK = 'OK'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.1
The request has succeeded. The meaning of a success varies depending on the HTTP method: GET: The resource has been fetched and is transmitted in the message body. HEAD: The entity headers are in the message body. POST: The resource describing the result of the action is transmitted in the message body. TRACE: The message body contains the request message as received by the server
member PARTIAL_CONTENT
PARTIAL_CONTENT = 'Partial Content'
Official Documentation @ https://tools.ietf.org/html/rfc7233#section-4.1
This response code is used because of range header sent by the client to separate download into multiple streams.
member PAYMENT_REQUIRED
PAYMENT_REQUIRED = 'Payment Required'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.2
This response code is reserved for future use. Initial aim for creating this code was using it for digital payment systems however this is not used currently.
member PERMANENT_REDIRECT
PERMANENT_REDIRECT = 'Permanent Redirect'
Official Documentation @ https://tools.ietf.org/html/rfc7538#section-3
This means that the resource is now permanently located at another URI, specified by the Location: HTTP Response header. This has the same semantics as the 301 Moved Permanently HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.
member PRECONDITION_FAILED
PRECONDITION_FAILED = 'Precondition Failed'
Official Documentation @ https://tools.ietf.org/html/rfc7232#section-4.2
The client has indicated preconditions in its headers which the server does not meet.
member PRECONDITION_REQUIRED
PRECONDITION_REQUIRED = 'Precondition Required'
Official Documentation @ https://tools.ietf.org/html/rfc6585#section-3
The origin server requires the request to be conditional. Intended to prevent the 'lost update' problem, where a client GETs a resource's state, modifies it, and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict.
member PROCESSING
PROCESSING = 'Processing'
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.1
This code indicates that the server has received and is processing the request, but no response is available yet.
member PROXY_AUTHENTICATION_REQUIRED
PROXY_AUTHENTICATION_REQUIRED = 'Proxy Authentication Required'
Official Documentation @ https://tools.ietf.org/html/rfc7235#section-3.2
This is similar to 401 but authentication is needed to be done by a proxy.
member REQUEST_HEADER_FIELDS_TOO_LARGE
REQUEST_HEADER_FIELDS_TOO_LARGE = 'Request Header Fields Too Large'
Official Documentation @ https://tools.ietf.org/html/rfc6585#section-5
The server is unwilling to process the request because its header fields are too large. The request MAY be resubmitted after reducing the size of the request header fields.
member REQUEST_TIMEOUT
REQUEST_TIMEOUT = 'Request Timeout'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.7
This response is sent on an idle connection by some servers, even without any previous request by the client. It means that the server would like to shut down this unused connection. This response is used much more since some browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing. Also note that some servers merely shut down the connection without sending this message.
member REQUEST_TOO_LONG
REQUEST_TOO_LONG = 'Request Entity Too Large'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.11
Request entity is larger than limits defined by server; the server might close the connection or return an Retry-After header field.
member REQUEST_URI_TOO_LONG
REQUEST_URI_TOO_LONG = 'Request-URI Too Long'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.12
The URI requested by the client is longer than the server is willing to interpret.
member REQUESTED_RANGE_NOT_SATISFIABLE
REQUESTED_RANGE_NOT_SATISFIABLE = 'Requested Range Not Satisfiable'
Official Documentation @ https://tools.ietf.org/html/rfc7233#section-4.4
The range specified by the Range header field in the request can't be fulfilled; it's possible that the range is outside the size of the target URI's data.
member RESET_CONTENT
RESET_CONTENT = 'Reset Content'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.6
This response code is sent after accomplishing request to tell user agent reset document view which sent this request.
member SEE_OTHER
SEE_OTHER = 'See Other'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.4
Server sent this response to directing client to get requested resource to another URI with an GET request.
member SERVICE_UNAVAILABLE
SERVICE_UNAVAILABLE = 'Service Unavailable'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.4
The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This responses should be used for temporary conditions and the Retry-After: HTTP header should, if possible, contain the estimated time before the recovery of the service. The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached.
member SWITCHING_PROTOCOLS
SWITCHING_PROTOCOLS = 'Switching Protocols'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.2.2
This code is sent in response to an Upgrade request header by the client, and indicates the protocol the server is switching too.
member TEMPORARY_REDIRECT
TEMPORARY_REDIRECT = 'Temporary Redirect'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.7
Server sent this response to directing client to get requested resource to another URI with same method that used prior request. This has the same semantic than the 302 Found HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.
member TOO_MANY_REQUESTS
TOO_MANY_REQUESTS = 'Too Many Requests'
Official Documentation @ https://tools.ietf.org/html/rfc6585#section-4
The user has sent too many requests in a given amount of time ("rate limiting").
member UNAUTHORIZED
UNAUTHORIZED = 'Unauthorized'
Official Documentation @ https://tools.ietf.org/html/rfc7235#section-3.1
Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
member UNAVAILABLE_FOR_LEGAL_REASONS
UNAVAILABLE_FOR_LEGAL_REASONS = 'Unavailable For Legal Reasons'
Official Documentation @ https://tools.ietf.org/html/rfc7725
The user-agent requested a resource that cannot legally be provided, such as a web page censored by a government.
member UNPROCESSABLE_ENTITY
UNPROCESSABLE_ENTITY = 'Unprocessable Entity'
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.3
The request was well-formed but was unable to be followed due to semantic errors.
member UNSUPPORTED_MEDIA_TYPE
UNSUPPORTED_MEDIA_TYPE = 'Unsupported Media Type'
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.13
The media format of the requested data is not supported by the server, so the server is rejecting the request.
member UPGRADE_REQUIRED
UPGRADE_REQUIRED = 'Upgrade Required'
Official Documentation @ https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.15
The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol.
member USE_PROXY
USE_PROXY = 'Use Proxy'
Deprecated
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.6
Was defined in a previous version of the HTTP specification to indicate that a requested response must be accessed by a proxy. It has been deprecated due to security concerns regarding in-band configuration of a proxy.
enum StatusCodes
enum StatusCodes { CONTINUE = 100, SWITCHING_PROTOCOLS = 101, PROCESSING = 102, EARLY_HINTS = 103, OK = 200, CREATED = 201, ACCEPTED = 202, NON_AUTHORITATIVE_INFORMATION = 203, NO_CONTENT = 204, RESET_CONTENT = 205, PARTIAL_CONTENT = 206, MULTI_STATUS = 207, MULTIPLE_CHOICES = 300, MOVED_PERMANENTLY = 301, MOVED_TEMPORARILY = 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, REQUEST_TOO_LONG = 413, REQUEST_URI_TOO_LONG = 414, UNSUPPORTED_MEDIA_TYPE = 415, REQUESTED_RANGE_NOT_SATISFIABLE = 416, EXPECTATION_FAILED = 417, IM_A_TEAPOT = 418, INSUFFICIENT_SPACE_ON_RESOURCE = 419, METHOD_FAILURE = 420, MISDIRECTED_REQUEST = 421, UNPROCESSABLE_ENTITY = 422, LOCKED = 423, FAILED_DEPENDENCY = 424, 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, INSUFFICIENT_STORAGE = 507, NETWORK_AUTHENTICATION_REQUIRED = 511,}
member ACCEPTED
ACCEPTED = 202
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.3
The request has been received but not yet acted upon. It is non-committal, meaning that there is no way in HTTP to later send an asynchronous response indicating the outcome of processing the request. It is intended for cases where another process or server handles the request, or for batch processing.
member BAD_GATEWAY
BAD_GATEWAY = 502
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.3
This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.
member BAD_REQUEST
BAD_REQUEST = 400
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.1
This response means that server could not understand the request due to invalid syntax.
member CONFLICT
CONFLICT = 409
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.8
This response is sent when a request conflicts with the current state of the server.
member CONTINUE
CONTINUE = 100
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.2.1
This interim response indicates that everything so far is OK and that the client should continue with the request or ignore it if it is already finished.
member CREATED
CREATED = 201
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.2
The request has succeeded and a new resource has been created as a result of it. This is typically the response sent after a PUT request.
member EARLY_HINTS
EARLY_HINTS = 103
Official Documentation @ https://www.rfc-editor.org/rfc/rfc8297#page-3
This code indicates to the client that the server is likely to send a final response with the header fields included in the informational response.
member EXPECTATION_FAILED
EXPECTATION_FAILED = 417
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.14
This response code means the expectation indicated by the Expect request header field can't be met by the server.
member FAILED_DEPENDENCY
FAILED_DEPENDENCY = 424
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.5
The request failed due to failure of a previous request.
member FORBIDDEN
FORBIDDEN = 403
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.3
The client does not have access rights to the content, i.e. they are unauthorized, so server is rejecting to give proper response. Unlike 401, the client's identity is known to the server.
member GATEWAY_TIMEOUT
GATEWAY_TIMEOUT = 504
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.5
This error response is given when the server is acting as a gateway and cannot get a response in time.
member GONE
GONE = 410
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.9
This response would be sent when the requested content has been permenantly deleted from server, with no forwarding address. Clients are expected to remove their caches and links to the resource. The HTTP specification intends this status code to be used for "limited-time, promotional services". APIs should not feel compelled to indicate resources that have been deleted with this status code.
member HTTP_VERSION_NOT_SUPPORTED
HTTP_VERSION_NOT_SUPPORTED = 505
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.6
The HTTP version used in the request is not supported by the server.
member IM_A_TEAPOT
IM_A_TEAPOT = 418
Official Documentation @ https://tools.ietf.org/html/rfc2324#section-2.3.2
Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout.
member INSUFFICIENT_SPACE_ON_RESOURCE
INSUFFICIENT_SPACE_ON_RESOURCE = 419
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.6
The 507 (Insufficient Storage) status code means the method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. This condition is considered to be temporary. If the request which received this status code was the result of a user action, the request MUST NOT be repeated until it is requested by a separate user action.
member INSUFFICIENT_STORAGE
INSUFFICIENT_STORAGE = 507
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.6
The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.
member INTERNAL_SERVER_ERROR
INTERNAL_SERVER_ERROR = 500
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.1
The server encountered an unexpected condition that prevented it from fulfilling the request.
member LENGTH_REQUIRED
LENGTH_REQUIRED = 411
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.10
The server rejected the request because the Content-Length header field is not defined and the server requires it.
member LOCKED
LOCKED = 423
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.4
The resource that is being accessed is locked.
member METHOD_FAILURE
METHOD_FAILURE = 420
Deprecated
Official Documentation @ https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt
A deprecated response used by the Spring Framework when a method has failed.
member METHOD_NOT_ALLOWED
METHOD_NOT_ALLOWED = 405
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.5
The request method is known by the server but has been disabled and cannot be used. For example, an API may forbid DELETE-ing a resource. The two mandatory methods, GET and HEAD, must never be disabled and should not return this error code.
member MISDIRECTED_REQUEST
MISDIRECTED_REQUEST = 421
Official Documentation @ https://datatracker.ietf.org/doc/html/rfc7540#section-9.1.2
Defined in the specification of HTTP/2 to indicate that a server is not able to produce a response for the combination of scheme and authority that are included in the request URI.
member MOVED_PERMANENTLY
MOVED_PERMANENTLY = 301
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.2
This response code means that URI of requested resource has been changed. Probably, new URI would be given in the response.
member MOVED_TEMPORARILY
MOVED_TEMPORARILY = 302
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.3
This response code means that URI of requested resource has been changed temporarily. New changes in the URI might be made in the future. Therefore, this same URI should be used by the client in future requests.
member MULTI_STATUS
MULTI_STATUS = 207
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.2
A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate.
member MULTIPLE_CHOICES
MULTIPLE_CHOICES = 300
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.1
The request has more than one possible responses. User-agent or user should choose one of them. There is no standardized way to choose one of the responses.
member NETWORK_AUTHENTICATION_REQUIRED
NETWORK_AUTHENTICATION_REQUIRED = 511
Official Documentation @ https://tools.ietf.org/html/rfc6585#section-6
The 511 status code indicates that the client needs to authenticate to gain network access.
member NO_CONTENT
NO_CONTENT = 204
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.5
There is no content to send for this request, but the headers may be useful. The user-agent may update its cached headers for this resource with the new ones.
member NON_AUTHORITATIVE_INFORMATION
NON_AUTHORITATIVE_INFORMATION = 203
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.4
This response code means returned meta-information set is not exact set as available from the origin server, but collected from a local or a third party copy. Except this condition, 200 OK response should be preferred instead of this response.
member NOT_ACCEPTABLE
NOT_ACCEPTABLE = 406
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.6
This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content following the criteria given by the user agent.
member NOT_FOUND
NOT_FOUND = 404
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.4
The server can not find requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. This response code is probably the most famous one due to its frequent occurence on the web.
member NOT_IMPLEMENTED
NOT_IMPLEMENTED = 501
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.2
The request method is not supported by the server and cannot be handled. The only methods that servers are required to support (and therefore that must not return this code) are GET and HEAD.
member NOT_MODIFIED
NOT_MODIFIED = 304
Official Documentation @ https://tools.ietf.org/html/rfc7232#section-4.1
This is used for caching purposes. It is telling to client that response has not been modified. So, client can continue to use same cached version of response.
member OK
OK = 200
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.1
The request has succeeded. The meaning of a success varies depending on the HTTP method: GET: The resource has been fetched and is transmitted in the message body. HEAD: The entity headers are in the message body. POST: The resource describing the result of the action is transmitted in the message body. TRACE: The message body contains the request message as received by the server
member PARTIAL_CONTENT
PARTIAL_CONTENT = 206
Official Documentation @ https://tools.ietf.org/html/rfc7233#section-4.1
This response code is used because of range header sent by the client to separate download into multiple streams.
member PAYMENT_REQUIRED
PAYMENT_REQUIRED = 402
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.2
This response code is reserved for future use. Initial aim for creating this code was using it for digital payment systems however this is not used currently.
member PERMANENT_REDIRECT
PERMANENT_REDIRECT = 308
Official Documentation @ https://tools.ietf.org/html/rfc7538#section-3
This means that the resource is now permanently located at another URI, specified by the Location: HTTP Response header. This has the same semantics as the 301 Moved Permanently HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.
member PRECONDITION_FAILED
PRECONDITION_FAILED = 412
Official Documentation @ https://tools.ietf.org/html/rfc7232#section-4.2
The client has indicated preconditions in its headers which the server does not meet.
member PRECONDITION_REQUIRED
PRECONDITION_REQUIRED = 428
Official Documentation @ https://tools.ietf.org/html/rfc6585#section-3
The origin server requires the request to be conditional. Intended to prevent the 'lost update' problem, where a client GETs a resource's state, modifies it, and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict.
member PROCESSING
PROCESSING = 102
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.1
This code indicates that the server has received and is processing the request, but no response is available yet.
member PROXY_AUTHENTICATION_REQUIRED
PROXY_AUTHENTICATION_REQUIRED = 407
Official Documentation @ https://tools.ietf.org/html/rfc7235#section-3.2
This is similar to 401 but authentication is needed to be done by a proxy.
member REQUEST_HEADER_FIELDS_TOO_LARGE
REQUEST_HEADER_FIELDS_TOO_LARGE = 431
Official Documentation @ https://tools.ietf.org/html/rfc6585#section-5
The server is unwilling to process the request because its header fields are too large. The request MAY be resubmitted after reducing the size of the request header fields.
member REQUEST_TIMEOUT
REQUEST_TIMEOUT = 408
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.7
This response is sent on an idle connection by some servers, even without any previous request by the client. It means that the server would like to shut down this unused connection. This response is used much more since some browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing. Also note that some servers merely shut down the connection without sending this message.
member REQUEST_TOO_LONG
REQUEST_TOO_LONG = 413
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.11
Request entity is larger than limits defined by server; the server might close the connection or return an Retry-After header field.
member REQUEST_URI_TOO_LONG
REQUEST_URI_TOO_LONG = 414
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.12
The URI requested by the client is longer than the server is willing to interpret.
member REQUESTED_RANGE_NOT_SATISFIABLE
REQUESTED_RANGE_NOT_SATISFIABLE = 416
Official Documentation @ https://tools.ietf.org/html/rfc7233#section-4.4
The range specified by the Range header field in the request can't be fulfilled; it's possible that the range is outside the size of the target URI's data.
member RESET_CONTENT
RESET_CONTENT = 205
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.6
This response code is sent after accomplishing request to tell user agent reset document view which sent this request.
member SEE_OTHER
SEE_OTHER = 303
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.4
Server sent this response to directing client to get requested resource to another URI with an GET request.
member SERVICE_UNAVAILABLE
SERVICE_UNAVAILABLE = 503
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.4
The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This responses should be used for temporary conditions and the Retry-After: HTTP header should, if possible, contain the estimated time before the recovery of the service. The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached.
member SWITCHING_PROTOCOLS
SWITCHING_PROTOCOLS = 101
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.2.2
This code is sent in response to an Upgrade request header by the client, and indicates the protocol the server is switching too.
member TEMPORARY_REDIRECT
TEMPORARY_REDIRECT = 307
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.7
Server sent this response to directing client to get requested resource to another URI with same method that used prior request. This has the same semantic than the 302 Found HTTP response code, with the exception that the user agent must not change the HTTP method used: if a POST was used in the first request, a POST must be used in the second request.
member TOO_MANY_REQUESTS
TOO_MANY_REQUESTS = 429
Official Documentation @ https://tools.ietf.org/html/rfc6585#section-4
The user has sent too many requests in a given amount of time ("rate limiting").
member UNAUTHORIZED
UNAUTHORIZED = 401
Official Documentation @ https://tools.ietf.org/html/rfc7235#section-3.1
Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
member UNAVAILABLE_FOR_LEGAL_REASONS
UNAVAILABLE_FOR_LEGAL_REASONS = 451
Official Documentation @ https://tools.ietf.org/html/rfc7725
The user-agent requested a resource that cannot legally be provided, such as a web page censored by a government.
member UNPROCESSABLE_ENTITY
UNPROCESSABLE_ENTITY = 422
Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.3
The request was well-formed but was unable to be followed due to semantic errors.
member UNSUPPORTED_MEDIA_TYPE
UNSUPPORTED_MEDIA_TYPE = 415
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.13
The media format of the requested data is not supported by the server, so the server is rejecting the request.
member UPGRADE_REQUIRED
UPGRADE_REQUIRED = 426
Official Documentation @ https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.15
The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol.
member USE_PROXY
USE_PROXY = 305
Deprecated
Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.6
Was defined in a previous version of the HTTP specification to indicate that a requested response must be accessed by a proxy. It has been deprecated due to security concerns regarding in-band configuration of a proxy.
Package Files (5)
Dependencies (0)
No dependencies.
Dev Dependencies (15)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/http-status-codes
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/http-status-codes)
- HTML<a href="https://www.jsdocs.io/package/http-status-codes"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2502 ms. - Missing or incorrect documentation? Open an issue for this package.