The API page 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.
If you leave this field empty, Looker will use the default API path. The default API path uses port 19999, and is in the following format:
Looker installations that do not allow connections on Looker’s default API port of 19999 can use an alternate API path in the following format:
or, for customers who include their reigion in their Looker URL:
To use the alternate URL, enter your alternate API path in the API Host URL field.
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. In which case, the API Host URL must indicate the user-facing API host name and port.
Unless your Looker account team or the Looker Chat team advises you to change the API Host URL field, you should leave it blank so that your Looker instance uses the default URL.
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: