API Postman Collection Observability

Usage of a Postman collection to communicate with the Observability API

In this tutorial you will learn how to use Postman Collections in order to use and test the Observability API. We created a collection that holds the Observability API. This collection can be imported into Postman and this article is all about it.

Prerequisites

• Postman installed
• Knowledge about RESTful-API
• Knowledge about HTTP requests

Working with the collection

Import the canollection into Postman

1. Download the Observability Postman Collection.
2. Open Postman and select File->Import.
3. Go to the directory that holds your collection file, select it and click Open.
4. You should get a screen like beneath and on the left side you should be able to see STACKIT Observability API.

Configure the canollection in Postman

Before using the API there are some steps that should be done:

1. Select the collection on the left side.
2. Insert your username and password (which you get from your Observability instance → service credential key) into the authorization tab.
3. Switch to the Variables tab.
4. Change the baseUrl to your URL.
5. Open the collection by clicking on the > sign.
6. Run the “GET”-Request list by clicking and Send to test if the requests are working.
7. On the right side you should be able to see a small line like below. If this appears it means the request was successful.
8. test the credentials by sending another request.
   1. click on the v1 folder of the collection.
   2. select the “GET” request with the description v1 instances read.
   3. click on the send button.
9. if you see Status: 200 OK the request was successful. If not check the documentation by clicking on:

This opens a small site with criteria to send a successful request.

Further Information

You can adjust the authorization part by selecting another authorization method. This action can be performed inside of each request by clicking on the Authorization tab and changing the authorization method.