Ctrlk
Sign UpGet a DemoContact Us
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get insight by ID

Returns a single insight for a workspace. Used by the remediating agent for context and by the UI for detail views.

get
Path parameters
orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: 3gc
projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: ww
workspacestring · min: 1 · max: 128Required

Workspace identifier.

Example: c
idstring · min: 1Required

Insight identifier (recommendation_id).

Example: tlm
Header parameters
Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: r
Responses
200

OK response.

application/json
actionstringOptional

Raw suggested-action string for the insight; empty when not applicable.

Example: MigrateToGraviton
applied_bystringOptional

User or system that applied the insight (latest remediating run triggered_by). Empty when not applied via a remediating run.

Example: Qui explicabo fuga incidunt.
applied_oninteger · int64Optional

Unix timestamp in milliseconds when the insight was applied (latest remediating run created time). Empty when not applied via a remediating run.

Example: 6195350149232274000
details_linkstringOptional

Deep link to view the insight in the source system.

Example: Ipsa nostrum aut.
idstringRequired

Stable per-insight identifier.

Example: Quod dolor sed soluta maiores laborum.
monthly_savingnumber · doubleRequired

Potential monthly saving if the insight is acted on.

Example: 0.21778415643653273
monthly_spendnumber · doubleRequired

Current monthly spend on the resource.

Example: 0.6240226915868838
pipeline_execution_idstringOptional

Pipeline execution id for the latest remediation run.

Example: Asperiores impedit et.
pipeline_identifierstringOptional

Identifier of the pipeline that created the latest remediation run. Empty for runs that predate this column.

Example: In a nihil cum unde necessitatibus aliquid.
remediation_result_payloadanyOptional

Latest remediation result payload (e.g. pr_link, skip reasons, error).

Example: Possimus ut rem.
remediation_result_typestring · enumOptional

Latest remediation result type; empty while in-flight.

Example: explanationPossible values:
remediation_run_idstringOptional

Latest remediation run id for this insight, if any.

Example: Velit qui qui possimus.
remediation_statusstring · enumOptional

Latest remediation run status.

Example: failedPossible values:
resource_typestringOptional

Raw resource-type string.

Example: EC2_INSTANCE
statestringRequired

Insight state: OPEN or APPLIED.

Example: OPEN
typestring · enumRequired

Insight type.

Example: driftPossible values:
get/api/orgs/{org}/projects/{project}/workspaces/{workspace}/insights/{id}
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/insights/{id} HTTP/1.1
Host: localhost:80
Harness-Account: r
Accept: */*

{
  "action": "MigrateToGraviton",
  "applied_by": "Quod qui.",
  "applied_on": 282148322734402240,
  "details_link": "Esse distinctio.",
  "id": "Quod nam consequatur sed repellendus.",
  "monthly_saving": 0.2655074775726956,
  "monthly_spend": 0.08960718735657745,
  "pipeline_execution_id": "Nihil quasi cupiditate ducimus at et non.",
  "pipeline_identifier": "Sit officia.",
  "remediation_result_payload": "Officiis maiores dolore sed pariatur sapiente.",
  "remediation_result_type": "pr_created",
  "remediation_run_id": "Cumque sapiente.",
  "remediation_status": "succeeded",
  "resource": {
    "account_id": "000000000000",
    "instance_id": "i-0123456789abcdef0",
    "instance_type": "c4.4xlarge"
  },
  "resource_type": "EC2_INSTANCE",
  "state": "OPEN",
  "type": "drift"
}
PreviousList insights for a workspace
NextMigration

Last updated

Was this helpful?