Upload risk assessment data

Upload per-resource risk data and overall risk summary for an existing plan file.

post

Path parameters

orgstring · min: 1 · max: 128Required

Org is the organisation identifier.

Example: kg1

projectstring · min: 1 · max: 128Required

Project is the project identifier.

Example: vv

workspacestringRequired

Workspace identifier

Example: workspace123

Query parameters

pipeline_idstringRequired

The unique identifier for the associated pipeline

Example: Modi molestias.

stage_idstringRequired

The unique identifier for a stage

Example: Sapiente rerum tenetur vel repellat pariatur quia.

pipeline_execution_idstringRequired

The unique identifier for the associated pipeline execution

Example: Odio quas excepturi esse labore aut.

pipeline_stage_idstringRequired

The unique identifier for the associated pipeline execution stage

Example: Expedita laborum dicta in voluptatem vitae deserunt.

provisioner_typestring · enumRequired

Type of provisioner that created the data

Example: awscdkPossible values:

data_typestring · enumRequired

Type of data stored

Example: cost_breakdownPossible values:

stack_pathstringOptional

Optional path to the stack module

Example: Repudiandae rerum consequatur consequatur consequatur vel quae.

Header parameters

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

Account is the internal customer account ID.

Example: oa3

Content-Lengthinteger · int64Optional

Size in bytes of the risk data.

Example: 9166571920224096000

Responses

200

OK response.

application/json

idstringRequired

The unique identifier for the data

Example: dc538c61-de48-4220-958c-5f3c4f983daa

policy_evaluation_messagestringOptional

Pre-rendered message included when policy evaluation did not pass

Example: - instance type 'xlarge' is not permitted

policy_evaluation_statusstring · enumOptional

The overall status of policy evaluation (if it occurred) indicating whether it passed

Example: errorPossible values:

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

post/api/orgs/{org}/projects/{project}/workspaces/{workspace}/risk-assessment

POST /api/orgs/{org}/projects/{project}/workspaces/{workspace}/risk-assessment?pipeline_id=Modi+molestias.&stage_id=Sapiente+rerum+tenetur+vel+repellat+pariatur+quia.&pipeline_execution_id=Odio+quas+excepturi+esse+labore+aut.&pipeline_stage_id=Expedita+laborum+dicta+in+voluptatem+vitae+deserunt.&provisioner_type=awscdk&data_type=cost_breakdown HTTP/1.1
Host: localhost:80
Harness-Account: oa3
Accept: */*

{
  "id": "dc538c61-de48-4220-958c-5f3c4f983daa",
  "policy_evaluation": [
    {
      "message": "Labore quas debitis numquam voluptatem et.",
      "policy_id": "Quisquam eos tempore amet aliquid molestias quisquam.",
      "policy_name": "Eum accusantium soluta ab non fugiat.",
      "policy_set_id": "Aut nihil quas est aspernatur illo qui.",
      "policy_set_name": "Autem dolorum itaque.",
      "policy_status": "Esse porro alias dolorem."
    },
    {
      "message": "Labore quas debitis numquam voluptatem et.",
      "policy_id": "Quisquam eos tempore amet aliquid molestias quisquam.",
      "policy_name": "Eum accusantium soluta ab non fugiat.",
      "policy_set_id": "Aut nihil quas est aspernatur illo qui.",
      "policy_set_name": "Autem dolorum itaque.",
      "policy_status": "Esse porro alias dolorem."
    }
  ],
  "policy_evaluation_message": "- instance type 'xlarge' is not permitted",
  "policy_evaluation_status": "error"
}