This section shows how to use Postman to make API calls to Cloud Observability.
The Cloud Observability API is now available as a collection in Postman. A full list of available Cloud Observability API calls is structured by folder in the left pane of Postman.
The following section is required for the API calls to work.
The collection uses Postman Environment variables to set API keys and other values that might remain static most of the time, for example organization
and project
.
Follow these steps to setup your API keys for your collection.
CloudObs
or CloudObs-YourOrgName
.lightstep_api_key
.organization
or project
variables and/or setup multiple environments.After setup is complete, you are ready to begin making API calls. In the Cloud Observability Public API collection in the left sidebar, there are multiple subfolders for each type of API category listed in the Cloud Observability Public API Reference. You can test your API access by using the API calls under the Test folder.
Some API calls include path, query, or body parameters. When you select an API call from the left sidebar, you can edit the parameters in the tab that opens on the right before sending the API call.
For more information on using Postman, refer to the guides here.
Updated Jan 6, 2023