Insights API
The Insights API allows you to programmatically interact with DoiT Insights. You can use it to create, retrieve, and delete insight results (recommendations), as well as retrieve resource-level details for specific insights.
Required Permissions
- Insights Manager
Operations
The Insights API supports the following operations:
-
GET /insights/v1/results: Lists insight results with an aggregate summary.
-
POST /insights/v1/results: Creates a new insight. Currently, you can only create insights under the FinOps or Security categories.
-
DELETE /insights/v1/results: Deletes insight results for a specific insight key.
-
GET /insights/v1/results/source/{sourceID}/insight/{insightKey}/resource-results: Retrieves resource-level results for a specific insight.
-
PUT /insights/v1/results/source/{sourceID}/insight/{insightKey}/status: Updates insight status.
Schema
InsightRequest object
| Property | Type | Description |
|---|---|---|
key | string | A unique identifier for the insight. |
title | string | The insight title. |
shortDescription | string | A brief description of the insight. |
provider | array of strings | The cloud provider. Example: aws, gcp, azure. |
categories | array of strings | One or more categories. Supported values: FinOps, Security. |
resourceResults | array of resource-level result objects. | An array of resource-level results. Supported results:
|
detailedDescriptionMdx | string | A detailed description in MDX format. |
tags | array of strings | An array of tags. For example, security certification information such as ISO. |
reportUrl | string | A URL to an external report. |
easyWinDescription | string | A description of the easy-win opportunity. For example, low-risk, low-complexity, and zero-downtime optimization recommendations. |
cloudFlowTemplateId | string | A CloudFlow template ID associated with the insight. |