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

Insights

Insights Service lists insights for a workspace.

List insights for a workspace

get

Returns a paginated list of insights for a workspace (cost and drift).

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

Org is the organisation identifier.

Example: t
projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: 3f
workspacestring · min: 1 · max: 128Required

Workspace identifier.

Example: mkd
Query parameters
limitinteger · int64 · min: 1 · max: 1000Optional

Limit is the number of records to return for a page. When omitted, all records are returned.

Example: 30
pageinteger · int64 · min: 1Optional

Page is the page number to return relative to the page 'limit'. When omitted, all records are returned.

Example: 1
typestring · enumOptional

Filter by insight type. When omitted, all types are returned.

Example: costPossible values:
statestring · enumOptional

Filter by insight state. When omitted, all states are returned.

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

Account is the internal customer account ID.

Example: kv
Responses
200

OK response.

application/json
get/api/orgs/{org}/projects/{project}/workspaces/{workspace}/insights
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/insights HTTP/1.1
Host: localhost:80
Harness-Account: kv
Accept: */*

[
  {
    "action": "MigrateToGraviton",
    "applied_by": "Et et recusandae.",
    "applied_on": 6544316513775669000,
    "details_link": "Quo ut.",
    "id": "Sed et voluptatum dolore consequuntur est.",
    "monthly_saving": 0.827122981880376,
    "monthly_spend": 0.3175470411269389,
    "pipeline_execution_id": "Dolorem dignissimos sunt ea repellat.",
    "pipeline_identifier": "Saepe qui quia occaecati consequatur esse soluta.",
    "remediation_result_payload": "Et voluptatum iure eum debitis sunt.",
    "remediation_result_type": "explanation",
    "remediation_run_id": "Adipisci quia natus laborum quia expedita.",
    "remediation_status": "succeeded",
    "resource": {
      "account_id": "000000000000",
      "instance_id": "i-0123456789abcdef0",
      "instance_type": "c4.4xlarge"
    },
    "resource_type": "EC2_INSTANCE",
    "state": "OPEN",
    "type": "drift"
  },
  {
    "action": "MigrateToGraviton",
    "applied_by": "Et et recusandae.",
    "applied_on": 6544316513775669000,
    "details_link": "Quo ut.",
    "id": "Sed et voluptatum dolore consequuntur est.",
    "monthly_saving": 0.827122981880376,
    "monthly_spend": 0.3175470411269389,
    "pipeline_execution_id": "Dolorem dignissimos sunt ea repellat.",
    "pipeline_identifier": "Saepe qui quia occaecati consequatur esse soluta.",
    "remediation_result_payload": "Et voluptatum iure eum debitis sunt.",
    "remediation_result_type": "explanation",
    "remediation_run_id": "Adipisci quia natus laborum quia expedita.",
    "remediation_status": "succeeded",
    "resource": {
      "account_id": "000000000000",
      "instance_id": "i-0123456789abcdef0",
      "instance_type": "c4.4xlarge"
    },
    "resource_type": "EC2_INSTANCE",
    "state": "OPEN",
    "type": "drift"
  },
  {
    "action": "MigrateToGraviton",
    "applied_by": "Et et recusandae.",
    "applied_on": 6544316513775669000,
    "details_link": "Quo ut.",
    "id": "Sed et voluptatum dolore consequuntur est.",
    "monthly_saving": 0.827122981880376,
    "monthly_spend": 0.3175470411269389,
    "pipeline_execution_id": "Dolorem dignissimos sunt ea repellat.",
    "pipeline_identifier": "Saepe qui quia occaecati consequatur esse soluta.",
    "remediation_result_payload": "Et voluptatum iure eum debitis sunt.",
    "remediation_result_type": "explanation",
    "remediation_run_id": "Adipisci quia natus laborum quia expedita.",
    "remediation_status": "succeeded",
    "resource": {
      "account_id": "000000000000",
      "instance_id": "i-0123456789abcdef0",
      "instance_type": "c4.4xlarge"
    },
    "resource_type": "EC2_INSTANCE",
    "state": "OPEN",
    "type": "drift"
  }
]

Get insight by ID

get

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

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

Org is the organisation identifier.

Example: 9v
projectstring · min: 1 · max: 128Required

Project is the project identifier.

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

Workspace identifier.

Example: 7mi
idstring · min: 1Required

Insight identifier (recommendation_id).

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

Account is the internal customer account ID.

Example: c4p
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: Laborum repellendus.
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: 5609343062183654000
details_linkstringOptional

Deep link to view the insight in the source system.

Example: Numquam ipsa dolores maxime sed omnis.
idstringRequired

Stable per-insight identifier.

Example: Aspernatur est libero quo dolor enim iure.
monthly_savingnumber · doubleRequired

Potential monthly saving if the insight is acted on.

Example: 0.31525002219046533
monthly_spendnumber · doubleRequired

Current monthly spend on the resource.

Example: 0.8669205563212898
pipeline_execution_idstringOptional

Pipeline execution id for the latest remediation run.

Example: Neque et qui at rerum ipsum qui.
pipeline_identifierstringOptional

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

Example: Ut expedita aliquam voluptas esse.
remediation_result_payloadanyOptional

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

Example: In consequatur nihil.
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: Non et quia ut sit ad earum.
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: costPossible 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: c4p
Accept: */*

{
  "action": "MigrateToGraviton",
  "applied_by": "Saepe et illo consequatur illo sed.",
  "applied_on": 5560338727882045000,
  "details_link": "Maiores quibusdam ad eos ut voluptatem.",
  "id": "Libero debitis libero deleniti quia delectus.",
  "monthly_saving": 0.021922076122201588,
  "monthly_spend": 0.6168366462556975,
  "pipeline_execution_id": "Eaque ut totam adipisci.",
  "pipeline_identifier": "Blanditiis ipsum ipsam.",
  "remediation_result_payload": "Ut ea rerum.",
  "remediation_result_type": "pr_created",
  "remediation_run_id": "Asperiores in placeat voluptatum dicta.",
  "remediation_status": "succeeded",
  "resource": {
    "account_id": "000000000000",
    "instance_id": "i-0123456789abcdef0",
    "instance_type": "c4.4xlarge"
  },
  "resource_type": "EC2_INSTANCE",
  "state": "OPEN",
  "type": "cost"
}
PreviousCosts
NextMigration

Last updated

Was this helpful?