checks
GET /api/v1/checks/
List all checks
Request
- Base URLhttps://uptime.com (the document declares no server; this is the origin it was published from)
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
pageinteger
A page number within the paginated result set.
page_sizeinteger
Number of results to return per page.
searchstring
A search term.
ordering'pk' | '-pk' | 'address' | '-address' | 'name' | '-name' | 'monitoring_service_type' | '-monitoring_service_type' | 'created_at' | '-created_at'
Order results by this field.
monitoring_service_type'API' | 'BLACKLIST' | 'CLOUDSTATUS' | 'DNS' | 'FTP' | 'SFTP' | 'GROUP' | 'HEARTBEAT' | 'HTTP' | 'ICMP' | 'IMAP' | 'MALWARE' | 'NTP' | 'PAGESPEED' | 'POP' | 'RUM2' | 'SMTP' | 'SSH' | 'SSL_CERT' | 'TCP' | 'TRANSACTION' | 'UDP' | 'WEBHOOK' | 'WHOIS' | 'RDAP'
Filter by check type.
is_pausedboolean
Filter by paused status.
is_under_maintenanceboolean
Filter for checks currently under maintenance.
state_is_upboolean
Filter by check up/down state.
has_maintenance_scheduleboolean
Filter by checks that have a maintenance schedule.
tagstring
Filter by tag name (can be specified multiple times.)
Response
Example response
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2"
}Changes
No recorded changes to this operation across all 1 revision of this API.