Frameworks API

Frameworks represent compliance standards, regulations, or other standards your organization follows (e.g., ISO 27001, SOC 2, GDPR). In the API, frameworks are referenced as regulations.

POST /regulations/

Create a new framework.

Field	Type	Required	Description
title	string	Yes	The name of the framework.

curl --location 'https://YOUR_KORDON_DOMAIN/api/v1/regulations/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-TOKEN' \
--data '{
    "regulation": {
        "title": "ISO 27001:2022"
    }
}'

Example response:

Status 200

{
    "data": {
        "id": "b698a0ed-ad82-4468-900e-3b6eb3f5eb9b",
        "title": "ISO 27001:2022",
        "created_at": "2024-08-28T14:27:26+00:00",
        "updated_at": "2024-08-28T14:27:26+00:00"
    }
}

---

GET /regulations/:id

Get a single framework by ID.

curl --location --request GET 'https://YOUR_KORDON_DOMAIN/api/v1/regulations/b698a0ed-ad82-4468-900e-3b6eb3f5eb9b' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-TOKEN'

Example response:

Status 200

{
    "data": {
        "id": "b698a0ed-ad82-4468-900e-3b6eb3f5eb9b",
        "title": "ISO 27001:2022",
        "created_at": "2024-08-28T14:27:26+00:00",
        "updated_at": "2024-08-28T14:27:26+00:00"
    }
}

---

GET /regulations/

List all frameworks.

curl --location --request GET 'https://YOUR_KORDON_DOMAIN/api/v1/regulations/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-TOKEN'

Example response:

Status 200

{
    "data": [
        {
            "id": "b698a0ed-ad82-4468-900e-3b6eb3f5eb9b",
            "title": "ISO 27001:2022",
            "created_at": "2024-08-28T14:27:26+00:00",
            "updated_at": "2024-08-28T14:27:26+00:00"
        },
        {
            "id": "023fb404-56f6-49cd-9379-dbf584d2eef8",
            "title": "SOC 2 Type II",
            "created_at": "2024-07-15T10:30:00+00:00",
            "updated_at": "2024-07-15T10:30:00+00:00"
        }
    ],
    "meta": {
        "page": 1,
        "per_page": 25,
        "total_count": 2,
        "total_pages": 1
    }
}

---

PATCH /regulations/:id

Update an existing framework.

Field	Type	Required	Description
title	string	No	The name of the framework.

curl --location --request PATCH 'https://YOUR_KORDON_DOMAIN/api/v1/regulations/b698a0ed-ad82-4468-900e-3b6eb3f5eb9b' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-TOKEN' \
--data '{
    "regulation": {
        "title": "ISO 27001:2022 (Updated)"
    }
}'

Example response:

Status 200

{
    "data": {
        "id": "b698a0ed-ad82-4468-900e-3b6eb3f5eb9b",
        "title": "ISO 27001:2022 (Updated)",
        "created_at": "2024-08-28T14:27:26+00:00",
        "updated_at": "2024-08-29T09:15:00+00:00"
    }
}

---

DELETE /regulations/:id

Delete a framework.

Caution

Deleting a framework will also delete all requirements associated with it. This action cannot be undone.

curl --location --request DELETE 'https://YOUR_KORDON_DOMAIN/api/v1/regulations/b698a0ed-ad82-4468-900e-3b6eb3f5eb9b' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-TOKEN'

Example response:

Status 200

{
    "data": {
        "id": "b698a0ed-ad82-4468-900e-3b6eb3f5eb9b",
        "title": "ISO 27001:2022 (Updated)",
        "deleted": true
    }
}