Skip to main content

Enumeration: HttpCodes

@sapphire/plugin-api.HttpCodes

Enumeration members

Accepted

โ€ข Accepted = 202

The request has been accepted for processing, but the processing has not been completed. The request might or might not be eventually acted upon, and may be disallowed when processing occurs.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:22


AlreadyReported

โ€ข AlreadyReported = 208

(WebDAV; RFC 5842) The members of a DAV binding have already been enumerated in a preceding part of the (multistatus) response, and are not being included again.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:63


BadGateway

โ€ข BadGateway = 502

The server was acting as a gateway or proxy and received an invalid response from the upstream server.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:385


BadRequest

โ€ข BadRequest = 400

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing).

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:150


Conflict

โ€ข Conflict = 409

Indicates that the request could not be processed because of conflict in the current state of the resource, such as an edit conflict between multiple simultaneous updates.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:225


Created

โ€ข Created = 201

The request has been fulfilled, resulting in the creation of a new resource.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:15


EnhanceYourCalm

โ€ข EnhanceYourCalm = 420

Returned by the Twitter Search and Trends API when the client is being rate limited. The text is a quote from 'Demolition Man' and the '420' code is likely a reference to this number's association with marijuana. Other services may wish to implement the 429 Too Many Requests response code instead.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:301


ExpectationFailed

โ€ข ExpectationFailed = 417

The server cannot meet the requirements of the Expect request-header field.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:283


FailedDependency

โ€ข FailedDependency = 424

(WebDAV; RFC 4918) The request failed because it depended on another request and that request failed (e.g., a PROPPATCH).

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:324


Forbidden

โ€ข Forbidden = 403

The request contained valid data and was understood by the server, but the server is refusing action. This may be due to the user not having the necessary permissions for a resource or needing an account of some sort, or attempting a prohibited action (e.g. creating a duplicate record where only one is allowed). This code is also typically used if the request provided authentication by answering the WWW-Authenticate header field challenge, but the server did not accept that authentication. The request should not be repeated.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:186


Found

โ€ข Found = 302

(Previously "Moved temporarily") Tells the client to look at (browse to) another URL. 302 has been superseded by 303 and 307. This is an example of industry practice contradicting the standard. The HTTP/1.0 specification (RFC 1945) required the client to perform a temporary redirect (the original describing phrase was "Moved Temporarily"), but popular browsers implemented 302 with the functionality of a 303 See Other. Therefore, HTTP/1.1 added status codes 303 and 307 to distinguish between the two behaviours. However, some Web applications and frameworks use the 302 status code as if it were the 303.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:97


GatewayTimeout

โ€ข GatewayTimeout = 504

The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:397


Gone

โ€ข Gone = 410

Indicates that the resource requested is no longer available and will not be available again. This should be used when a resource has been intentionally removed and the resource should be purged. Upon receiving a 410 status code, the client should not request the resource in the future. Clients such as search engines should remove the resource from their indices. Most use cases do not require clients and search engines to purge the resource, and a "404 Not Found" may be used instead.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:236


HTTPVersionNotSupported

โ€ข HTTPVersionNotSupported = 505

The server does not support the HTTP protocol version used in the request.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:402


IAmATeapot

โ€ข IAmATeapot = 418

(RFC 2324, RFC 7168) This code was defined in 1998 as one of the traditional IETF April Fools' jokes, in RFC 2324, Hyper Text Coffee Pot Control Protocol, and is not expected to be implemented by actual HTTP servers. The RFC specifies this code should be returned by teapots requested to brew coffee. This HTTP status is used as an Easter egg in some websites, such as Google.com's I'm a teapot easter egg.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:293


IMUsed

โ€ข IMUsed = 226

(RFC 3229) The server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:70


InsufficientStorage

โ€ข InsufficientStorage = 507

(WebDAV; RFC 4918) The server is unable to store the representation needed to complete the request.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:414


InternalServerError

โ€ข InternalServerError = 500

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:372


LengthRequired

โ€ข LengthRequired = 411

The request did not specify the length of its content, which is required by the requested resource.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:242


Locked

โ€ข Locked = 423

(WebDAV; RFC 4918) The resource that is being accessed is locked.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:318


LoopDetected

โ€ข LoopDetected = 508

(WebDAV; RFC 5842) The server detected an infinite loop while processing the request (sent instead of 208 Already Reported).

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:420


MethodNotAllowed

โ€ข MethodNotAllowed = 405

A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:199


MisdirectedRequest

โ€ข MisdirectedRequest = 421

(RFC 7540) The request was directed at a server that is not able to produce a response (for example because of connection reuse).

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:307


MovedPermanently

โ€ข MovedPermanently = 301

This and all future requests should be directed to the given URI.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:84


MultiStatus

โ€ข MultiStatus = 207

(WebDAV; RFC 4918) The message body that follows is by default an XML message and can contain a number of separate response codes, depending on how many sub-requests were made.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:56


MultipleChoices

โ€ข MultipleChoices = 300

Indicates multiple options for the resource from which the client may choose (via agent-driven content negotiation). For example, this code could be used to present multiple video format options, to list files with different filename extensions, or to suggest word-sense disambiguation.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:79


NetworkAuthenticationRequired

โ€ข NetworkAuthenticationRequired = 511

(RFC 6585) The client needs to authenticate to gain network access. Intended for use by intercepting proxies used to control access to the network (e.g., "captive portals" used to require agreement to Terms of Service before granting full Internet access via a Wi-Fi hotspot).

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:434


NoContent

โ€ข NoContent = 204

The server successfully processed the request, and is not returning any content.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:35


NonAuthoritativeInformation

โ€ข NonAuthoritativeInformation = 203

The server is a transforming proxy (e.g. a Web accelerator) that received a 200 OK from its origin, but is returning a modified version of the origin's response.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:29


NotAcceptable

โ€ข NotAcceptable = 406

The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. See Content negotiation.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:205


NotExtended

โ€ข NotExtended = 510

(RFC 2774) Further extensions to the request are required for the server to fulfil it.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:426


NotFound

โ€ข NotFound = 404

The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:192


NotImplemented

โ€ข NotImplemented = 501

The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:379


NotModified

โ€ข NotModified = 304

(RFC 7232) Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match. In such case, there is no need to retransmit the resource since the client still has a previously-downloaded copy.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:113


OK

โ€ข OK = 200

Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:9


PartialContent

โ€ข PartialContent = 206

(RFC 7233) The server is delivering only part of the resource (byte serving) due to a range header sent by the client. The range header is used by HTTP clients to enable resuming of interrupted downloads, or split a download into multiple simultaneous streams.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:49


PayloadTooLarge

โ€ข PayloadTooLarge = 413

(RFC 7231) The request is larger than the server is willing or able to process. Previously called "Request Entity Too Large".

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:254


PaymentRequired

โ€ข PaymentRequired = 402

Reserved for future use. The original intention was that this code might be used as part of some form of digital cash or micropayment scheme, as proposed, for example, by GNU Taler, but that has not yet happened, and this code is not widely used. Google Developers API uses this status if a particular developer has exceeded the daily limit on requests. Sipgate uses this code if an account does not have sufficient funds to start a call. Shopify uses this code when the store has not paid their fees and is temporarily disabled. Stripe uses this code for failed payments where parameters were correct, for example blocked fraudulent payments.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:174


PermanentRedirect

โ€ข PermanentRedirect = 308

(RFC 7538) The request and all future requests should be repeated using another URI. 307 and 308 parallel the behaviors of 302 and 301, but do not allow the HTTP method to change. So, for example, submitting a form to a permanently redirected resource may continue smoothly.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:143


PreconditionFailed

โ€ข PreconditionFailed = 412

(RFC 7232) The server does not meet one of the preconditions that the requester put on the request header fields.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:248


PreconditionRequired

โ€ข PreconditionRequired = 428

(RFC 6585) 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.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:345


ProxyAuthenticationRequired

โ€ข ProxyAuthenticationRequired = 407

(RFC 7235) The client must first authenticate itself with the proxy.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:210


RangeNotSatisfiable

โ€ข RangeNotSatisfiable = 416

(RFC 7233) The client has asked for a portion of the file (byte serving), but the server cannot supply that portion. For example, if the client asked for a part of the file that lies beyond the end of the file. Called "Requested Range Not Satisfiable" previously.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:277


RequestHeaderFieldsTooLarge

โ€ข RequestHeaderFieldsTooLarge = 431

(RFC 6585) The server is unwilling to process the request because either an individual header field, or all the header fields collectively, are too large.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:358


RequestTimeout

โ€ข RequestTimeout = 408

The server timed out waiting for the request. According to HTTP specifications: "The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time."

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:218


ResetContent

โ€ข ResetContent = 205

The server successfully processed the request, asks that the requester reset its document view, and is not returning any content.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:41


SeeOther

โ€ข SeeOther = 303

The response to the request can be found under another URI using the GET method. When received in response to a POST (or PUT/DELETE), the client should presume that the server has received the data and should issue a new GET request to the given URI.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:105


ServiceUnavailable

โ€ข ServiceUnavailable = 503

The server cannot handle the request (because it is overloaded or down for maintenance). Generally, this is a temporary state.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:391


SwitchProxy

โ€ข SwitchProxy = 306

No longer used. Originally meant "Subsequent requests should use the specified proxy.".

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:126


TemporaryRedirect

โ€ข TemporaryRedirect = 307

In this case, the request should be repeated with another URI; however, future requests should still use the original URI. In contrast to how 302 was historically implemented, the request method is not allowed to be changed when reissuing the original request. For example, a POST request should be repeated using another POST request.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:135


TooEarly

โ€ข TooEarly = 425

(RFC 8470) Indicates that the server is unwilling to risk processing a request that might be replayed.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:330


TooManyRequests

โ€ข TooManyRequests = 429

(RFC 6585) The user has sent too many requests in a given amount of time. Intended for use with rate-limiting schemes.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:351


URITooLong

โ€ข URITooLong = 414

(RFC 7231) The URI provided was too long for the server to process. Often the result of too much data being encoded as a query-string of a GET request, in which case it should be converted to a POST request. Called "Request-URI Too Long" previously.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:262


Unauthorized

โ€ข Unauthorized = 401

(RFC 7235) Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource. See Basic access authentication and Digest access authentication. 401 semantically means "unauthorised", the user does not have valid authentication credentials for the target resource.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:161


UnavailableForLegalReasons

โ€ข UnavailableForLegalReasons = 451

(RFC 7725) A server operator has received a legal demand to deny access to a resource or to a set of resources that includes the requested resource. The code 451 was chosen as a reference to the novel Fahrenheit 451 (see the Acknowledgements in the RFC).

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:366


UnprocessableEntity

โ€ข UnprocessableEntity = 422

(WebDAV; RFC 4918) The request was well-formed but was unable to be followed due to semantic errors.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:313


UnsupportedMediaType

โ€ข UnsupportedMediaType = 415

(RFC 7231) The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:269


UpgradeRequired

โ€ข UpgradeRequired = 426

The client should switch to a different protocol such as TLS/1.0, given in the Upgrade header field.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:336


UseProxy

โ€ข UseProxy = 305

The requested resource is available only through a proxy, the address for which is provided in the response. For security reasons, many HTTP clients (such as Mozilla Firefox and Internet Explorer) do not obey this status code.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:121


VariantAlsoNegotiates

โ€ข VariantAlsoNegotiates = 506

(RFC 2295) Transparent content negotiation for the request results in a circular reference.

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpCodes.ts:408