Api referenceCompliance

List Compliance Libraries

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

GET/v1/compliance/libraries

List Compliance Libraries. 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

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 GET "https://example.com/v1/compliance/libraries"
[
  {
    "description": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "key": "string",
    "license_name": "string",
    "license_url": "string",
    "name": "string",
    "publisher": "string",
    "source_url": "string",
    "versions": [
      {
        "change_summary": "string",
        "content_hash": "string",
        "controls": [
          {
            "control_key": "string",
            "description": "string",
            "domain": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "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",
            "title": "string"
          }
        ],
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "published_at": "2019-08-24T14:15:22Z",
        "status": "string",
        "version": "string"
      }
    ]
  }
]
{
  "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"
}

Update Me

Previous Page

List Compliance Programs

Next Page