Is HTTP 501 appropriate for an unimplemented API?

http http-error
coppro picture coppro · Oct 1, 2015 · Viewed 9.1k times · Source

Is an HTTP 501 error appropriate for functionality which the server plans to support, but does not currently, such as a particular case of an API? For instance, if I was designing a webmail app and I couldn't yet delete emails with attachments, would it be appropriate to give 501 if I got a DELETE request on an email with an attachment?

The RFC says that it should be used for an unknown method (e.g. a PARTY request), but it's not clear whether it should be used for other functionality as well.

Answer

CodeCaster picture CodeCaster · Oct 1, 2015

appropriate

No:

6.6.2. 501 Not Implemented

The 501 (Not Implemented) status code indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

Use 405:

6.5.5. 405 Method Not Allowed

The 405 (Method Not Allowed) status code indicates that the method received in the request-line is known by the origin server but not supported by the target resource. The origin server MUST generate an Allow header field in a 405 response containing a list of the target resource's currently supported methods.

Related questions

Rest error message in HTTP Header or Response Body?

I have a REST service that is exposed to iPhone and Android clients. Currently I follow the HTTP codes 200, 400, 401, 403, 404, 409, 500 etc. My question is where is the recommended place to put the reason/description/cause of the error? Does it make …

Read More
how to get access to error message from abort command when using custom error handler

Using a python flask server, I want to be able to throw an http error response with the abort command and use a custom response string and a custom message in the body @app.errorhandler(400) def custom400(error): response = jsonify({…

Read More
Instagram/feed API media URL shows 'URL signature expired'

I am using Instagram feed API to show my Instagram posts on my Website. But some video URL shows 'URL signature expired'. Any solution for me ?

Read More