The Datadog API makes it easy to get data in and out of Datadog. The Datadog API uses resource-oriented URLs, uses status codes to indicate the success or failure of requests and returns JSON from all requests.
This article will walk you through how to use Postman to perform API calls to Datadog. This can help you understand the power of the Datadog API, what actions can be performed via the DataDog API, and a high-level introduction to how you can use Postman to GET/PUT/POST/and DELETE via the Datadog API.
- You have an active Datadog implementation
- You have admin access and can access the API Key and Application Key (your keys can be found on the API Key page)
- You have the Postman API client installed (free download here)
- You have some basic knowledge of API structure and JSON formatting
Import The Datadog Collection
Now that you have Postman installed let's begin by downloading the Datadog Postman Collection (pre-configured API call templates, available for download here). Save the file to a location on your computer for importing into Postman. In Postman, a collection is a folder of organized API calls for easy editing/saving/and re-use.
Tip: Prior to importing the Datadog collection, you can open the DataDog.postman_collection.json in your text editor of choice, and use Find and Replace, to search for api_key=API_KEY_HERE and replace the "API_KEY_HERE" portion with your actual API key. You can do the same for application_key=APP_KEY_HERE and insert the application key from your Datadog API page. This will prevent you from having to insert these two values for each API call, as they are both required for all API calls, with the exception of the Authentication Check API call which only takes 1 parameter which is api_key.
Now, we will import the Datadog Postman Collection:
- Open Postman
- Click on File -> Import
- Select the Datadog.postman_collection.json file that was downloaded above
- Congratulations! You should know have a Datadog collection with many different API examples.
Working With the Collection
Now that your Postman collection (folder and children folders) have been imported, you are ready to begin making some API calls. You will now see in your Datadog folder, you have child folders for each type of API Category listed on the Datadog API Reference page. This will allow you to click on any of the subfolders, select a predefined API call and modify for your business needs.
When the folders are expanded you will see the HTTP Method and name of the API call.
API GET Calls
If you click on any API from the collection pane, it will load the API on the right side of the screen known as Builder. On this pane you can:
- Send the API call: This will send the API call and show you the returned status, response Time, and the API Response.
- Param will show you all parameters and values that are currently on the API call. This view is much easier than looking at the param1:value1¶m2:value2 structure for editing the API call.
- Here you can add any of the desired parameters and appropriate values that are allowed. You can view what arguments are allowed by visiting the corresponding section on the API documentation. You will notice that you can insert the key on the left side of the pane and the Value on the right side.
- Note: You do not need to include the ampersand (&) or colon (:) as Postman will insert those for you for the key/value pairs and concatenation.
API PUT/POST Calls
When you are defining an entity (Screenboard, metric, tags, etc) or updating a previously defined object, you will want to use a PUT or a POST call. Within the DataDog.postman_collection.json file that you imported, you will see several examples of these calls to set up new entities or to append or update already created entities.
When using these types of API calls within Postman, you will have to define the JSON payload within the Body section of Postman and define the contentType to JSON. You then paste or type in the JSON payload that you want to send on the API. There is built in notifications (red X) that will indicate if you have improperly formatted JSON to make for quick and easy identification.
In the below example, I am using the Setup New Screenboard API call to define a new Screenboard for my Amazon EC2 agents.
After you have all of your JSON entered, you can SEND the request and you should get a Status of 200 signifying the call was successful. You can reference this page to see a full list of possible HTTP status codes.
You can now see the Screenboard within the Datadog UI.
API DELETE Calls
If you need to delete any entity, it is a relatively easy process by using the Datadog API. You will need to use the HTTP DELETE method along with the corresponding ID of the entity you are trying to delete.
After sending the DELETE API call, you should receive a 200 Status, as well as an API response that shows what you just deleted.