In many situations, you may want to use common HTTP status codes to indicate the success or failure of a user's API request. For example, if a user is attempting to retrieve an entity which does not exist, you may want to send an HTTP 404 status code saying No entity with the ID entity_id exists.

Important: An uncaught exception in your application will result in a 503 error from your Endpoints API.

You can send such common HTTP status codes by raising an exception provided by the endpoints library as follows:

message = 'No entity with the id "%s" exists.' % entity_id
raise endpoints.NotFoundException(message)

Exceptions Provided by Endpoints

The endpoints library provides the following exceptions, corresponding to specific HTTP status codes:

Creating Your Own Exception Classes

If you want to create other exception classes for other HTTP status codes, you can do so by subclassing endpoints.ServiceException.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.