<!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="utf-8"> <title>Status codes - Django REST framework</title> <link href="../../img/favicon.ico" rel="icon" type="image/x-icon"> <link rel="canonical" href="http://www.django-rest-framework.org/api-guide/status-codes/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="description" content="Django, API, REST, Status codes"> <meta name="author" content="Tom Christie"> <!-- Le styles --> <link href="../../css/prettify.css" rel="stylesheet"> <link href="../../css/bootstrap.css" rel="stylesheet"> <link href="../../css/bootstrap-responsive.css" rel="stylesheet"> <link href="../../css/default.css" rel="stylesheet"> <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements --> <!--[if lt IE 9]> <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-18852272-2']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script> <style> #sidebarInclude img { margin-bottom: 10px; } #sidebarInclude a.promo { color: black; } @media (max-width: 767px) { div.promo { display: none; } } </style> </head> <body onload="prettyPrint()" class="-page"> <div class="wrapper"> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> <div class="container-fluid"> <a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a> <a class="repo-link btn btn-inverse btn-small " rel="prev" href="../testing/"> Next <i class="icon-arrow-right icon-white"></i> </a> <a class="repo-link btn btn-inverse btn-small " rel="next" href="../exceptions/"> <i class="icon-arrow-left icon-white"></i> Previous </a> <a id="search_modal_show" class="repo-link btn btn-inverse btn-small" href="#mkdocs_search_modal" data-toggle="modal" data-target="#mkdocs_search_modal"><i class="icon-search icon-white"></i> Search</a> <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </a> <a class="brand" href="http://www.django-rest-framework.org">Django REST framework</a> <div class="nav-collapse collapse"> <!-- Main navigation --> <ul class="nav navbar-nav"> <li > <a href="../..">Home</a> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a> <ul class="dropdown-menu"> <li > <a href="../../tutorial/quickstart/">Quickstart</a> </li> <li > <a href="../../tutorial/1-serialization/">1 - Serialization</a> </li> <li > <a href="../../tutorial/2-requests-and-responses/">2 - Requests and responses</a> </li> <li > <a href="../../tutorial/3-class-based-views/">3 - Class based views</a> </li> <li > <a href="../../tutorial/4-authentication-and-permissions/">4 - Authentication and permissions</a> </li> <li > <a href="../../tutorial/5-relationships-and-hyperlinked-apis/">5 - Relationships and hyperlinked APIs</a> </li> <li > <a href="../../tutorial/6-viewsets-and-routers/">6 - Viewsets and routers</a> </li> </ul> </li> <li class="dropdown active"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Guide <b class="caret"></b></a> <ul class="dropdown-menu"> <li > <a href="../requests/">Requests</a> </li> <li > <a href="../responses/">Responses</a> </li> <li > <a href="../views/">Views</a> </li> <li > <a href="../generic-views/">Generic views</a> </li> <li > <a href="../viewsets/">Viewsets</a> </li> <li > <a href="../routers/">Routers</a> </li> <li > <a href="../parsers/">Parsers</a> </li> <li > <a href="../renderers/">Renderers</a> </li> <li > <a href="../serializers/">Serializers</a> </li> <li > <a href="../fields/">Serializer fields</a> </li> <li > <a href="../relations/">Serializer relations</a> </li> <li > <a href="../validators/">Validators</a> </li> <li > <a href="../authentication/">Authentication</a> </li> <li > <a href="../permissions/">Permissions</a> </li> <li > <a href="../throttling/">Throttling</a> </li> <li > <a href="../filtering/">Filtering</a> </li> <li > <a href="../pagination/">Pagination</a> </li> <li > <a href="../versioning/">Versioning</a> </li> <li > <a href="../content-negotiation/">Content negotiation</a> </li> <li > <a href="../metadata/">Metadata</a> </li> <li > <a href="../format-suffixes/">Format suffixes</a> </li> <li > <a href="../reverse/">Returning URLs</a> </li> <li > <a href="../exceptions/">Exceptions</a> </li> <li class="active" > <a href="./">Status codes</a> </li> <li > <a href="../testing/">Testing</a> </li> <li > <a href="../settings/">Settings</a> </li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Topics <b class="caret"></b></a> <ul class="dropdown-menu"> <li > <a href="../../topics/documenting-your-api/">Documenting your API</a> </li> <li > <a href="../../topics/internationalization/">Internationalization</a> </li> <li > <a href="../../topics/ajax-csrf-cors/">AJAX, CSRF & CORS</a> </li> <li > <a href="../../topics/html-and-forms/">HTML & Forms</a> </li> <li > <a href="../../topics/browser-enhancements/">Browser Enhancements</a> </li> <li > <a href="../../topics/browsable-api/">The Browsable API</a> </li> <li > <a href="../../topics/rest-hypermedia-hateoas/">REST, Hypermedia & HATEOAS</a> </li> <li > <a href="../../topics/third-party-resources/">Third Party Resources</a> </li> <li > <a href="../../topics/contributing/">Contributing to REST framework</a> </li> <li > <a href="../../topics/project-management/">Project management</a> </li> <li > <a href="../../topics/3.0-announcement/">3.0 Announcement</a> </li> <li > <a href="../../topics/3.1-announcement/">3.1 Announcement</a> </li> <li > <a href="../../topics/3.2-announcement/">3.2 Announcement</a> </li> <li > <a href="../../topics/3.3-announcement/">3.3 Announcement</a> </li> <li > <a href="../../topics/kickstarter-announcement/">Kickstarter Announcement</a> </li> <li > <a href="../../topics/mozilla-grant/">Mozilla Grant</a> </li> <li > <a href="../../topics/funding/">Funding</a> </li> <li > <a href="../../topics/release-notes/">Release Notes</a> </li> </ul> </li> </ul> </div> <!--/.nav-collapse --> </div> </div> </div> <div class="body-content"> <div class="container-fluid"> <!-- Search Modal --> <div id="mkdocs_search_modal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> <h3 id="myModalLabel">Documentation search</h3> </div> <div class="modal-body"> <form role="form" autocomplete="off"> <div class="form-group"> <input type="text" name="q" class="form-control" placeholder="Search..." id="mkdocs-search-query"> </div> </form> <div id="mkdocs-search-results"></div> </div> <div class="modal-footer"> <button class="btn" data-dismiss="modal" aria-hidden="true">Close</button> </div> </div> <div class="row-fluid"> <div class="span3"> <div id="table-of-contents"> <ul class="nav nav-list side-nav well sidebar-nav-fixed"> <li class="main"> <a href="#status-codes">Status Codes</a> </li> <li> <a href="#informational-1xx">Informational - 1xx</a> </li> <li> <a href="#successful-2xx">Successful - 2xx</a> </li> <li> <a href="#redirection-3xx">Redirection - 3xx</a> </li> <li> <a href="#client-error-4xx">Client Error - 4xx</a> </li> <li> <a href="#server-error-5xx">Server Error - 5xx</a> </li> <li> <a href="#helper-functions">Helper functions</a> </li> <div class="promo"> <hr/> <div id="sidebarInclude"> </div> </ul> </div> </div> <div id="main-content" class="span9"> <a class="github" href="https://github.com/tomchristie/django-rest-framework/tree/master/rest_framework/status.py"> <span class="label label-info">status.py</span> </a> <h1 id="status-codes"><a class="toclink" href="#status-codes">Status Codes</a></h1> <blockquote> <p>418 I'm a teapot - 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.</p> <p>— <a href="http://www.ietf.org/rfc/rfc2324.txt">RFC 2324</a>, Hyper Text Coffee Pot Control Protocol</p> </blockquote> <p>Using bare status codes in your responses isn't recommended. REST framework includes a set of named constants that you can use to make more code more obvious and readable.</p> <pre><code>from rest_framework import status from rest_framework.response import Response def empty_view(self): content = {'please move along': 'nothing to see here'} return Response(content, status=status.HTTP_404_NOT_FOUND) </code></pre> <p>The full set of HTTP status codes included in the <code>status</code> module is listed below.</p> <p>The module also includes a set of helper functions for testing if a status code is in a given range.</p> <pre><code>from rest_framework import status from rest_framework.test import APITestCase class ExampleTestCase(APITestCase): def test_url_root(self): url = reverse('index') response = self.client.get(url) self.assertTrue(status.is_success(response.status_code)) </code></pre> <p>For more information on proper usage of HTTP status codes see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">RFC 2616</a> and <a href="http://tools.ietf.org/html/rfc6585">RFC 6585</a>.</p> <h2 id="informational-1xx"><a class="toclink" href="#informational-1xx">Informational - 1xx</a></h2> <p>This class of status code indicates a provisional response. There are no 1xx status codes used in REST framework by default.</p> <pre><code>HTTP_100_CONTINUE HTTP_101_SWITCHING_PROTOCOLS </code></pre> <h2 id="successful-2xx"><a class="toclink" href="#successful-2xx">Successful - 2xx</a></h2> <p>This class of status code indicates that the client's request was successfully received, understood, and accepted.</p> <pre><code>HTTP_200_OK HTTP_201_CREATED HTTP_202_ACCEPTED HTTP_203_NON_AUTHORITATIVE_INFORMATION HTTP_204_NO_CONTENT HTTP_205_RESET_CONTENT HTTP_206_PARTIAL_CONTENT </code></pre> <h2 id="redirection-3xx"><a class="toclink" href="#redirection-3xx">Redirection - 3xx</a></h2> <p>This class of status code indicates that further action needs to be taken by the user agent in order to fulfill the request.</p> <pre><code>HTTP_300_MULTIPLE_CHOICES HTTP_301_MOVED_PERMANENTLY HTTP_302_FOUND HTTP_303_SEE_OTHER HTTP_304_NOT_MODIFIED HTTP_305_USE_PROXY HTTP_306_RESERVED HTTP_307_TEMPORARY_REDIRECT </code></pre> <h2 id="client-error-4xx"><a class="toclink" href="#client-error-4xx">Client Error - 4xx</a></h2> <p>The 4xx class of status code is intended for cases in which the client seems to have erred. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition.</p> <pre><code>HTTP_400_BAD_REQUEST HTTP_401_UNAUTHORIZED HTTP_402_PAYMENT_REQUIRED HTTP_403_FORBIDDEN HTTP_404_NOT_FOUND HTTP_405_METHOD_NOT_ALLOWED HTTP_406_NOT_ACCEPTABLE HTTP_407_PROXY_AUTHENTICATION_REQUIRED HTTP_408_REQUEST_TIMEOUT HTTP_409_CONFLICT HTTP_410_GONE HTTP_411_LENGTH_REQUIRED HTTP_412_PRECONDITION_FAILED HTTP_413_REQUEST_ENTITY_TOO_LARGE HTTP_414_REQUEST_URI_TOO_LONG HTTP_415_UNSUPPORTED_MEDIA_TYPE HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE HTTP_417_EXPECTATION_FAILED HTTP_428_PRECONDITION_REQUIRED HTTP_429_TOO_MANY_REQUESTS HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS </code></pre> <h2 id="server-error-5xx"><a class="toclink" href="#server-error-5xx">Server Error - 5xx</a></h2> <p>Response status codes beginning with the digit "5" indicate cases in which the server is aware that it has erred or is incapable of performing the request. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition.</p> <pre><code>HTTP_500_INTERNAL_SERVER_ERROR HTTP_501_NOT_IMPLEMENTED HTTP_502_BAD_GATEWAY HTTP_503_SERVICE_UNAVAILABLE HTTP_504_GATEWAY_TIMEOUT HTTP_505_HTTP_VERSION_NOT_SUPPORTED HTTP_511_NETWORK_AUTHENTICATION_REQUIRED </code></pre> <h2 id="helper-functions"><a class="toclink" href="#helper-functions">Helper functions</a></h2> <p>The following helper functions are available for identifying the category of the response code.</p> <pre><code>is_informational() # 1xx is_success() # 2xx is_redirect() # 3xx is_client_error() # 4xx is_server_error() # 5xx </code></pre> </div> <!--/span--> </div> <!--/row--> </div> <!--/.fluid-container--> </div> <!--/.body content--> <div id="push"></div> </div> <!--/.wrapper --> <footer class="span12"> <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>. </p> </footer> <!-- Le javascript ================================================== --> <!-- Placed at the end of the document so the pages load faster --> <script src="../../js/jquery-1.8.1-min.js"></script> <script src="../../js/prettify-1.0.js"></script> <script src="../../js/bootstrap-2.1.1-min.js"></script> <script src="https://fund.django-rest-framework.org/sidebar_include.js"></script> <script>var base_url = '../..';</script> <script src="../../mkdocs/js/require.js"></script> <script src="../../js/theme.js"></script> <script> var shiftWindow = function() { scrollBy(0, -50) }; if (location.hash) shiftWindow(); window.addEventListener("hashchange", shiftWindow); $('.dropdown-menu').on('click touchstart', function(event) { event.stopPropagation(); }); // Dynamically force sidenav/dropdown to no higher than browser window $('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130); $(function() { $(window).resize(function() { $('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130); }); }); </script> </body> </html>