The API page in the Platform section of the Admin menu lets you manage access to Looker’s API server endpoint and the Interactive API Documentation. It also provides a link to the Interactive API Documentation, where you can view both the stable API version 3.0 and the beta API version 3.1.
To access the API page:
- Click Admin to open the Admin menu.
- Click API in the Admin panel.
- View the API Host URL.
API Host URL
The API Host URL is 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 URL field in one of the following formats:
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 URL must indicate the user-facing API host name and port.
If the API Host URL field is empty, Looker uses the default API path. For Looker instances hosted on Google Cloud Platform (GCP), and for 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:
By default, anybody with the URL to your Interactive API Documentation is allowed to view it. However, you can require that users sign in with a client ID and client secret in order to view the API documentation. To do this, select Require API login to see API docs and click Save.
The client ID and client secret are part of an API3 key that is specific to each Looker user. Looker admins can generate an API3 key in the Edit User page, as described here.
View API Docs
Click the View API Docs link to see Looker’s Interactive API Documentation: