Paginated alarm instances for a project (requires project admin).

GET

projects

{project_id}

alerts

Error

A valid request URL is required to generate request examples

{
  "data": {
    "alerts": [
      {}
    ]
  },
  "meta": {
    "current_page": 123,
    "items_per_page": 123,
    "total_items": 123,
    "total_pages": 123
  },
  "ok": 1
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

Authorizations

Authorization

string

header

required

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

ORG-ID

string

header

required

Path Parameters

project_id

string<uuid>

required

Query Parameters

page

integer

default:1

Required range: x >= 1

limit

integer

default:10

Required range: 1 <= x <= 100

severity

string

Comma-separated severity labels

fleet

string

Comma-separated fleet (line) UUIDs

device

string

Comma-separated physical device UUIDs

start

string<date-time>

RFC3339 / RFC3339Nano lower bound on opened_at

end

string<date-time>

RFC3339 / RFC3339Nano upper bound on opened_at

Response

Alerts page

data

object

required

Show child attributes

meta

object

required

Pagination metadata for list endpoints (snake_case keys).

Show child attributes

enum<integer>

required

Available options:

1

POST /projects/{project_id}/alerts/{alert_id}/acknowledge

Error

A valid request URL is required to generate request examples

{
  "data": {
    "alerts": [
      {}
    ]
  },
  "meta": {
    "current_page": 123,
    "items_per_page": 123,
    "total_items": 123,
    "total_pages": 123
  },
  "ok": 1
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

{
  "detail": "<string>",
  "message": "<string>",
  "ok": 0
}

Overview

HTTP API

Paginated alarm instances for a project (requires project admin).

Authorizations

Path Parameters

Query Parameters

Response