SDK ReferencePython SDK
Monitors
API functions for the Monitors resource.
Monitors
Functions for interacting with the monitors API resource. Each operation ships in four forms — sync / sync_detailed and their async counterparts.
Create Monitor
Create a change-detection monitor
Parameters
body (MonitorCreateRequest)
Call styles
sync_detailed(client, body) -> Response[Error | MonitorResponse]
sync(client, body) -> Error | MonitorResponse | None
await asyncio_detailed(client, body) -> Response[Error | MonitorResponse]
await asyncio(client, body) -> Error | MonitorResponse | NoneDelete Monitor
Cancel monitor
Parameters
id (str)
Call styles
sync_detailed(id, client) -> Response[Any | Error]
sync(id, client) -> Any | Error | None
await asyncio_detailed(id, client) -> Response[Any | Error]
await asyncio(id, client) -> Any | Error | NoneGet Monitor
Get monitor
Parameters
id (str)
Call styles
sync_detailed(id, client) -> Response[Error | MonitorResponse]
sync(id, client) -> Error | MonitorResponse | None
await asyncio_detailed(id, client) -> Response[Error | MonitorResponse]
await asyncio(id, client) -> Error | MonitorResponse | NoneList Monitor Captures
List monitor captures
Parameters
id (str)limit (int | Unset): Default: 25.cursor (str | Unset)
Call styles
sync_detailed(id, client, limit, cursor) -> Response[ListMonitorCapturesResponse200]
sync(id, client, limit, cursor) -> ListMonitorCapturesResponse200 | None
await asyncio_detailed(id, client, limit, cursor) -> Response[ListMonitorCapturesResponse200]
await asyncio(id, client, limit, cursor) -> ListMonitorCapturesResponse200 | NoneList Monitors
List monitors
Parameters
limit (int | Unset): Default: 25.cursor (str | Unset)status (ListMonitorsStatus | Unset): Default: ListMonitorsStatus.ACTIVE.
Call styles
sync_detailed(client, limit, cursor, status) -> Response[ListMonitorsResponse200]
sync(client, limit, cursor, status) -> ListMonitorsResponse200 | None
await asyncio_detailed(client, limit, cursor, status) -> Response[ListMonitorsResponse200]
await asyncio(client, limit, cursor, status) -> ListMonitorsResponse200 | NoneUpdate Monitor
Update monitor
Parameters
id (str)body (MonitorUpdateRequest)
Call styles
sync_detailed(id, client, body) -> Response[Error | MonitorResponse]
sync(id, client, body) -> Error | MonitorResponse | None
await asyncio_detailed(id, client, body) -> Response[Error | MonitorResponse]
await asyncio(id, client, body) -> Error | MonitorResponse | None