Risks API

GET /risks

Get Risks

curl --location 'https://kordon-app.com/api/v1/risks/' \
--header 'Authorization: Bearer YOUR-TOKEN' \
--data ''

Example response

{
    "data": [
        {
            "id": "67ed9437-b3ec-4459-a02c-bdb30b4e2a16",
            "assets": [],
            "controls": [],
            "description": "<p>Risk Description</p>",
            "impact": 0,
            "labels": [],
            "manager": {
                "id": "1bccedd9-ade7-42f9-ae6b-6ec7664bb6e4",
                "name": "Maksym"
            },
            "mitigated_impact": 0,
            "mitigated_probability": 0,
            "mitigations": [],
            "owner": {
                "id": "1bccedd9-ade7-42f9-ae6b-6ec7664bb6e4",
                "name": "Maksym"
            },
            "owner_id": "1bccedd9-ade7-42f9-ae6b-6ec7664bb6e4",
            "probability": 0,
            "residual_score": 0,
            "score": 0,
            "state": "acceptable",
            "tasks": [],
            "title": "One risk to rule them all",
            "updated_at": "2024-05-06T15:26:06+00:00"
        }
    ]
}

GET /risks/:id:

curl --location 'https://kordon-app.com/api/v1/risks/67ed9437-b3ec-4459-a02c-bdb30b4e2a16' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--data ''

Example response

Status 200

{
    "data": {
        "id": "67ed9437-b3ec-4459-a02c-bdb30b4e2a16",
        "assets": [],
        "controls": [],
        "description": "<p>Risk description</p>",
        "impact": 0,
        "labels": [],
        "manager": {
            "id": "1bccedd9-ade7-42f9-ae6b-6ec7664bb6e4",
            "name": "Maksym"
        },
        "mitigated_impact": 0,
        "mitigated_probability": 0,
        "mitigations": [],
        "owner": {
            "id": "1bccedd9-ade7-42f9-ae6b-6ec7664bb6e4",
            "name": "Maksym"
        },
        "owner_id": "1bccedd9-ade7-42f9-ae6b-6ec7664bb6e4",
        "probability": 0,
        "residual_score": 0,
        "score": 0,
        "state": "acceptable",
        "tasks": [],
        "title": "One risk to rule them all",
        "updated_at": "2024-05-06T15:26:06+00:00"
    }
}

PATCH /risks/:id:

curl --location --request PATCH 'https://kordon-app.com/api/v1/risks/1a9c9bee-f5de-411d-bbd6-30f7fca37ae6' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--data '{
    "title": "New risk title"
}'

Example response will have the full data of the now updated object.

Status: 200

{
    "data": {
        "id": "1a9c9bee-f5de-411d-bbd6-30f7fca37ae6",
        "assets": [],
        "controls": [],
        "description": "",
        "impact": 0,
        "labels": [],
        "manager": {
            "id": "98dcb717-al70-4c89-8246-0bb026wc215b",
            "name": "Jaana Manana"
        },
        "mitigated_impact": 0,
        "mitigated_probability": 0,
        "mitigations": [],
        "owner": {
            "id": "05wa1387-a987-3cyt-y2df-9e41u8569aed",
            "name": "Martin Lootus"
        },
        "owner_id": "05wa1387-a987-3cyt-y2df-9e41u8569aed",
        "probability": 0,
        "residual_score": 0,
        "score": 0,
        "state": "acceptable",
        "tasks": [],
        "title": "New risk title",
        "updated_at": "2024-08-28T14:52:49+00:00"
    }
}

DELETE /risks/:id:

curl --location --request DELETE 'https://kordon-app.com/api/v1/risks/67ed9437-b3ec-4459-a02c-bdb30b4e2a16' \
--header 'Authorization: Bearer YOUR-TOKEN' \
--data ''

Response of a deletion request will include the id of the just deleted object.

Example response:

Status 200

{
    "data": {
        "id": "67ed9437-b3ec-4459-a02c-bdb30b4e2a16"
    }
}

POST /risks/

Required parameters:

title, manager_id, owner_id

Optional parameters:

impact, probability, description, label_ids

curl --location 'https://kordon-app.com/api/v1/risks/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--data '{
    "title": "Risk title",
    "manager_id": "98dcb717-al70-4c89-8246-0bb026wc215b",
    "owner_id": "05wa1387-a987-3cyt-y2df-9e41u8569aed",
    "impact": 1,
    "probability": 5,
    "label_ids": [],
    "description": "<p>The description</p>"
}'

Example response:

Response of a creation request will include the full data of the created object.

Status 200

{
    "data": {
        "id": "572d56ad-1e9a-4460-85dc-129d2154b06f",
        "assets": [],
        "controls": [],
        "description": "<p>The description</p>",
        "impact": 1,
        "labels": [],
        "manager": {
            "id": "98dcb717-al70-4c89-8246-0bb026wc215b",
            "name": "Jaana Manana"
        },
        "mitigated_impact": 1,
        "mitigated_probability": 5,
        "mitigations": [],
        "owner": {
            "id": "05wa1387-a987-3cyt-y2df-9e41u8569aed",
            "name": "Martin Lootus"
        },
        "owner_id": "05wa1387-a987-3cyt-y2df-9e41u8569aed",
        "probability": 5,
        "residual_score": 5,
        "score": 5,
        "state": "acceptable",
        "tasks": [],
        "title": "Risk title",
        "updated_at": "2024-08-28T14:46:46+00:00"
    }
}