Api referenceRemediations

Request Remediation

Reference for Request Remediation in the Veriom v1 API, including request, response, and authentication details.

POST/v1/workspaces/{workspace_id}/remediations

Request Remediation. Returns a typed response and a request ID for operational support.

Authorization

veriom_session<token>

Opaque HttpOnly customer session. Mutations also require X-CSRF-Token.

In: cookie

Path Parameters

workspace_id*Workspace Id
Formatuuid

Header Parameters

Idempotency-Key*Idempotency-Key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/remediations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "finding_id": "feebf65a-2eaa-4fae-aab2-772450efdffe"  }'
{
  "approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
  "baseline_audit_id": "91f541b0-c250-4fc0-aa24-0dc7afcd1d4e",
  "baseline_snapshot": {
    "audit_id": "78c04fa6-cfb4-46a0-9aa5-3681ba4f3897",
    "evidence_ids": [
      "973ab5a6-b373-447d-ab9d-bdb660b35afc"
    ],
    "finding_fingerprint": "string",
    "high_or_critical_fingerprints": [
      "string"
    ],
    "recorded_at": "2019-08-24T14:15:22Z",
    "relevant_scanners": [
      "string"
    ],
    "risk_severity": "string",
    "risk_total": "string"
  },
  "branch_name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "expected_outcomes": [
    {}
  ],
  "explanation": "string",
  "finding_id": "feebf65a-2eaa-4fae-aab2-772450efdffe",
  "finding_title": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "patch_sha256": "string",
  "pull_request_url": "string",
  "repository_id": "b349ae61-b973-4c6c-a5e0-89183ba99ff3",
  "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
  "static_rescan": {},
  "status": "string",
  "verification_audit_id": "cef6c8ad-7eed-4189-9f94-26d2342cdd25",
  "verification_result": {
    "baseline_audit_id": "91f541b0-c250-4fc0-aa24-0dc7afcd1d4e",
    "baseline_risk": "string",
    "evidence_ids": [
      "973ab5a6-b373-447d-ab9d-bdb660b35afc"
    ],
    "new_high_or_critical_fingerprints": [
      "string"
    ],
    "observed_at": "2019-08-24T14:15:22Z",
    "observed_audit_id": "31138278-f48f-4540-9df9-76511583a7a6",
    "original_finding_present": true,
    "outcome": "verified",
    "reasons": [
      "string"
    ],
    "residual_risk": "string",
    "risk_delta": "string",
    "scanner_status": {
      "property1": "string",
      "property2": "string"
    }
  },
  "verified_at": "2019-08-24T14:15:22Z"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}

List Remediations

Previous Page

Approve Remediation

Next Page