Skip to content
Kordoni juhised

Frameworks API

This content is not available in your language yet.

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/

Section titled “POST /regulations/”

Create a new framework.

FieldTypeRequiredDescription
titlestringYesThe name of the framework.
Terminal window
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

Section titled “GET /regulations/:id”

Get a single framework by ID.

Terminal window
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/

Section titled “GET /regulations/”

List all frameworks.

Terminal window
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

Section titled “PATCH /regulations/:id”

Update an existing framework.

FieldTypeRequiredDescription
titlestringNoThe name of the framework.
Terminal window
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

Section titled “DELETE /regulations/:id”

Delete a framework.

Terminal window
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
    }
}