Skip to main content
GET
/
api
/
v0
/
alerts
Lists all alerts.
curl --request GET \
  --url https://north.sh/api/v0/alerts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "01jh1234abcd5678efgh",
      "name": "Suspicious Login Attempt Detected",
      "name_plain": "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",
      "tlp": "clear",
      "resolution": "<string>",
      "resolution_reasoning_md": "<string>",
      "tags": [],
      "source": {},
      "assignee": {},
      "assignee_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "validated_at": "2023-11-07T05:31:56Z",
      "parent_alert_id": "<string>",
      "comments_count": 0,
      "alert_events_count": 0,
      "child_events_count": 0
    }
  ],
  "current_page": 1,
  "first_page_url": "http://localhost/api/v0/alerts?page=1",
  "from": 1,
  "last_page": 2,
  "last_page_url": "http://localhost/api/v0/alerts?page=2",
  "links": [
    {
      "url": "<string>",
      "label": "<string>",
      "active": true
    }
  ],
  "next_page_url": "http://localhost/api/v0/alerts?page=2",
  "path": "http://localhost/api/v0/alerts",
  "per_page": 15,
  "prev_page_url": "<string>",
  "to": 15,
  "total": 25
}

Authorizations

​
Authorization
string
header
required

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

Response

default - application/json

List of alerts retrieved successfully

​
data
object[]

Array of alerts

​
current_page
integer
Example:

1

​
first_page_url
string
Example:

"http://localhost/api/v0/alerts?page=1"

​
from
integer
Example:

1

​
last_page
integer
Example:

2

​
last_page_url
string
Example:

"http://localhost/api/v0/alerts?page=2"

​
links
object[]
​
next_page_url
string | null
Example:

"http://localhost/api/v0/alerts?page=2"

​
path
string
Example:

"http://localhost/api/v0/alerts"

​
per_page
integer
Example:

15

​
prev_page_url
string | null
​
to
integer
Example:

15

​
total
integer
Example:

25