Insights

Create or update an 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.

post/insights/v1/results/source/{sourceID}/insight/{insightKey}

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/insights/v1/results/source/{sourceID}/insight/{insightKey}
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

sourceID'public-api' required

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

insightKeystring required

The unique key identifying the insight.

Request body

keystring required

A unique key for this insight within the source.

titlestring required

The display title of the insight.

shortDescriptionstring required

A brief summary of the insight.

detailedDescriptionMdxstring

A detailed description of the insight in MDX format.

cloudProviderstring required

The cloud provider associated with the resource.

categoriesCreateCategory[] required

One or more categories this insight belongs to.

reportUrlstring

URL to an external report related to this insight.

cloudFlowTemplateIdstring

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

easyWinDescriptionstring

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

status'actionable' | 'acknowledged' | 'optimized' | 'dismissed' | 'in progress' | 'upgrade needed' | 'permissions needed'

The display status of the insight.

Example request

{
  "cloudProvider": "aws"
}

Response

Successful operation

sourcestring

The source that generated the insight.

keystring

The unique key identifying this insight.

titlestring

The display title of the insight.

shortDescriptionstring

A brief summary of the insight.

detailedDescriptionMdxstring

A detailed description of the insight in MDX format.

displayStatus'actionable' | 'acknowledged' | 'optimized' | 'dismissed' | 'in progress' | 'upgrade needed' | 'permissions needed'

The display status of the insight.

cloudProviderstring

The cloud provider associated with the resource.

categoriesCategory[]

Categories this insight belongs to.

lastUpdatedstring date-time

Timestamp of the last update to this insight.

tagsstring[]

Tags for the insight, primarily used for security certification labels (e.g. ISO).

reportUrlstring

URL to an external report related to this insight.

cloudFlowTemplateIdstring

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

easyWinDescriptionstring

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

Example response

{
  "source": "aws-trusted-advisor, aws-cost-optimization-hub, aws-security-hub, azure-advisor, custom, gcp-recommender",
  "cloudProvider": "aws",
  "lastStatusChange": {
    "userId": "/users/0Rkrkeq5P0XLe8QFHKq2"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.