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

Remediation

Remediation service handles the API for AI-powered drift remediation runs

Get remediation config

get

Check whether AI remediation is enabled for a workspace

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

Org is the organisation identifier.

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

Project is the project identifier.

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

Workspace identifier

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

Account is the internal customer account ID.

Example: 9
Responses
200

OK response.

application/json
enabledbooleanRequired

Whether remediation is enabled for this workspace

Example: false
sourcestring · enumRequired

Origin of the configuration

Example: nonePossible values:
get/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/config
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/config HTTP/1.1
Host: localhost:80
Harness-Account: 9
Accept: */*

{
  "enabled": false,
  "source": "disabled"
}

Enable remediation

put

Enable AI remediation for a workspace

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

Org is the organisation identifier.

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

Project is the project identifier.

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

Workspace identifier

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

Account is the internal customer account ID.

Example: vbb
Responses
200

OK response.

No content
put/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/config
PUT /api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/config HTTP/1.1
Host: localhost:80
Harness-Account: vbb
Accept: */*

No content

Disable remediation

delete

Disable AI remediation for a workspace

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

Org is the organisation identifier.

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

Project is the project identifier.

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

Workspace identifier

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

Account is the internal customer account ID.

Example: s
Responses
200

OK response.

No content
delete/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/config
DELETE /api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/config HTTP/1.1
Host: localhost:80
Harness-Account: s
Accept: */*

No content

Get drift plan

get

Download the plan file associated with the workspace's current drift state. Validates the workspace is drifted and returns the plan binary from the drift-detection activity.

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

Org is the organisation identifier.

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

Project is the project identifier.

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

Workspace identifier

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

Account is the internal customer account ID.

Example: 2
Responses
200

OK response.

application/json
string · binaryOptional
get/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/drift-plan
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/drift-plan HTTP/1.1
Host: localhost:80
Harness-Account: 2
Accept: */*

binary

List remediation runs

get

List remediation runs for a workspace

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

Org is the organisation identifier.

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

Project is the project identifier.

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

Workspace identifier

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

Limit is the number of records to return for a page.

Default: 30Example: 30
pageinteger · int64 · min: 1Optional

Page is the page number to return relative to the page 'limit'.

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

Account is the internal customer account ID.

Example: v
Responses
200

OK response.

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

[
  {
    "account": "Neque aut et.",
    "created": 7684404401415059000,
    "id": "Est ducimus at modi.",
    "input_payload": "Assumenda dignissimos eum eum.",
    "insight_id": "Quasi qui.",
    "org": "Repellat commodi quia provident.",
    "pipeline_execution_id": "Est quod laboriosam est quasi.",
    "pipeline_identifier": "Et et excepturi.",
    "project": "Nulla eum autem et asperiores saepe omnis.",
    "recommendation_source": "Doloremque ea.",
    "remediation_type": "drift",
    "result_payload": "Molestiae eos.",
    "result_type": "explanation",
    "status": "succeeded",
    "triggered_by": "Eligendi est.",
    "updated": 2832661344395393500,
    "workspace": "Ut et distinctio porro."
  },
  {
    "account": "Neque aut et.",
    "created": 7684404401415059000,
    "id": "Est ducimus at modi.",
    "input_payload": "Assumenda dignissimos eum eum.",
    "insight_id": "Quasi qui.",
    "org": "Repellat commodi quia provident.",
    "pipeline_execution_id": "Est quod laboriosam est quasi.",
    "pipeline_identifier": "Et et excepturi.",
    "project": "Nulla eum autem et asperiores saepe omnis.",
    "recommendation_source": "Doloremque ea.",
    "remediation_type": "drift",
    "result_payload": "Molestiae eos.",
    "result_type": "explanation",
    "status": "succeeded",
    "triggered_by": "Eligendi est.",
    "updated": 2832661344395393500,
    "workspace": "Ut et distinctio porro."
  },
  {
    "account": "Neque aut et.",
    "created": 7684404401415059000,
    "id": "Est ducimus at modi.",
    "input_payload": "Assumenda dignissimos eum eum.",
    "insight_id": "Quasi qui.",
    "org": "Repellat commodi quia provident.",
    "pipeline_execution_id": "Est quod laboriosam est quasi.",
    "pipeline_identifier": "Et et excepturi.",
    "project": "Nulla eum autem et asperiores saepe omnis.",
    "recommendation_source": "Doloremque ea.",
    "remediation_type": "drift",
    "result_payload": "Molestiae eos.",
    "result_type": "explanation",
    "status": "succeeded",
    "triggered_by": "Eligendi est.",
    "updated": 2832661344395393500,
    "workspace": "Ut et distinctio porro."
  },
  {
    "account": "Neque aut et.",
    "created": 7684404401415059000,
    "id": "Est ducimus at modi.",
    "input_payload": "Assumenda dignissimos eum eum.",
    "insight_id": "Quasi qui.",
    "org": "Repellat commodi quia provident.",
    "pipeline_execution_id": "Est quod laboriosam est quasi.",
    "pipeline_identifier": "Et et excepturi.",
    "project": "Nulla eum autem et asperiores saepe omnis.",
    "recommendation_source": "Doloremque ea.",
    "remediation_type": "drift",
    "result_payload": "Molestiae eos.",
    "result_type": "explanation",
    "status": "succeeded",
    "triggered_by": "Eligendi est.",
    "updated": 2832661344395393500,
    "workspace": "Ut et distinctio porro."
  }
]

Create remediation run

post

Create a new remediation run (called by the remediation pipeline plugin)

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

Org is the organisation identifier.

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

Project is the project identifier.

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

Workspace identifier

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

Account is the internal customer account ID.

Example: fa
Body
input_payloadanyOptional

Input context for the remediation agent

Example: Quaerat officiis temporibus error assumenda.
insight_idstringOptional

Insight (recommendation) id being remediated; empty for legacy callers.

Example: Voluptas explicabo facilis est soluta.
pipeline_execution_idstringOptional

Pipeline execution identifier

Example: Occaecati quis incidunt at et.
pipeline_identifierstringOptional

Identifier of the pipeline that created this run (from the caller's HARNESS_PIPELINE_ID). Empty for legacy callers.

Example: Dolore optio dolor voluptas maxime in consequatur.
remediation_typestring · enumRequired

Type of remediation

Example: customPossible values:
triggered_bystringRequired

User or system that triggered the run

Example: Tempora perspiciatis molestiae eum recusandae fuga.
Responses
201

Created response.

application/json
accountstringRequiredExample: Asperiores aut laboriosam et.
createdinteger · int64Required

Created timestamp in milliseconds

Example: 995970010489815400
idstringRequired

Unique identifier

Example: Aut et.
input_payloadanyOptional

Input context

Example: Quae quia.
insight_idstringOptional

Insight (recommendation) id linked to this run, if any.

Example: Doloremque ipsam aut sapiente commodi sunt sed.
orgstringRequiredExample: Vitae sit.
pipeline_execution_idstringOptionalExample: Hic in itaque autem.
pipeline_identifierstringOptional

Identifier of the pipeline that created this run.

Example: Laudantium impedit et et adipisci aut et.
projectstringRequiredExample: Tempore facere voluptatem et unde officiis.
recommendation_sourcestringOptional

Recommendation source persisted for the insight link (derived server-side from remediation_type).

Example: Illum voluptate consequatur.
remediation_typestring · enumRequiredExample: ccmPossible values:
result_payloadanyOptional

Result data

Example: Tenetur enim dignissimos id fuga quisquam.
result_typestring · enumOptionalExample: pr_createdPossible values:
statusstring · enumRequired

Current status

Example: pendingPossible values:
triggered_bystringRequiredExample: Assumenda quos magni quibusdam.
updatedinteger · int64Required

Updated timestamp in milliseconds

Example: 2135360956066035700
workspacestringRequiredExample: Beatae error placeat ut.
post/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/runs
POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/runs HTTP/1.1
Host: localhost:80
Harness-Account: fa
Content-Type: application/json
Accept: */*
Content-Length: 293

{
  "input_payload": "Eius eum.",
  "insight_id": "Vel aspernatur accusamus.",
  "pipeline_execution_id": "Est facilis magni sed repellendus aspernatur.",
  "pipeline_identifier": "Architecto fugit harum quo quaerat asperiores.",
  "remediation_type": "drift",
  "triggered_by": "Autem itaque laborum sed amet modi."
}
{
  "account": "Reiciendis aliquam.",
  "created": 238684483956654500,
  "id": "Debitis vel iure adipisci similique impedit.",
  "input_payload": "Nesciunt laudantium aliquam aut in.",
  "insight_id": "Vel aperiam minus eaque.",
  "org": "Ea quasi a dicta consequuntur ipsam.",
  "pipeline_execution_id": "Recusandae soluta nisi odio consequatur et.",
  "pipeline_identifier": "Enim error laborum perferendis.",
  "project": "Voluptatem aliquam est nobis laudantium id.",
  "recommendation_source": "Necessitatibus rerum iusto totam voluptatem consequatur occaecati.",
  "remediation_type": "custom",
  "result_payload": "Quasi earum.",
  "result_type": "pr_created",
  "status": "running",
  "triggered_by": "Nihil reiciendis fuga.",
  "updated": 6250359931111864000,
  "workspace": "Quae qui quisquam cupiditate quo impedit sapiente."
}

Get remediation run

get

Get a single remediation run by ID

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

Org is the organisation identifier.

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

Project is the project identifier.

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

Workspace identifier

Example: 8dw
idstringRequired

Remediation run identifier

Example: Aut quos.
Header parameters
Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: df
Responses
200

OK response.

application/json
accountstringRequiredExample: Error accusamus modi.
createdinteger · int64Required

Created timestamp in milliseconds

Example: 3503312763888732700
idstringRequired

Unique identifier

Example: Iusto occaecati tempora id quae ut reiciendis.
input_payloadanyOptional

Input context

Example: Et dignissimos.
insight_idstringOptional

Insight (recommendation) id linked to this run, if any.

Example: Totam aut eos corporis eius magnam commodi.
orgstringRequiredExample: Et non aut.
pipeline_execution_idstringOptionalExample: Aperiam non qui sint.
pipeline_identifierstringOptional

Identifier of the pipeline that created this run.

Example: Atque magni sunt ipsam ex nulla.
projectstringRequiredExample: Consectetur magni.
recommendation_sourcestringOptional

Recommendation source persisted for the insight link (derived server-side from remediation_type).

Example: Incidunt blanditiis aperiam deleniti non.
remediation_typestring · enumRequiredExample: customPossible values:
result_payloadanyOptional

Result data

Example: Sit maxime voluptas dolorem et.
result_typestring · enumOptionalExample: pr_createdPossible values:
statusstring · enumRequired

Current status

Example: failedPossible values:
triggered_bystringRequiredExample: Voluptas qui ut minus.
updatedinteger · int64Required

Updated timestamp in milliseconds

Example: 8836309459994216000
workspacestringRequiredExample: Vero eaque et placeat dicta.
get/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/runs/{id}
GET /api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/runs/{id} HTTP/1.1
Host: localhost:80
Harness-Account: df
Accept: */*

{
  "account": "Tempora vel sit similique ex.",
  "created": 5674859131102709000,
  "id": "Aliquid expedita quo.",
  "input_payload": "Natus officiis quis.",
  "insight_id": "Enim et est corrupti.",
  "org": "Vitae ut sint eum maiores voluptate.",
  "pipeline_execution_id": "Dignissimos dolore sint ea.",
  "pipeline_identifier": "Non vel non.",
  "project": "Id ipsa earum a necessitatibus numquam in.",
  "recommendation_source": "Blanditiis inventore aut est est rerum ut.",
  "remediation_type": "sto",
  "result_payload": "Et quia.",
  "result_type": "explanation",
  "status": "pending",
  "triggered_by": "Minus molestiae enim.",
  "updated": 1522935218004131000,
  "workspace": "Sint voluptas dolores similique et laudantium voluptas."
}

Update remediation run

put

Update a remediation run status and results (called by the remediation pipeline plugin)

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

Org is the organisation identifier.

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

Project is the project identifier.

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

Workspace identifier

Example: knk
idstringRequired

Remediation run identifier

Example: Eligendi enim est minima.
Header parameters
Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: 3m
Body
pipeline_execution_idstringOptional

Pipeline execution identifier

Example: Amet nihil est.
result_payloadanyOptional

Result data from the remediation agent

Example: Fugit est tempora voluptatem eligendi.
result_typestring · enumOptional

Type of result

Example: pr_createdPossible values:
statusstring · enumRequired

New status

Example: runningPossible values:
Responses
200

OK response.

application/json
accountstringRequiredExample: Similique id cupiditate aliquid corrupti beatae.
createdinteger · int64Required

Created timestamp in milliseconds

Example: 3495646356012028000
idstringRequired

Unique identifier

Example: Et iusto qui.
input_payloadanyOptional

Input context

Example: Enim numquam dolorem aut laboriosam nulla.
insight_idstringOptional

Insight (recommendation) id linked to this run, if any.

Example: Vel magnam molestias occaecati earum vero.
orgstringRequiredExample: Fugiat autem pariatur.
pipeline_execution_idstringOptionalExample: Voluptatum asperiores laudantium tempore maiores.
pipeline_identifierstringOptional

Identifier of the pipeline that created this run.

Example: Deserunt dolore placeat beatae sit dolor blanditiis.
projectstringRequiredExample: Rerum maxime ullam et.
recommendation_sourcestringOptional

Recommendation source persisted for the insight link (derived server-side from remediation_type).

Example: Vero quis minima est.
remediation_typestring · enumRequiredExample: ccmPossible values:
result_payloadanyOptional

Result data

Example: Esse officia repellendus non.
result_typestring · enumOptionalExample: explanationPossible values:
statusstring · enumRequired

Current status

Example: runningPossible values:
triggered_bystringRequiredExample: Quisquam officiis neque officiis.
updatedinteger · int64Required

Updated timestamp in milliseconds

Example: 766924720498542000
workspacestringRequiredExample: Est quo possimus.
put/api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/runs/{id}
PUT /api/orgs/{org}/projects/{project}/workspaces/{workspace}/remediation/runs/{id} HTTP/1.1
Host: localhost:80
Harness-Account: 3m
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "pipeline_execution_id": "Deserunt voluptates aut illum.",
  "result_payload": "Error excepturi laudantium dignissimos velit.",
  "result_type": "explanation",
  "status": "succeeded"
}
{
  "account": "Exercitationem vitae commodi debitis.",
  "created": 7523712272951560000,
  "id": "Eaque esse rerum et.",
  "input_payload": "Illum perferendis.",
  "insight_id": "Consequatur et.",
  "org": "Architecto ullam consequatur repellat ut qui.",
  "pipeline_execution_id": "Perspiciatis aut.",
  "pipeline_identifier": "Dolorem veritatis impedit et.",
  "project": "Eos et et quas eius non.",
  "recommendation_source": "Dolorem quas.",
  "remediation_type": "ccm",
  "result_payload": "Voluptas soluta nihil.",
  "result_type": "explanation",
  "status": "pending",
  "triggered_by": "Enim quo beatae recusandae laudantium vero.",
  "updated": 6754218177980121000,
  "workspace": "Deserunt sint aliquid fugiat et id harum."
}
PreviousProvisioner Activities
NextRemediation Agent

Last updated

Was this helpful?