Skip to main content
POST
/
api
/
v1
/
{source}
/
alerts
Creates a new alert
curl --request POST \
  --url https://north.sh/api/v1/{source}/alerts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Suspicious Login Attempt Detected",
  "summary": "Multiple failed login attempts from unknown IP address",
  "description": "User account experienced 15 failed login attempts from IP 192.168.1.100 within a 5-minute window.",
  "severity": "high",
  "status": "open"
}
'
{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "The name field is required."
    ],
    "severity": [
      "The severity field is required."
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
source
string
required

Body

application/json

Alert creation data

​
name
string
required

The name/title of the alert

Example:

"Suspicious Login Attempt Detected"

​
summary
string
required

A brief summary of the alert

Example:

"Multiple failed login attempts from unknown IP address"

​
description
string
required

Detailed description of the alert

Example:

"User account experienced 15 failed login attempts from IP 192.168.1.100 within a 5-minute window."

​
severity
enum<string>
required

Severity level of the alert

Available options:
critical,
high,
medium,
low,
info
Example:

"high"

​
status
enum<string>
required

Current status of the alert

Available options:
open,
in_progress,
closed
Example:

"open"

Response

Validation error

​
message
string
Example:

"The given data was invalid."

​
errors
object
Example:
{
  "name": ["The name field is required."],
  "severity": ["The severity field is required."]
}