Reference: Integration with Insomnia API Client

You can upload a Tanium API Gateway example requests JSON file to the Insomnia API client, configure communications between Insomnia and the Tanium ServerTanium Cloud, and submit example requests and receive responses. Insomnia can also parse the example requests and generate code samples based on the requests.

Prerequisites

Download the Insomnia API client and install it on an endpoint that can bidirectionally communicate with the Tanium ServerTanium Cloud. Ensure that your Insomnia API client version supports importing the Insomnia v4 JSON file format.

Download one of the following Tanium API Gateway Insomnia example requests JSON file:

Tanium API Gateway Insomnia example requests collection as of August 2023 (no new functionality since May 2023)
new Tanium API Gateway Insomnia example requests added since May 2023 (as of July 2023)
Tanium API Gateway Insomnia example requests collection as of July 2023
new Tanium API Gateway Insomnia example requests added since December 2022 (as of May 2023)
Tanium API Gateway Insomnia example requests collection as of December 2022
new Tanium API Gateway Insomnia example requests added since November 2022 (as of December 2022)
Tanium API Gateway Insomnia example requests collection as of December 2022

In the Tanium Console, create a user account for the integration. Add this user to the API Gateway User role, and any other roles based on the Tanium solutions against which you want to submit requests. For more information on creating a user, see Tanium Console User Guide: Managing users. For more information on supported Tanium solutions, see Solution dependencies.

If you create an integration user in the Tanium Console, you must also create a matching integration user in the identity provider that you use for Tanium. For more information, see Tanium Console User Guide: Create a user and Tanium Console User Guide: User authentication.
In the Tanium Console, create an API token for this user account and copy the token to your clipboard. For more information, see Tanium Console User Guide: Create an API token.

Configure Insomnia to communicate with Tanium

Back up your workspace before importing a JSON file. If you previously imported a Tanium API Gateway example requests JSON file and made updates in the workspace, then import another JSON file into the project, it might overwrite your workspace changes.

In the Insomnia client, click + next to Projects.
Enter a project name, then click Create.
From the new project, select Create > Request Collection.
Enter a collection name, then click Create.
Select collection_name > Import/Export > Import.
Select the Tanium API Gateway Insomnia example requests file, then click Scan.
Click Import.
Select project_name > collection_name. Confirm that the import succeeded and the example syntax is loaded.

If you previously imported a Tanium API Gateway Insomnia example requests file into a project or collection, the import might overwrite your existing workspace.
From the new project, select No Environment > Manage Environments.

Copy the following JSON object, then paste it in the Base Environment pane:

Copy

1
2
3
4
5
{
  "url": "https://",
  "path": "/plugin/products/gateway/graphql",
  "api_token": "token-string"
}

Update the url value to the Tanium Server URL.
Update the url value to https://<customerName>-api.cloud.tanium.com, replacing <customerName> with your Tanium Cloud instance domain name.
Update the api_token value to the API token string associated with your integration user. Click Close.

Verify integration

In the Insomnia client, select project_name > collection_name
.
Expand General examples and then click Time. Verify that the request path is POST _.url_.path.
Click Header and verify that the session header is set to the _.api_token variable, and that the Content-Type header is set to application/json.
Click Send. The API Gateway service responds with the current system time, such as the following:
Copy
```
1
2
3
4
5
{
  "data": {
    "now": "2021-11-08T19:22:03Z"
  }
}
```

Generate code example from example request

In the Insomnia client, right-click an example, then select Generate Code.
Select a language from the drop-down, then an associated library from the drop-down. The code example updates as you select a language and library.