Update remediation run

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

put

Path parameters

orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: w

projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: 0

workspacestring · min: 1 · max: 128Required

Workspace identifier

Example: z5

idstringRequired

Remediation run identifier

Example: Voluptas similique commodi sunt.

Header parameters

Harness-Accountstring · min: 1 · max: 128Required

Account is the internal customer account ID.

Example: ih6

Body

pipeline_execution_idstringOptional

Pipeline execution identifier

Example: Alias at eum pariatur.

result_payloadanyOptional

Result data from the remediation agent

Example: Sapiente nulla omnis soluta et.

result_typestring · enumOptional

Type of result

Example: explanationPossible values:

statusstring · enumRequired

New status

Example: succeededPossible values:

Responses

200

OK response.

application/json

accountstringRequiredExample: Ut est fuga inventore eum.

createdinteger · int64Required

Created timestamp in milliseconds

Example: 9008239243168730000

idstringRequired

Unique identifier

Example: Ea nulla reiciendis unde.

input_payloadanyOptional

Input context

Example: Velit consectetur voluptatum voluptatem eum possimus soluta.

insight_idstringOptional

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

Example: Reiciendis porro.

orgstringRequiredExample: Sequi aut doloribus.

pipeline_execution_idstringOptionalExample: Quia tempora qui.

pipeline_identifierstringOptional

Identifier of the pipeline that created this run.

Example: Repellat libero voluptates rerum inventore sapiente.

projectstringRequiredExample: Non omnis error ipsum.

recommendation_sourcestringOptional

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

Example: Et ea voluptas sequi ullam.

remediation_typestring · enumRequiredExample: ccmPossible values:

result_payloadanyOptional

Result data

Example: At eveniet ut ut in aut et.

result_typestring · enumOptionalExample: pr_createdPossible values:

statusstring · enumRequired

Current status

Example: failedPossible values:

triggered_bystringRequiredExample: Aliquam eligendi omnis.

updatedinteger · int64Required

Updated timestamp in milliseconds

Example: 6106458861285734000

workspacestringRequiredExample: Corrupti impedit.

400

BadRequestError: Bad Request response.

application/vnd.goa.error

401

UnauthorizedError: Unauthorized response.

application/vnd.goa.error

403

ForbiddenError: Forbidden response.

application/vnd.goa.error

404

NotFoundError: Not Found response.

application/vnd.goa.error

408

TimeoutError: Request Timeout response.

application/vnd.goa.error

409

ConflictError: Conflict response.

application/vnd.goa.error

423

LockedError: Locked response.

application/vnd.goa.error

499

ContextCancelledError: response.

application/vnd.goa.error

500

InternalServerError: Internal Server Error response.

application/vnd.goa.error

502

BadGatewayError: Bad Gateway response.

application/vnd.goa.error

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: ih6
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "pipeline_execution_id": "Odio ea reprehenderit recusandae magni et sapiente.",
  "result_payload": "Facilis cum.",
  "result_type": "explanation",
  "status": "succeeded"
}

{
  "account": "Voluptates aut.",
  "created": 3749367189750927000,
  "id": "Dignissimos velit at.",
  "input_payload": "Architecto ullam consequatur repellat ut qui.",
  "insight_id": "Deserunt sint aliquid fugiat et id harum.",
  "org": "Labore dolorum ab dignissimos.",
  "pipeline_execution_id": "Perspiciatis optio.",
  "pipeline_identifier": "Maiores quia eaque esse rerum et.",
  "project": "Consequatur eveniet tempore ullam dolor dolor eligendi.",
  "recommendation_source": "Cupiditate sint perspiciatis.",
  "remediation_type": "ccm",
  "result_payload": "Vitae commodi debitis.",
  "result_type": "explanation",
  "status": "succeeded",
  "triggered_by": "Eos et et quas eius non.",
  "updated": 5174355813756320000,
  "workspace": "Odit provident."
}