PAparallel-web
Monitor

List Monitors

Changed on

List monitors ordered by creation time, newest first.

Monitors are sorted by created_at descending. limit defaults to 100. Use next_cursor from the response and pass it as cursor to fetch the next page. Pagination ends when next_cursor is absent.

By default only active monitors are returned. Pass status=cancelled or both values to include cancelled monitors.

The legacy Monitor API (/v1alpha/monitors endpoints) is documented under the Monitor (Alpha) tag.

get/v1/monitors

Request

  • Base URL
    https://api.parallel.ai
  • Auth
    API key in header x-api-key

Query parameters

cursorstring nullable

Pagination token from next_cursor in a previous response. Omit to start from the most recently created monitor.

limitinteger nullable

Maximum number of monitors to return. Defaults to 100. Between 1 and 10000.

typestring[] nullable

Filter by monitor type. Pass multiple times to filter by multiple values. Omit to return all types.

statusstring[] nullable

Filter by monitor status. Pass multiple times to filter by multiple values. Defaults to active only.

Response

Paginated list of monitors.

next_cursorstring nullable

Opaque pagination token. Pass as cursor to retrieve the next page. Absent when there are no more pages.

Changes