Admin settings - API

The APIpage in the Platformsection of the Adminmenu lets you manage access to the Looker API server endpoint. The page also provides a link to the API Explorer documentation.

Accessing the API page

To access the API page:

1. Click the Looker Main menuicon menu .
2. Click Adminto open the Adminmenu.
3. Select API.
4. View the API Host URL.

API Host URL

The API Host URLis the user-facing domain name (and port) that users need to reach the Looker API server endpoint. To specify a URL, enter your API path in the API Host URLfield in the following format:

 https://<instance_name>.cloud.looker.com 

For Looker installations behind a load balancer (for example, a cluster configuration) or other proxy, the user-facing domain name may be different from the actual Looker server machine name. If this is the case, the API Host URLmust indicate the user-facing API host name and port.

If the API Host URLfield is empty, Looker uses the default API path. For Looker instances hosted on Google Cloud, Microsoft Azure, and instances hosted on Amazon Web Service (AWS) that were created on or after 07/07/2020, the default Looker API path uses port 443 . For Looker instances hosted on AWS that were created before 07/07/2020, the default Looker API path uses port 19999 . The default API URL is in the following format:

 https://<instance_name>.cloud.looker.com:<port> 

API Documentation

If you have installed the API Explorer extension from the Looker Marketplace , you can click Use API Explorerto open the API Explorer and view current API documentation.

If you have not installed the API Explorer extension, you can click Install API Explorer from the Marketplaceto install the API Explorer on your Looker instance.