Api referenceWorkspaces

Create Structural Remediation Program

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

POST/v1/workspaces/{workspace_id}/structural/remediation-programs

Create Structural Remediation Program. 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

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/structural/remediation-programs" \  -H "Content-Type: application/json" \  -d '{    "finding_id": "feebf65a-2eaa-4fae-aab2-772450efdffe",    "rationale": "stringstringstringst",    "steps": [      {        "invariant_id": "string",        "invariant_version": "string",        "owner_scope": "string",        "repository_ids": [          "f3227fc5-024f-4c73-b362-d0cb9602924d"        ],        "title": "string",        "verification_predicate": "stringstri"      },      {        "invariant_id": "string",        "invariant_version": "string",        "owner_scope": "string",        "repository_ids": [          "f3227fc5-024f-4c73-b362-d0cb9602924d"        ],        "title": "string",        "verification_predicate": "stringstri"      }    ],    "title": "stringstri"  }'
{
  "activated_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  "current_step": 0,
  "finding_id": "feebf65a-2eaa-4fae-aab2-772450efdffe",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "rationale": "string",
  "review_notes": "string",
  "reviewed_by": "92ab4dbc-1b27-40ce-b24b-7dde8f4709be",
  "root_cause_id": "b1af806c-3628-4c2b-afab-f27297369fe7",
  "state": "draft",
  "steps": [
    {
      "evaluation_status": "string",
      "evidence_ids": [
        "string"
      ],
      "invariant_id": "string",
      "invariant_version": "string",
      "order": 0,
      "owner_scope": "string",
      "repository_ids": [
        "f3227fc5-024f-4c73-b362-d0cb9602924d"
      ],
      "review_notes": "string",
      "state": "ready",
      "title": "string",
      "verification_audit_id": "cef6c8ad-7eed-4189-9f94-26d2342cdd25",
      "verification_predicate": "string",
      "verified_at": "2019-08-24T14:15:22Z"
    }
  ],
  "target_state_ref": "string",
  "title": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "version": 1,
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
{
  "code": "validation_failed",
  "detail": "The request body did not match the documented schema.",
  "hint": "Correct the fields identified in detail using the operation's request 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.",
  "hint": "Correct the fields identified in detail using the operation's request 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.",
  "hint": "Correct the fields identified in detail using the operation's request 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.",
  "hint": "Correct the fields identified in detail using the operation's request 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.",
  "hint": "Correct the fields identified in detail using the operation's request 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.",
  "hint": "Correct the fields identified in detail using the operation's request 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.",
  "hint": "Correct the fields identified in detail using the operation's request schema.",
  "instance": "/v1/audits",
  "request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
  "status": 422,
  "title": "Validation Failed",
  "type": "https://api.veriom.ai/problems/validation_failed"
}

Was this guide useful?

Your response stays in this browser unless you open a GitHub issue.
View source

List Structural Remediation Programs

Previous Page

Activate Structural Remediation Program

Next Page