Api referenceCompliance

Create Compliance Program

Reference for Create Compliance Program in the Hyperoru v1 API, including request, response, and authentication details.

POST/v1/workspaces/{workspace_id}/compliance/programs

Create Compliance Program. Returns a typed response and a request ID for operational support.

Authorization

hyperoru_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/compliance/programs" \  -H "Content-Type: application/json" \  -d '{    "framework_version_id": "139edecb-2463-4594-87e7-c57ba3289dfb",    "name": "string"  }'
{
  "adopted_at": "2019-08-24T14:15:22Z",
  "assessments": [
    {
      "applicability": "string",
      "applicability_rationale": "string",
      "architecture_relationship_ids": [
        "string"
      ],
      "calculated_at": "2019-08-24T14:15:22Z",
      "calculation_version": "string",
      "confidence": "string",
      "conflicting_evidence_ids": [
        "string"
      ],
      "control_id": "81e20d46-f0a2-4692-a3cd-ac0ccfe84ea6",
      "control_key": "string",
      "description": "string",
      "domain": "string",
      "evidence_ids": [
        "string"
      ],
      "exception_id": "7419d1f6-afa4-48f0-98a0-347ce0520c6a",
      "finding_ids": [
        "string"
      ],
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "input_hash": "string",
      "mapping_version_id": "242f4584-be82-43c4-8462-0de58bd9e73d",
      "missing_requirement_keys": [
        "string"
      ],
      "overlay_version": 0,
      "rationale": "string",
      "requirements": [
        {
          "description": "string",
          "evidence_kinds": [
            "string"
          ],
          "freshness_days": 0,
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "minimum_evidence": 0,
          "requirement_key": "string",
          "title": "string"
        }
      ],
      "severity": "string",
      "stale_evidence_ids": [
        "string"
      ],
      "status": "string",
      "title": "string"
    }
  ],
  "exceptions": [
    {
      "approved_at": "2019-08-24T14:15:22Z",
      "approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
      "control_id": "81e20d46-f0a2-4692-a3cd-ac0ccfe84ea6",
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
      "decision_reason": "string",
      "evidence_ids": [
        "string"
      ],
      "expires_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "rationale": "string",
      "state": "string",
      "version": 0
    }
  ],
  "framework_id": "4c1c36c9-0232-44b3-bdd8-4bdb3daaf53b",
  "framework_key": "string",
  "framework_name": "string",
  "framework_version": "string",
  "framework_version_id": "139edecb-2463-4594-87e7-c57ba3289dfb",
  "history": [
    {
      "actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
      "created_at": "2019-08-24T14:15:22Z",
      "details": {},
      "event_type": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "version": 0
    }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "next_review_at": "2019-08-24T14:15:22Z",
  "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  "review_cadence_days": 0,
  "scope": {},
  "status": "string",
  "status_counts": {
    "property1": 0,
    "property2": 0
  },
  "version": 0
}
{
  "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.hyperoru.com/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.hyperoru.com/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.hyperoru.com/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.hyperoru.com/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.hyperoru.com/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.hyperoru.com/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.hyperoru.com/problems/validation_failed"
}

List Compliance Programs

Previous Page

Get Compliance Program

Next Page