v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Threats

Create Threat

Use this API to create a new threat in the Threat Library.

post/api/controls/v1/threats

Request body

orgGroupIdstring uuid required

Organization Group Identifier of Threat.

identifierstring required

String Identifier of Threat.

namestring required

Threat Name.

descriptionstring

Description of the Threat.

status'Active' | 'Pending' | 'Archived'

Threat Status.

attributesobject

Custom attributes associated with this threat, organized as a map of attribute names to their values.

Example request

{
  "orgGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "identifier": "THREAT-2025-001",
  "name": "Data Exfiltration Through Insecure Communication Channels",
  "description": "This threat involves the unauthorized transfer of data from a device or network to an external destination through insecure channels.",
  "framework": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "ISO 27001",
    "nameKey": "framework.key.iso"
  },
  "category": {
    "name": "Financial Category",
    "nameKey": "IM.FinancialCategoryName"
  },
  "status": "Active"
}

Response

Created

idstring uuid required

Primary identifier of the created or updated entity, typically a UUID.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}