API Reference

Create or update an insight

post
https://api.doit.com/insights/v1/results/source//insight/

Creates or updates a single insight for the given source and key. If an insight with the same key already exists for the source, it will be updated. Resource results are managed separately via the resource-results endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Only insights created via the public API can be managed. Currently only "public-api" is supported.

Allowed:
string
required

The unique key identifying the insight.

Body Params

Request body for creating or updating a single insight's metadata. Resource results are managed separately via the resource-results endpoint.

string
required

A unique key for this insight within the source.

string
required

The display title of the insight.

string
required

A brief summary of the insight.

string

A detailed description of the insight in MDX format.

string
required

The cloud provider associated with the resource.

categories
array of objects
required
length ≥ 1

One or more categories this insight belongs to.

string

URL to an external report related to this insight.

string

ID of a CloudFlow template that can automate the remediation of this insight.

string

A description of why this insight is considered an easy win.

string
enum

The display status of the insight.

Allowed:
dismissalDetails
object

Details for why an insight was dismissed.

Responses

Updated 8 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 days ago