Skip to main content
POST
/
v1
/
incidents
Create incident
curl --request POST \
  --url https://api.intrace.ai/v1/incidents \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "scope": "aggregate",
  "threat_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "status": "open",
  "scope": "investigation",
  "threat_links": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "threat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "added_at": "2023-11-07T05:31:56Z",
      "threat": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "severity": "<string>",
        "threat_type": "<string>",
        "location": "<string>",
        "observed_at": "<string>",
        "coordinates": {
          "lat": 123,
          "lng": 123
        }
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "resolved_at": "2023-11-07T05:31:56Z"
}

Example Request

{
  "title": "Port access disruption in Lagos",
  "description": "Multiple protest and road-closure threats affecting site access.",
  "scope": "aggregate",
  "threat_ids": [
    "4f5d1cc9-d4cc-49a1-a3fc-5ec93d674bc8",
    "4e91fe4c-0f95-43a2-8a1c-b62cc12df5db"
  ]
}

Authorizations

X-API-Key
string
header
required

Body

application/json
title
string
required
description
string
scope
enum<string>
default:aggregate
Available options:
investigation,
aggregate
threat_ids
string<uuid>[]

Response

201 - application/json

Incident created.

id
string<uuid>
required
title
string
required
status
enum<string>
required
Available options:
open,
closed,
resolved
scope
enum<string>
required
Available options:
investigation,
aggregate
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
started_at
string<date-time> | null
resolved_at
string<date-time> | null