Starting in Looker 21.14, the interactive API documentation is deprecated, and is no longer maintained. For current API reference documentation, the API Explorer extension is available from the Looker Marketplace. For more information, see the Using the API Explorer documentation page. If you don’t have access to a Looker instance on which the API Explorer is installed, you can view a public version on Looker’s Developer Portal.
The API page in the Platform section of the Admin menu lets you manage access to Looker’s API server endpoint. The page also provides a link to the deprecated interactive API documentation.
To access the API page:
- Click Admin to open the Admin menu. If the Enhanced Navigation Labs feature is enabled on your instance, you can access the Admin panel by selecting the Admin option in the new enhanced left navigation panel.
- Select API.
- 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), 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:
Click View Legacy API Docs to view the deprecated interactive API documentation. If the Require Authentication to Retrieve API Specifications legacy feature is enabled, you will be required to enter your Client ID and Client Secret API3 keys to view the legacy API documentation.
If you have installed the API Explorer extension from the Looker Marketplace, you can click Use API Explorer to 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 Marketplace to install the API Explorer on your Looker instance.
If you don’t have access to a Looker instance on which the API Explorer is installed, you can view a public version on Looker’s Developer Portal.