Skip to main content
GET
List monitors

Authorizations

x-api-key
string
header
required

API key for authentication.

Query Parameters

page
integer
default:1

Page number to retrieve.

Required range: x >= 1
page_size
integer
default:100

Number of records per page.

Required range: 1 <= x <= 1000

Filter results by text (case-insensitive substring match).

ownership
enum<string>
default:all

Controls which resources are returned based on ownership.

  • all: Returns resources owned by the user and resources shared with them (default, backward compatible).
  • own: Returns only resources created by the authenticated user.
  • shared: Returns only resources shared with the user by others.
Available options:
all,
own,
shared
project_id
string<uuid>

Filter results to resources belonging to this project.

Response

List of user monitors

total
integer
required

Total number of monitors for this user.

Example:

3

page
integer
required

Current page number.

Example:

1

page_size
integer
required

Number of monitors per page.

Example:

100

total_pages
integer
required

Total number of pages available.

Example:

1

monitors
object[]
required

Array of monitor summaries.