Places (Search) API Developer's Guide

Health Entrypoint

The Health Entrypoint can be used to check the availability of the Places (Search) API as part of a monitoring system.
Note: The license does not allow the use of any other requests to the Places (Search) API as part of a health check or monitoring scheme.

The Health Entrypoint is a Places (Search) API Core entrypoint.

Entrypoint URI


GET Method

Returns a response status of 200 OK to indicate that the system is up and running.
Note: Common problems, such as incorrect proxy configurations, firewall configuration issues, or networking problems, will typically not yield a response at all but rather a connection timeout.

Request Example

Response Example

  "message":"The Places API is up and running"