-
Notifications
You must be signed in to change notification settings - Fork 106
/
codes.json
529 lines (529 loc) · 23.4 KB
/
codes.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
[
{
"code": 202,
"phrase": "Accepted",
"constant": "ACCEPTED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.3",
"description": "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."
}
},
{
"code": 502,
"phrase": "Bad Gateway",
"constant": "BAD_GATEWAY",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.3",
"description": "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."
}
},
{
"code": 400,
"phrase": "Bad Request",
"constant": "BAD_REQUEST",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.1",
"description": "This response means that server could not understand the request due to invalid syntax."
}
},
{
"code": 409,
"phrase": "Conflict",
"constant": "CONFLICT",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.8",
"description": "This response is sent when a request conflicts with the current state of the server."
}
},
{
"code": 100,
"phrase": "Continue",
"constant": "CONTINUE",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.2.1",
"description": "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."
}
},
{
"code": 201,
"phrase": "Created",
"constant": "CREATED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.2",
"description": "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."
}
},
{
"code": 417,
"phrase": "Expectation Failed",
"constant": "EXPECTATION_FAILED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.14",
"description": "This response code means the expectation indicated by the Expect request header field can't be met by the server."
}
},
{
"code": 424,
"phrase": "Failed Dependency",
"constant": "FAILED_DEPENDENCY",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.5",
"description": "The request failed due to failure of a previous request."
}
},
{
"code": 403,
"phrase": "Forbidden",
"constant": "FORBIDDEN",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.3",
"description": "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."
}
},
{
"code": 504,
"phrase": "Gateway Timeout",
"constant": "GATEWAY_TIMEOUT",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.5",
"description": "This error response is given when the server is acting as a gateway and cannot get a response in time."
}
},
{
"code": 410,
"phrase": "Gone",
"constant": "GONE",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.9",
"description": "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."
}
},
{
"code": 505,
"phrase": "HTTP Version Not Supported",
"constant": "HTTP_VERSION_NOT_SUPPORTED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.6",
"description": "The HTTP version used in the request is not supported by the server."
}
},
{
"code": 418,
"phrase": "I'm a teapot",
"constant": "IM_A_TEAPOT",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc2324#section-2.3.2",
"description": "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."
}
},
{
"code": 419,
"phrase": "Insufficient Space on Resource",
"constant": "INSUFFICIENT_SPACE_ON_RESOURCE",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.6",
"description": "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."
}
},
{
"code": 507,
"phrase": "Insufficient Storage",
"constant": "INSUFFICIENT_STORAGE",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.6",
"description": "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."
}
},
{
"code": 500,
"phrase": "Internal Server Error",
"constant": "INTERNAL_SERVER_ERROR",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.1",
"description": "The server encountered an unexpected condition that prevented it from fulfilling the request."
}
},
{
"code": 411,
"phrase": "Length Required",
"constant": "LENGTH_REQUIRED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.10",
"description": "The server rejected the request because the Content-Length header field is not defined and the server requires it."
}
},
{
"code": 423,
"phrase": "Locked",
"constant": "LOCKED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.4",
"description": "The resource that is being accessed is locked."
}
},
{
"code": 420,
"phrase": "Method Failure",
"constant": "METHOD_FAILURE",
"isDeprecated": true,
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/rfcdiff?difftype=--hwdiff&url2=draft-ietf-webdav-protocol-06.txt",
"description": "A deprecated response used by the Spring Framework when a method has failed."
}
},
{
"code": 405,
"phrase": "Method Not Allowed",
"constant": "METHOD_NOT_ALLOWED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.5",
"description": "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."
}
},
{
"code": 301,
"phrase": "Moved Permanently",
"constant": "MOVED_PERMANENTLY",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.2",
"description": "This response code means that URI of requested resource has been changed. Probably, new URI would be given in the response."
}
},
{
"code": 302,
"phrase": "Moved Temporarily",
"constant": "MOVED_TEMPORARILY",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.3",
"description": "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."
}
},
{
"code": 207,
"phrase": "Multi-Status",
"constant": "MULTI_STATUS",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.2",
"description": "A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate."
}
},
{
"code": 300,
"phrase": "Multiple Choices",
"constant": "MULTIPLE_CHOICES",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.1",
"description": "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."
}
},
{
"code": 511,
"phrase": "Network Authentication Required",
"constant": "NETWORK_AUTHENTICATION_REQUIRED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc6585#section-6",
"description": "The 511 status code indicates that the client needs to authenticate to gain network access."
}
},
{
"code": 204,
"phrase": "No Content",
"constant": "NO_CONTENT",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.5",
"description": "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."
}
},
{
"code": 203,
"phrase": "Non Authoritative Information",
"constant": "NON_AUTHORITATIVE_INFORMATION",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.4",
"description": "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."
}
},
{
"code": 406,
"phrase": "Not Acceptable",
"constant": "NOT_ACCEPTABLE",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.6",
"description": "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."
}
},
{
"code": 404,
"phrase": "Not Found",
"constant": "NOT_FOUND",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.4",
"description": "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."
}
},
{
"code": 501,
"phrase": "Not Implemented",
"constant": "NOT_IMPLEMENTED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.2",
"description": "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."
}
},
{
"code": 304,
"phrase": "Not Modified",
"constant": "NOT_MODIFIED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7232#section-4.1",
"description": "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."
}
},
{
"code": 200,
"phrase": "OK",
"constant": "OK",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.1",
"description": "The request has succeeded. The meaning of a success varies depending on the HTTP method:\nGET: The resource has been fetched and is transmitted in the message body.\nHEAD: The entity headers are in the message body.\nPOST: The resource describing the result of the action is transmitted in the message body.\nTRACE: The message body contains the request message as received by the server"
}
},
{
"code": 206,
"phrase": "Partial Content",
"constant": "PARTIAL_CONTENT",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7233#section-4.1",
"description": "This response code is used because of range header sent by the client to separate download into multiple streams."
}
},
{
"code": 402,
"phrase": "Payment Required",
"constant": "PAYMENT_REQUIRED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.2",
"description": "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."
}
},
{
"code": 308,
"phrase": "Permanent Redirect",
"constant": "PERMANENT_REDIRECT",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7538#section-3",
"description": "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."
}
},
{
"code": 412,
"phrase": "Precondition Failed",
"constant": "PRECONDITION_FAILED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7232#section-4.2",
"description": "The client has indicated preconditions in its headers which the server does not meet."
}
},
{
"code": 428,
"phrase": "Precondition Required",
"constant": "PRECONDITION_REQUIRED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc6585#section-3",
"description": "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."
}
},
{
"code": 102,
"phrase": "Processing",
"constant": "PROCESSING",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.1",
"description": "This code indicates that the server has received and is processing the request, but no response is available yet."
}
},
{
"code": 103,
"phrase": "Early Hints",
"constant": "EARLY_HINTS",
"isDeprecated": false,
"comment": {
"doc": "Official Documentation @ https://www.rfc-editor.org/rfc/rfc8297#page-3",
"description": "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."
}
},
{
"code": 426,
"phrase": "Upgrade Required",
"constant": "UPGRADE_REQUIRED",
"isDeprecated": false,
"comment": {
"doc": "Official Documentation @ https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.15",
"description": "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."
}
},
{
"code": 407,
"phrase": "Proxy Authentication Required",
"constant": "PROXY_AUTHENTICATION_REQUIRED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7235#section-3.2",
"description": "This is similar to 401 but authentication is needed to be done by a proxy."
}
},
{
"code": 431,
"phrase": "Request Header Fields Too Large",
"constant": "REQUEST_HEADER_FIELDS_TOO_LARGE",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc6585#section-5",
"description": "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."
}
},
{
"code": 408,
"phrase": "Request Timeout",
"constant": "REQUEST_TIMEOUT",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.7",
"description": "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."
}
},
{
"code": 413,
"phrase": "Request Entity Too Large",
"constant": "REQUEST_TOO_LONG",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.11",
"description": "Request entity is larger than limits defined by server; the server might close the connection or return an Retry-After header field."
}
},
{
"code": 414,
"phrase": "Request-URI Too Long",
"constant": "REQUEST_URI_TOO_LONG",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.12",
"description": "The URI requested by the client is longer than the server is willing to interpret."
}
},
{
"code": 416,
"phrase": "Requested Range Not Satisfiable",
"constant": "REQUESTED_RANGE_NOT_SATISFIABLE",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7233#section-4.4",
"description": "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."
}
},
{
"code": 205,
"phrase": "Reset Content",
"constant": "RESET_CONTENT",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.3.6",
"description": "This response code is sent after accomplishing request to tell user agent reset document view which sent this request."
}
},
{
"code": 303,
"phrase": "See Other",
"constant": "SEE_OTHER",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.4",
"description": "Server sent this response to directing client to get requested resource to another URI with an GET request."
}
},
{
"code": 503,
"phrase": "Service Unavailable",
"constant": "SERVICE_UNAVAILABLE",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.6.4",
"description": "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."
}
},
{
"code": 101,
"phrase": "Switching Protocols",
"constant": "SWITCHING_PROTOCOLS",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.2.2",
"description": "This code is sent in response to an Upgrade request header by the client, and indicates the protocol the server is switching too."
}
},
{
"code": 307,
"phrase": "Temporary Redirect",
"constant": "TEMPORARY_REDIRECT",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.7",
"description": "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."
}
},
{
"code": 429,
"phrase": "Too Many Requests",
"constant": "TOO_MANY_REQUESTS",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc6585#section-4",
"description": "The user has sent too many requests in a given amount of time (\"rate limiting\")."
}
},
{
"code": 401,
"phrase": "Unauthorized",
"constant": "UNAUTHORIZED",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7235#section-3.1",
"description": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."
}
},
{
"code": 451,
"phrase": "Unavailable For Legal Reasons",
"constant": "UNAVAILABLE_FOR_LEGAL_REASONS",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7725",
"description": "The user-agent requested a resource that cannot legally be provided, such as a web page censored by a government."
}
},
{
"code": 422,
"phrase": "Unprocessable Entity",
"constant": "UNPROCESSABLE_ENTITY",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc2518#section-10.3",
"description": "The request was well-formed but was unable to be followed due to semantic errors."
}
},
{
"code": 415,
"phrase": "Unsupported Media Type",
"constant": "UNSUPPORTED_MEDIA_TYPE",
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.5.13",
"description": "The media format of the requested data is not supported by the server, so the server is rejecting the request."
}
},
{
"code": 305,
"phrase": "Use Proxy",
"constant": "USE_PROXY",
"isDeprecated": true,
"comment": {
"doc": "Official Documentation @ https://tools.ietf.org/html/rfc7231#section-6.4.6",
"description": "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."
}
},
{
"code": 421,
"phrase": "Misdirected Request",
"constant": "MISDIRECTED_REQUEST",
"isDeprecated": false,
"comment": {
"doc": "Official Documentation @ https://datatracker.ietf.org/doc/html/rfc7540#section-9.1.2",
"description": "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."
}
}
]