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: fd
projectstring · min: 1 · max: 128Required

Project is the project identifier.

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

Workspace identifier

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

Account is the internal customer account ID.

Example: 8
Responses
200

OK response.

application/json
enabledbooleanRequired

Whether remediation is enabled for this workspace

Example: true
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: 8
Accept: */*

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

Enable remediation

put

Enable AI remediation for a workspace

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

Org is the organisation identifier.

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

Project is the project identifier.

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

Workspace identifier

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

Account is the internal customer account ID.

Example: 2d6
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: 2d6
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: 1o
projectstring · min: 1 · max: 128Required

Project is the project identifier.

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

Workspace identifier

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

Account is the internal customer account ID.

Example: q
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: q
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: r
projectstring · min: 1 · max: 128Required

Project is the project identifier.

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

Workspace identifier

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

Account is the internal customer account ID.

Example: p8f
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: p8f
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: q
projectstring · min: 1 · max: 128Required

Project is the project identifier.

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

Workspace identifier

Example: 9
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: 0ht
projectstring · min: 1 · max: 128Required

Project is the project identifier.

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

Workspace identifier

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

Account is the internal customer account ID.

Example: m
Body
input_payloadanyOptional

Input context for the remediation agent

Example: Voluptas et cumque.
insight_idstringOptional

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

Example: Nulla omnis soluta et.
pipeline_execution_idstringOptional

Pipeline execution identifier

Example: Animi officiis rem.
pipeline_identifierstringOptional

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

Example: Culpa minima.
remediation_typestring · enumRequired

Type of remediation

Example: driftPossible values:
triggered_bystringRequired

User or system that triggered the run

Example: Pariatur nobis.
Responses
201

Created response.

application/json
accountstringRequiredExample: Non omnis error ipsum.
createdinteger · int64Required

Created timestamp in milliseconds

Example: 7654518411789216000
idstringRequired

Unique identifier

Example: Sequi aut doloribus.
input_payloadanyOptional

Input context

Example: Et ea voluptas sequi ullam.
insight_idstringOptional

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

Example: Soluta eligendi.
orgstringRequiredExample: Corrupti impedit.
pipeline_execution_idstringOptionalExample: At eveniet ut ut in aut et.
pipeline_identifierstringOptional

Identifier of the pipeline that created this run.

Example: Velit consectetur voluptatum voluptatem eum possimus soluta.
projectstringRequiredExample: Ut sunt quia.
recommendation_sourcestringOptional

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

Example: Laborum officia minima error maiores commodi odio.
remediation_typestring · enumRequiredExample: driftPossible values:
result_payloadanyOptional

Result data

Example: Eligendi omnis nesciunt reiciendis porro.
result_typestring · enumOptionalExample: pr_createdPossible values:
statusstring · enumRequired

Current status

Example: pendingPossible values:
triggered_bystringRequiredExample: Soluta vel soluta.
updatedinteger · int64Required

Updated timestamp in milliseconds

Example: 3430447329544535600
workspacestringRequiredExample: Qui et repellat libero voluptates rerum inventore.
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: m
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "input_payload": "Quaerat voluptatem et dolor.",
  "insight_id": "Molestiae necessitatibus voluptates omnis voluptatibus ut.",
  "pipeline_execution_id": "Qui omnis aut est qui beatae.",
  "pipeline_identifier": "Nostrum non ullam.",
  "remediation_type": "sto",
  "triggered_by": "Omnis sunt quas cum sed nostrum."
}
{
  "account": "Voluptatem dolorum qui sunt.",
  "created": 8840672757121717000,
  "id": "Sunt vel aspernatur accusamus.",
  "input_payload": "Voluptatum aut doloribus.",
  "insight_id": "Assumenda molestias aut dolor neque asperiores.",
  "org": "Ut placeat voluptas et modi ipsa.",
  "pipeline_execution_id": "Asperiores architecto.",
  "pipeline_identifier": "Quidem debitis sit.",
  "project": "Iste est deserunt maiores id neque.",
  "recommendation_source": "Aliquid beatae ipsum voluptates quia sed.",
  "remediation_type": "sto",
  "result_payload": "Ipsa reprehenderit dolorem sit.",
  "result_type": "pr_created",
  "status": "succeeded",
  "triggered_by": "Quasi dolores iure fuga.",
  "updated": 4898838418761441000,
  "workspace": "Voluptates in."
}

Get remediation run

get

Get a single remediation run by ID

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

Org is the organisation identifier.

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

Project is the project identifier.

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

Workspace identifier

Example: kkl
idstringRequired

Remediation run identifier

Example: Enim enim et quisquam ratione consectetur.
Header parameters
Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: w
Responses
200

OK response.

application/json
accountstringRequiredExample: Perspiciatis et.
createdinteger · int64Required

Created timestamp in milliseconds

Example: 3341040816511363600
idstringRequired

Unique identifier

Example: Praesentium est.
input_payloadanyOptional

Input context

Example: Fuga est nobis suscipit repellat vel.
insight_idstringOptional

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

Example: Architecto debitis.
orgstringRequiredExample: Alias numquam recusandae.
pipeline_execution_idstringOptionalExample: Pariatur suscipit dolor perferendis ullam.
pipeline_identifierstringOptional

Identifier of the pipeline that created this run.

Example: Eligendi deserunt ut minima deserunt optio.
projectstringRequiredExample: Deleniti enim occaecati.
recommendation_sourcestringOptional

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

Example: Quia excepturi possimus distinctio molestiae sint.
remediation_typestring · enumRequiredExample: driftPossible values:
result_payloadanyOptional

Result data

Example: At et.
result_typestring · enumOptionalExample: explanationPossible values:
statusstring · enumRequired

Current status

Example: pendingPossible values:
triggered_bystringRequiredExample: Dolor fugit reiciendis itaque omnis in.
updatedinteger · int64Required

Updated timestamp in milliseconds

Example: 384592005916827140
workspacestringRequiredExample: Autem nemo.
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: w
Accept: */*

{
  "account": "Eos amet.",
  "created": 9221156852013878000,
  "id": "Corrupti et nihil voluptates cupiditate.",
  "input_payload": "Molestiae officiis magni odit sed nihil explicabo.",
  "insight_id": "Dolorem reprehenderit aut facere aut voluptas.",
  "org": "Rerum optio ipsum autem delectus veritatis.",
  "pipeline_execution_id": "Nemo aut modi quia qui quibusdam.",
  "pipeline_identifier": "Sunt consequatur mollitia consequatur magnam eaque dolores.",
  "project": "Perspiciatis ab voluptatibus.",
  "recommendation_source": "Excepturi ea nulla.",
  "remediation_type": "custom",
  "result_payload": "A excepturi.",
  "result_type": "explanation",
  "status": "failed",
  "triggered_by": "Eveniet perspiciatis quia fugiat omnis reprehenderit error.",
  "updated": 6412880774963129000,
  "workspace": "Quis rem."
}

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: d
projectstring · min: 1 · max: 128Required

Project is the project identifier.

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

Workspace identifier

Example: lw
idstringRequired

Remediation run identifier

Example: Voluptatem vel debitis et eligendi vitae.
Header parameters
Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: s
Body
pipeline_execution_idstringOptional

Pipeline execution identifier

Example: Velit exercitationem voluptates eum aut.
result_payloadanyOptional

Result data from the remediation agent

Example: Quibusdam ad aut modi ut.
result_typestring · enumOptional

Type of result

Example: pr_createdPossible values:
statusstring · enumRequired

New status

Example: runningPossible values:
Responses
200

OK response.

application/json
accountstringRequiredExample: Dolore optio dolor voluptas maxime in consequatur.
createdinteger · int64Required

Created timestamp in milliseconds

Example: 5701234019650073000
idstringRequired

Unique identifier

Example: Occaecati quis incidunt at et.
input_payloadanyOptional

Input context

Example: Similique repellat quia consectetur ut aperiam.
insight_idstringOptional

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

Example: Asperiores aut laboriosam et.
orgstringRequiredExample: Tempora perspiciatis molestiae eum recusandae fuga.
pipeline_execution_idstringOptionalExample: Eius nisi vel eligendi quos odit.
pipeline_identifierstringOptional

Identifier of the pipeline that created this run.

Example: Quis et consequuntur dolor voluptatem ratione.
projectstringRequiredExample: Quaerat officiis temporibus error assumenda.
recommendation_sourcestringOptional

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

Example: Vitae sit.
remediation_typestring · enumRequiredExample: stoPossible values:
result_payloadanyOptional

Result data

Example: Tempora voluptatum eaque optio alias voluptatibus.
result_typestring · enumOptionalExample: explanationPossible values:
statusstring · enumRequired

Current status

Example: failedPossible values:
triggered_bystringRequiredExample: Aut et.
updatedinteger · int64Required

Updated timestamp in milliseconds

Example: 5307311481477348000
workspacestringRequiredExample: Voluptas explicabo facilis est soluta.
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: s
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "pipeline_execution_id": "Reiciendis unde recusandae soluta nisi odio consequatur.",
  "result_payload": "Quo impedit sapiente.",
  "result_type": "pr_created",
  "status": "succeeded"
}
{
  "account": "Vel aperiam minus eaque.",
  "created": 8996027514584968000,
  "id": "Nihil reiciendis fuga.",
  "input_payload": "Tenetur ipsa ut vitae eveniet quia possimus.",
  "insight_id": "Molestias error excepturi laudantium dignissimos.",
  "org": "Necessitatibus rerum iusto totam voluptatem consequatur occaecati.",
  "pipeline_execution_id": "Vero esse ipsum repellendus nulla et nesciunt.",
  "pipeline_identifier": "Facilis cum.",
  "project": "Eius iusto.",
  "recommendation_source": "At deserunt.",
  "remediation_type": "ccm",
  "result_payload": "Ea reprehenderit recusandae magni et sapiente.",
  "result_type": "explanation",
  "status": "failed",
  "triggered_by": "Omnis sed in qui amet consequatur.",
  "updated": 8167123921842438000,
  "workspace": "Dolor voluptatibus ipsa ipsam in fuga."
}
PreviousProvisioner Activities
NextRemediation Agent

Last updated

Was this helpful?