Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API Key authentication for programmatic access. Include your API key in the Authorization header as: Bearer your_api_key_here

Path Parameters

slug
string
required
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$

Response

Successful response

id
string<uuid>
required
chatId
string<uuid> | null
required

Caller-owned editor chat on detail responses; always null in catalog rows

revision
string
required
Pattern: ^[0-9a-f]{64}$
name
string | null
required
summary
string | null
required

1–3 sentence plain-prose headline of what the detection is meant to detect. No bullet lists.

description
string | null
required

Operational GitHub-flavored markdown: typically two or three bullets covering the signal and the fire condition

toolNames
string[]
required
mitreTechniqueIds
string[]
required
metadataStatus
enum<string>
required
Available options:
pending,
ready,
failed
librarySlug
string | null
required

Detection library entry this detection was added from, when any

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
publishedVersionId
string<uuid> | null
required
recentHits
object[]
required
feedback
object
required