HetrixTools API v3

https://docs.hetrixtools.com/api/v3/
Admin
HetrixTools API v3 is a REST API platform that enables programmatic management of uptime monitoring,...
Tokens:39,196
Snippets:195
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET /contact-lists 200 response example

Source: https://docs.hetrixtools.com/api/v3

Example response body for a successful 200 response from the GET /contact-lists endpoint. Shows the structure of contact_lists array and meta pagination object.

```json
{
  "contact_lists": [
    {
      "id": "stringstringstringstringstringst",
      "name": "string",
      "default": true,
      "email": [
        "string"
      ],
      "phone_sms": [
        "string"
      ],
      "telegram": [
        "string"
      ],
      "pushbullet": [
        "string"
      ],
      "pushover": {
        "key": "string",
        "priority": 0
      },
      "twitter": [
        "string"
      ],
      "slack": {
        "webhook": "string",
        "target": "string",
        "hide_target": true
      },
      "discord": {
        "webhook": "string",
        "target": "string",
        "hide_target": true
      },
      "mattermost_rocketchat": {
        "webhook": "string",
        "target": "string",
        "hide_target": true
      },
      "microsoft_teams": {
        "webhook": "string"
      },
      "pagerduty": {
        "key": "string"
      },
      "opsgenie": {
        "key": "string",
        "priority": "string"
      },
      "victorops": {
        "key": "string",
        "route": "string",
        "priority": "string"
      },
      "webhook": {
        "url": "string",
        "authentication": "string"
      },
      "dnd": [
        {
          "day": "string",
          "hour": "string"
        }
      ]
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "pagination": {
      "current": 0,
      "last": 0,
      "previous": 0,
      "next": 0
    }
  }
}
```

--------------------------------

### GET /schedule-maintenance 200 response example

Source: https://docs.hetrixtools.com/api/v3

Example 200 response body for the GET /schedule-maintenance endpoint. Shows a single scheduled maintenance object with id, monitor_id, start/end timestamps, timezone, notification and recurrence flags, plus the paginated meta object.

```json
{
  "scheduled_maintenances": [
    {
      "id": "abc123def456ghi789jkl012mno345pq",
      "monitor_id": "e34334dt5t755b034606y54ccabe62e8",
      "start": "2025-06-06 10:00",
      "end": "2025-06-06 12:00",
          "timezone": "America/New_York",
      "with_notifications": true,
      "recurring": false,
      "recurring_time": 0,
      "recurring_time_type": ""
    }
  ],
  "meta": {
    "total": 1,
    "total_filtered": 1,
    "returned": 1,
    "pagination": {
      "current": 1,
      "last": 1,
      "previous": null,
      "next": null
    }
  }
}
```

--------------------------------

### GET /account/limits 200 response

Source: https://docs.hetrixtools.com/api/v3

Example 200 response for the GET /account/limits endpoint. Shows usage and limits for uptime monitors, blacklist monitors and API check credits, sub-accounts, SMS credits, account credit balance, and legacy API v1/v2 usage.

```json
{
  "uptime": {
    "monitors": {
      "usage": 12,
      "limit": 50
    }
  },
  "blacklist": {
    "monitors": {
      "usage": 3,
      "limit": 20
    },
    "api_check_credits": {
      "usage": 40,
      "limit": 100,
      "details": {
        "monthly_from_plans": 100,
        "extra_credits": 0
      }
    }
  },
  "sub_accounts": {
    "usage": 1,
    "limit": 5
  },
  "sms_credits": {
    "usage": 2,
    "limit": 50,
    "details": {
      "monthly_from_plans": 50,
      "extra_credits": 0
    }
  },
  "account_credit": {
    "balance": 12.5
  },
  "api_v1_v2": {
    "usage": 300,
    "limit": 1000
  }
}
```

--------------------------------

### Response: Maintenance with notifications

Source: https://docs.hetrixtools.com/api/v3

Example 200 response for maintenance with notifications. The monitor_status is maint when maintenance is enabled with notifications.

```json
{
  "monitor_id": "0123456789abcdef0123456789abcdef",
  "enabled": true,
  "with_notifications": true,
  "monitor_status": "maint"
}
```

--------------------------------

### 200 response for GET /blacklist-monitors/history

Source: https://docs.hetrixtools.com/api/v3

Example 200 response body for the GET /blacklist-monitors/history endpoint. Shows two events with blacklisted and delisted RBL entries, plus meta pagination details. The response is returned when the request succeeds.

```json
{
  "events": [
    {
      "id": "8f14e45fceea167a5a36dedd4bea2543",
      "timestamp": 1790417019,
      "type": "ipv4",
      "target": "203.0.113.1",
      "report_id": "abcdef1234567890abcdef1234567890",
      "monitor": {
        "id": "3f1b14944123c3878d9a372d54c3e003",
        "name": "my-monitor"
      },
      "api_check": false,
      "listed_before": 2,
      "listed_after": 2,
      "blacklisted": [
        {
          "rbl": "b.barracudacentral.org",
          "delist": "http://www.barracudacentral.org/rbl/removal-request/203.0.113.1"
        }
      ],
      "delisted": [
        {
          "rbl": "all.spamrats.com",
          "delist": "http://www.spamrats.com/lookup.php?ip=203.0.113.1"
        }
      ]
    },
    {
      "id": "c9f0f895fb98ab9159f51fd0297e236d",
      "timestamp": 1790330619,
      "type": "ipv4",
      "target": "203.0.113.1",
      "report_id": "abcdef1234567890abcdef1234567890",
      "monitor": {
        "id": "3f1b14944123c3878d9a372d54c3e003",
        "name": "my-monitor"
      },
      "api_check": false,
      "listed_before": 1,
      "listed_after": 2,
      "blacklisted": [
        {
          "rbl": "all.spamrats.com",
          "delist": "http://www.spamrats.com/lookup.php?ip=203.0.113.1"
        }
      ],
      "delisted": []
    }
  ],
  "meta": {
    "total": 2,
    "total_filtered": 2,
    "returned": 2,
    "retention_days": 30,
    "pagination": {
      "current": 1,
      "last": 1,
      "previous": null,
      "next": null
    }
  }
}
```

--------------------------------

### 200 Response for GET /uptime-monitors/{monitor_id}/location-fail-log

Source: https://docs.hetrixtools.com/api/v3

Example response body for a successful 200 request to the Location Fail Log endpoint. Shows the entries array with timestamp, location, and data fields, plus a meta object containing returned, start_timestamp, end_timestamp, and next_page_timestamp.

```json
{
  "entries": [
    {
      "timestamp": 1641909671,
      "location": "London 6",
      "data": "Error 28: Connection timed out after 10001 milliseconds (10001ms)"
    },
    {
      "timestamp": 1641588609,
      "location": "Amsterdam 1",
      "data": "Error 28: Connection timed out after 10001 milliseconds (10001ms)"
    }
  ],
  "meta": {
    "returned": 2,
    "start_timestamp": 1641926870,
    "end_timestamp": 1641588600,
    "next_page_timestamp": 1641588599
  }
}
```

--------------------------------

### GET /uptime-monitors/{monitor_id}/private-notes

Source: https://docs.hetrixtools.com/api/v3

Retrieves the private notes for a specific uptime monitor. Requires the GET Private Notes API-key permission. Returns the stored text, preserving whitespace and newlines, or an empty string when no notes are set.

```APIDOC
## GET /uptime-monitors/{monitor_id}/private-notes

### Description
API call used to get an uptime monitor's private notes. Returns the stored text, preserving whitespace and newlines, or an empty string when no notes are set.

### Method
GET

### Endpoint
https://api.hetrixtools.com/v3/uptime-monitors/{monitor_id}/private-notes

### Authorizations
bearerAuth

### Parameters
#### Path Parameters
- **monitor_id** (string, pattern: ^[A-Za-z0-9]{32}$) - Required - The unique uptime monitor id, which can be found by running the GET - Uptime Monitors API.

### Responses
#### Success Response (200)
- **private_notes** (string) - The monitor's private notes, up to 1024 UTF-8 bytes. Returns an empty string when no notes are set.

#### Response Example
{
  "private_notes": "Production database\nOwner: operations"
}

#### Error Responses
- **400** - Bad Request - API request is invalid or not properly formatted.
- **401** - Unauthorized - Missing or invalid authentication API key (bearer token).
- **403** - Forbidden - Your API key does not have access to perform this request.
- **404** - Not Found - The resource you have requested was not found.
- **429** - Rate Limited - You are performing API requests too frequently.
- **503** - Service Unavailable - A temporary server error prevented the request from completing.
```

--------------------------------

### GET /uptime-monitors/{monitor_id}/downtimes

Source: https://docs.hetrixtools.com/api/v3

Retrieves the downtime entries for a specified uptime monitor. Supports pagination and filtering by start time. Requires bearer authentication.

```APIDOC
## GET /uptime-monitors/{monitor_id}/downtimes

### Description
API call used to get an uptime monitor's Downtimes.

### Method
GET

### Endpoint
https://api.hetrixtools.com/v3/uptime-monitors/{monitor_id}/downtimes

### Authorizations
bearerAuth

### Parameters
#### Path Parameters
- **monitor_id** (string) - Required - The unique uptime monitor id, which can be found by running the GET - Uptime Monitors API.

#### Query Parameters
- **per_page** (integer) - Optional - Number of monitors returned per page. Default: 20. Range: 1 to 200.
- **page** (integer) - Optional - Which page of the paginated results to return. Default: 1. Range: 1 to 10000.
- **start_before** (integer) - Optional - Filter the downtime entries to only those that have started before the specified timestamp. Example: A value of `1641832650` will fetch downtimes that started at and before the timestamp `1641832650`.
- **start_after** (integer) - Optional - The timestamp after which to start scanning for downtime entries. Example: A value of `1641832650` will fetch downtimes that started at and after the timestamp `1641832650`.

### Response
#### Success Response (200)
Successful Response.

##### Response Schema: application/json
- **downtimes** (array of objects) - List of downtime entries.
- **meta** (object) - Metadata about the response.

#### Response Example
```json
{
  "downtimes": [
    {
      "id": "stringstringstringstringstringst",
      "start": 0,
      "end": 0,
      "maintenance": true
    }
  ],
  "meta": {
    "total": 0,
    "total_filtered": 0,
    "returned": 0,
    "pagination": {
      "current": 0,
      "last": 0,
      "previous": 0,
      "next": 0
    }
  }
}
```

#### Error Responses
- **400** - Bad Request - API request is invalid or not properly formatted.
- **401** - Unauthorized - Missing or invalid authentication API key (bearer token).
- **403** - Forbidden - Your API key does not have access to perform this request.
- **429** - Rate Limited - You are performing API requests too frequently.
```

--------------------------------

### GET /uptime-monitors/{monitor_id}/server-agent/processes

Source: https://docs.hetrixtools.com/api/v3

Retrieves the latest running processes snapshot for a specified uptime monitor. The response includes process details and pagination metadata.

```APIDOC
## GET /uptime-monitors/{monitor_id}/server-agent/processes

### Description
API call used to get the latest running processes snapshot collected by an uptime monitor's Server Monitoring Agent. The View Running Processes option must be enabled on the Server Monitoring Agent in order for this data to be collected. The snapshot is refreshed with every agent data post, and this API call will return a `404` response if no recent running processes data is found for the specified monitor.

### Method
GET

### Endpoint
https://api.hetrixtools.com/v3/uptime-monitors/{monitor_id}/server-agent/processes

### Parameters
#### Path Parameters
- **monitor_id** (string, pattern: ^[A-Za-z0-9]{32}$) - Required - The unique uptime monitor id, which can be found by running the GET - Uptime Monitors API.

#### Query Parameters
- **per_page** (integer, range: 1..200) - Optional - Default: 20 - Number of processes returned per page.
- **page** (integer, range: 1..10000) - Optional - Default: 1 - Which page of the paginated results to return.
- **order_by** (string, enum: "cpu", "ram") - Optional - Default: "cpu" - Which usage metric to order the processes by.
- **order** (string, enum: "desc", "asc") - Optional - Default: "desc" - The direction to order the processes in.

### Response
#### Success Response (200)
- **processes** (array of objects) - List of running processes.
- **meta** (object) - Pagination and metadata information.

#### Response Example
```json
{
  "processes": [
    {
      "pid": 1863,
      "ppid": 1,
      "uid": 112,
      "user": "mysql",
      "elapsed": 172800,
      "cpu": 25.75,
      "ram": 17.3,
      "process": "mysqld",
      "command": "/usr/sbin/mysqld"
    },
    {
      "pid": 850,
      "ppid": 1,
      "uid": 0,
      "user": "root",
      "elapsed": 172811,
      "cpu": 1.2,
      "ram": 2.5,
      "process": "fail2ban-server",
      "command": "/usr/bin/python3 /usr/bin/fail2ban-server -xf start"
    }
  ],
  "meta": {
    "total": 132,
    "returned": 2,
    "last_updated": 1641909671,
    "pagination": {
      "current": 1,
      "last": 66,
      "previous": null,
      "next": 2
    }
  }
}
```

#### Error Responses
- **400** - Bad Request - API request is invalid or not properly formatted.
- **401** - Unauthorized - Missing or invalid authentication API key (bearer token).
- **403** - Forbidden - Your API key does not have access to perform this request.
- **404** - Not Found - The resource you have requested was not found.
- **429** - Rate Limited - You are performing API requests too frequently.

### Authorizations
bearerAuth
```

--------------------------------

### Response: Maintenance disabled

Source: https://docs.hetrixtools.com/api/v3

Example 200 response for maintenance disabled. The monitor_status is active and with_notifications is always false when maintenance is disabled.

```json
{
  "monitor_id": "0123456789abcdef0123456789abcdef",
  "enabled": false,
  "with_notifications": false,
  "monitor_status": "active"
}
```

--------------------------------

### GET /blacklist-monitors

Source: https://docs.hetrixtools.com/api/v3

Retrieves blacklist monitors and their details. Supports pagination, filtering by name, target, type, listed status, and sorting.

```APIDOC
## GET /blacklist-monitors

### Description
API call used to get blacklist monitors and their details.

### Method
GET

### Endpoint
https://api.hetrixtools.com/v3/blacklist-monitors

### Authorizations
bearerAuth

### Parameters
#### Query Parameters
- **per_page** (integer, 1..1024, default: 20) - Optional - Number of monitors returned per page.
- **page** (integer, 1..10000, default: 1) - Optional - Which page of the paginated results to return.
- **name** (string, pattern: ^[a-zA-Z0-9 .-]+$) - Optional - Filter results by name (accepts partial or full name).
- **exact_name** (boolean) - Optional - If set to `true`, the `name` filter will perform an exact match on the monitored name; all other filters will be ignored.
- **target** (string, pattern: ^[a-zA-Z0-9.-]+$) - Optional - Filter results by monitored target (accepts partial or full target).
- **exact_target** (boolean) - Optional - If set to `true`, the `target` filter will perform an exact match on the monitored target; all other filters will be ignored.
- **cidr** (integer, 21..32) - Optional - If specified, the `target` filter will be treated as a CIDR range with the specified prefix length and will match all IPs within that range.
- **type** (string, enum: "ipv4", "domain") - Optional - Filter results by monitor type.
- **listed** (boolean) - Optional - Filter results by listed status.
- **order** (string, enum: "asc", "desc") - Optional - Order results ascending or descending.
- **order_by** (string, enum: "name", "target", "listed", "created_at", "last_check") - Optional - Order results by a specific field.

### Response
#### Success Response (200)
- **monitors** (array of objects) - List of blacklist monitors.
- **meta** (object) - Pagination metadata.

#### Response Example
```json
{
  "monitors": [
    {
      "id": "stringstringstringstringstringst",
      "name": "string",
      "type": "ipv4",
      "target": "string",
      "rdns": "string",
      "report_id": "stringstringstringstringstringst",
      "status": "active",
      "contact_lists": ["stringstringstringstringstringst"],
      "listed": [
        {
          "rbl": "string",
          "delist": "string"
        }
      ],
      "created_at": 0,
      "last_check": 0
    }
  ],
  "meta": {
    "total": 0,
    "total_filtered": 0,
    "returned": 0,
    "pagination": {
      "current": 0,
      "last": 0,
      "previous": 0,
      "next": 0
    }
  }
}
```

#### Error Responses
- **400** - Bad Request - API request is invalid or not properly formatted.
- **401** - Unauthorized - Missing or invalid authentication API key (bearer token).
- **403** - Forbidden - Your API key does not have access to perform this request.
- **429** - Rate Limited - You are performing API requests too frequently.

```

--------------------------------

### GET /schedule-maintenance

Source: https://docs.hetrixtools.com/api/v3

Lists all scheduled maintenance windows. Supports pagination and optional filtering by monitor ID. Requires bearer token authentication.

```APIDOC
## GET /schedule-maintenance

### Description
API call used to list all scheduled maintenance windows.

### Method
GET

### Endpoint
https://api.hetrixtools.com/v3/schedule-maintenance

### Parameters
#### Query Parameters
- **per_page** (integer, 1..200) - Optional - Default: 20 - Number of maintenance windows returned per page.
- **page** (integer, 1..10000) - Optional - Default: 1 - Which page of the paginated results to return.
- **monitor_id** (string, 32 characters) - Optional - Filter by uptime monitor ID.

### Authorizations
bearerAuth

### Responses
#### Success Response (200)
- **scheduled_maintenances** (array of objects) - List of scheduled maintenance windows.
- **meta** (object) - Pagination metadata.

#### Response Example
```json
{
  "scheduled_maintenances": [
    {
      "id": "abc123def456ghi789jkl012mno345pq",
      "monitor_id": "e34334dt5t755b034606y54ccabe62e8",
      "start": "2025-06-06 10:00",
      "end": "2025-06-06 12:00",
      "timezone": "America/New_York",
      "with_notifications": true,
      "recurring": false,
      "recurring_time": 0,
      "recurring_time_type": ""
    }
  ],
  "meta": {
    "total": 1,
    "total_filtered": 1,
    "returned": 1,
    "pagination": {
      "current": 1,
      "last": 1,
      "previous": null,
      "next": null
    }
  }
}
```

#### Error Responses
- **400** - Bad Request - API request is invalid or not properly formatted.
- **401** - Unauthorized - Missing or invalid authentication API key (bearer token).
- **403** - Forbidden - Your API key does not have access to perform this request.
- **429** - Rate Limited - You are performing API requests too frequently.

```

--------------------------------

### GET /ping

Source: https://docs.hetrixtools.com/api/v3

API call used to check that the API is available and functioning as expected. It returns a success response with status 'ok' and message 'pong'.

```APIDOC
## GET /ping

### Description
API call used to check that the API is available and functioning as expected.

### Method
GET

### Endpoint
https://api.hetrixtools.com/v3/ping

### Authentication
bearerAuth

### Parameters
None

### Request Example
```
curl -X GET -H "Authorization: Bearer {BEARER_TOKEN}" "https://api.hetrixtools.com/v3/ping"
```

### Response
#### Success Response (200)
- **status** (string) - Always `ok` on a successful response.
- **message** (string) - Always `pong` on a successful response.

#### Response Example
```json
{
  "status": "ok",
  "message": "pong"
}
```

#### Error Responses
- **400** - Bad Request - API request is invalid or not properly formatted.
- **401** - Unauthorized - Missing or invalid authentication API key (bearer token).
- **403** - Forbidden - Your API key does not have access to perform this request.
- **429** - Rate Limited - You are performing API requests too frequently.
- **503** - Service Unavailable - The API is temporarily unavailable; retry shortly.
```

--------------------------------

### Ping Endpoint Successful Response

Source: https://docs.hetrixtools.com/api/v3

Example response for the ping endpoint, showing a successful response with status "ok" and message "pong".

```json
{
  "status": "ok",
  "message": "pong"
}
```

--------------------------------

### Default response without history parameters

Source: https://docs.hetrixtools.com/api/v3

Example response body for the HetrixTools API v3 endpoint. Shows the default response without history parameters, with stats shortened to one point. Includes agent, system, CPU, memory, disk, network, services, port connections, outgoing pings, custom variables, and meta fields.

```json
{
  "agent": {
    "version": "2.4.2",
    "type": "linux",
    "ip_address": "192.0.2.10",
    "date_added": 1757952000
  },
  "system": {
    "hostname": "web-01",
    "operating_system": "Ubuntu 24.04 LTS",
    "kernel": "6.8.0-60-generic",
    "uptime": 172800,
    "reboot_required": false
  },
  "cpu": {
    "model": "Intel Xeon",
    "speed": 2400,
    "sockets": 1,
    "cores": 4,
    "threads": 8
  },
  "memory": {
    "ram_size": 17179869184,
    "swap_size": 2147483648
  },
  "disk": {
    "total_size": 107374182400,
    "disks": [
      {
        "mount": "/",
        "size": 107374182400,
        "used": 34896609280,
        "available": 72477573120,
        "usage_percent": 32.5,
        "io_read": 1048576,
        "io_write": 262144,
        "inodes": 6553600,
        "inodes_used": 524288,
        "raid": null,
        "averages": {
          "last_15m": {
            "io_read": 993280,
            "io_write": 245760,
            "samples": 15
          },
          "last_30m": {
            "io_read": 1101004,
            "io_write": 250880,
            "samples": 30
          },
          "last_60m": {
            "io_read": 1187840,
            "io_write": 229376,
            "samples": 60
          }
        }
      }
    ],
    "drives": [
      {
        "name": "/dev/sda",
        "type": "ssd",
        "model": "Example SSD",
        "serial": "EXAMPLE123",
        "smart_test": "PASSED",
        "wearout_percent": 3,
        "power_on_hours": 2400,
        "power_cycles": 12,
        "unsafe_shutdowns": 0,
        "error_count": 0,
        "error_details": []
      }
    ]
  },
  "network_interfaces": [
    {
      "name": "eth0",
      "net_in": 524288,
      "net_out": 131072,
      "ipv4": [
        "192.0.2.10"
      ],
      "ipv6": [
        "2001:db8::10"
      ]
    }
  ],
  "services": [
    {
      "name": "nginx",
      "status": "online"
    }
  ],
  "port_connections": [
    {
      "port": 443,
      "connections": 12,
      "averages": {
        "last_15m": {
          "connections": 11.8,
          "samples": 15
        },
        "last_30m": {
          "connections": 10.93,
          "samples": 30
        },
        "last_60m": {
          "connections": 9.4,
          "samples": 60
        }
      }
    }
  ],
  "outgoing_pings": [
    {
      "name": "gateway",
      "target": "192.0.2.1",
      "port": null,
      "packet_loss_percent": 0,
      "response_time": 0.25,
      "averages": {
        "last_15m": {
          "packet_loss_percent": 0,
          "response_time": 0.251,
          "samples": 15
        },
        "last_30m": {
          "packet_loss_percent": 0.33,
          "response_time": 0.262,
          "samples": 30
        },
        "last_60m": {
          "packet_loss_percent": 1.2,
          "response_time": 0.301,
          "samples": 60
        }
      }
    }
  ],
  "custom_variables": [
    {
      "name": "queue_depth",
      "value": 3,
      "averages": {
        "last_15m": {
          "value": 2.6,
          "samples": 15
        },
        "last_30m": {
          "value": 4.1,
          "samples": 30
        },
        "last_60m": {
          "value": 4.1,
          "samples": 30
        }
      }
    }
  ],
  "stats": [
    {
      "timestamp": 1789563180,
      "cpu": 12.5,
      "iowait": 0.25,
      "steal": 0,
      "user": 8.5,
      "system": 4,
      "cpu_temp": 42,
      "load_1": 0.35,
      "load_5": 0.42,
      "load_15": 0.5,
      "ram": 45.5,
      "swap": 0,
      "buffered": 2.1,
      "cached": 18.4,
      "disk": 32.5,
      "net_in": 524288,
      "net_out": 131072
    }
  ],
  "meta": {
    "last_updated": 1789563240
  }
}
```

--------------------------------

### GET /uptime-monitors/{monitor_id}/server-agent/warning-policies

Source: https://docs.hetrixtools.com/api/v3

Retrieves the Server Agent warning policies for a specific uptime monitor. The response includes various warning policy objects for different metrics like CPU, RAM, disk, and network usage.

```APIDOC
## GET /uptime-monitors/{monitor_id}/server-agent/warning-policies

### Description
API call used to get an uptime monitor's Server Agent warning policies.

### Method
GET

### Endpoint
https://api.hetrixtools.com/v3/uptime-monitors/{monitor_id}/server-agent/warning-policies

### Parameters
#### Path Parameters
- **monitor_id** (string) - Required - The unique uptime monitor id, which can be found by running the GET - Uptime Monitors API.

### Authorizations
bearerAuth

### Responses
#### Success Response (200)
- **agent_data_warn** (object) - Issue warnings when the server monitoring agent hasn't sent data.
- **cpu_usage_warn** (object) - Issue warnings when cpu usage reaches a threshold.
- **iowait_usage_warn** (object) - Issue warnings when iowait usage reaches a threshold.
- **ram_usage_warn** (object) - Issue warnings when ram usage reaches a threshold.
- **swap_usage_warn** (object) - Issue warnings when swap usage reaches a threshold.
- **disk_usage_warn** (object) - Issue warnings when disk usage reaches a threshold.
- **raid_warn** (object) - Issue warnings RAID status is not completely healthy.
- **drive_errors_warn** (object) - Issue warnings when drive errors reach a threshold.
- **drive_wearout_warn** (object) - Issue warnings when drive wearout reaches a threshold.
- **drive_smart_warn** (object) - Issue warnings when S.M.A.R.T. test fails.
- **network_in_warn** (object) - Issue warnings when inbound usage reaches a threshold.
- **network_out_warn** (object) - Issue warnings when outbound usage reaches a threshold.
- **services_warn** (object) - Issue warnings when a service goes down.

#### Response Example
{
  "agent_data_warn": {
    "enabled": true,
    "threshold": 3,
    "warn_frequency": 5,
    "contact_list": "string"
  },
  "cpu_usage_warn": {
    "enabled": true,
    "threshold": 1,
    "time_frame": 1,
    "warn_frequency": 5,
    "contact_list": "string"
  },
  "iowait_usage_warn": {
    "enabled": true,
    "threshold": 1,
    "time_frame": 1,
    "warn_frequency": 5,
    "contact_list": "string"
  },
  "ram_usage_warn": {
    "enabled": true,
    "threshold": 1,
    "time_frame": 1,
    "warn_frequency": 5,
    "contact_list": "string"
  },
  "swap_usage_warn": {
    "enabled": true,
    "threshold": 1,
    "time_frame": 1,
    "warn_frequency": 5,
    "contact_list": "string"
  },
  "disk_usage_warn": {
    "enabled": true,
    "threshold": 1,
    "time_frame": 1,
    "warn_frequency": 5,
    "contact_list": "string",
    "warn_disks": [
      {
        "id": "stringstringstringstringstringst",
        "enabled": true,
        "mount": "string"
      }
    ]
  },
  "raid_warn": {
    "enabled": true,
    "warn_type": "not_ideal",
    "warn_frequency": 5,
    "contact_list": "string"
  },
  "drive_errors_warn": {
    "enabled": true,
    "threshold": 1,
    "warn_frequency": 5,
    "contact_list": "string"
  },
  "drive_wearout_warn": {
    "enabled": true,
    "threshold": 1,
    "warn_frequency": 5,
    "contact_list": "string"
  },
  "drive_smart_warn": {
    "enabled": true,
    "warn_frequency": 5,
    "contact_list": "string"
  },
  "network_in_warn": {
    "enabled": true,
    "threshold": 1,
    "threshold_type": "kbps",
    "time_frame": 1,
    "warn_frequency": 5,
    "contact_list": "string",
    "warn_nics": [
      {
        "id": "stringstringstringstringstringst",
        "enabled": true,
        "name": "string"
      }
    ]
  },
  "network_out_warn": {
    "enabled": true,
    "threshold": 1,
    "threshold_type": "kbps",
    "time_frame": 1,
    "warn_frequency": 5,
    "contact_list": "string",
    "warn_nics": [
      {
        "id": "stringstringstringstringstringst",
        "enabled": true,
        "name": "string"
      }
    ]
  },
  "services_warn": {
    "enabled": true,
    "warn_frequency": 5,
    "contact_list": "string",
    "warn_services": [
      {
        "id": "stringstringstringstringstringst",
        "enabled": true,
        "name": "string"
      }
    ]
  }
}

#### Error Responses
- **400** - Bad Request - API request is invalid or not properly formatted.
- **401** - Unauthorized - Missing or invalid authentication API key (bearer token).
- **403** - Forbidden - Your API key does not have access to perform this request.
- **404** - Not Found - The resource you have requested was not found.
- **429** - Rate Limited - You are performing API requests too frequently.
```

--------------------------------

### GET /blacklist-monitors/{identifier}/report

Source: https://docs.hetrixtools.com/api/v3

Retrieves the blacklist report for a specific blacklist monitor. The identifier can be the monitor ID, IP address, or hostname. Optionally, a date can be provided to get the report for a specific day.

```APIDOC
## GET /blacklist-monitors/{identifier}/report

### Description
API call used to get the blacklist report for a specific blacklist monitor.

### Method
GET

### Endpoint
https://api.hetrixtools.com/v3/blacklist-monitors/{identifier}/report

### Parameters
#### Path Parameters
- **identifier** (string) - Required - The blacklist monitor identifier; can be the 32 characters long monitor ID, the IP address or the hostname of the blacklist monitor.

#### Query Parameters
- **date** (string) - Optional - Report date in `YYYY-MM-DD` format. Defaults to the current date.

### Response
#### Success Response (200)
- **id** (string) - The unique blacklist monitor ID (32 characters).
- **name** (string) - The blacklist monitor's name.
- **type** (string) - The type of blacklist monitor. Enum: "ipv4" "domain".
- **target** (string) - The monitored target.
- **report_id** (string) - The unique blacklist report ID for this blacklist monitor. Can be used to form the non white-label report URL: `https://hetrixtools.com/report/blacklist/{report_id}/` and the white-label report URL: `https://yourdomain.com/report/blacklist/{report_id}/`.
- **listed** (array of objects) - The array of blacklists that have listed the monitored target on the requested date.

#### Response Example
```json
{
  "id": "3f1b14944123c3878d9a372d54c3e003",
  "name": "my-monitor",
  "type": "ipv4",
  "target": "203.0.113.1",
  "report_id": "abcdef1234567890abcdef1234567890",
  "listed": [
    {
      "rbl": "all.spamrats.com",
      "delist": "http://www.spamrats.com/lookup.php?ip=203.0.113.1"
    },
    {
      "rbl": "b.barracudacentral.org",
      "delist": "http://www.barracudacentral.org/rbl/removal-request/203.0.113.1"
    },
    {
      "rbl": "zen.spamhaus.org",
      "delist": "https://check.spamhaus.org/results/?query=203.0.113.1"
    }
  ]
}
```

#### Error Responses
- **400** - Bad Request - API request is invalid or not properly formatted.
- **401** - Unauthorized - Missing or invalid authentication API key (bearer token).
- **403** - Forbidden - Your API key does not have access to perform this request.
- **404** - Not Found - The resource you have requested was not found.
- **429** - Rate Limited - You are performing API requests too frequently.

### Authorizations
bearerAuth
```

--------------------------------

### Server Agent Metrics API Requests

Source: https://docs.hetrixtools.com/api/v3

Example requests for the Server Agent Metrics endpoint. The first uses the default interval, the second specifies a historical range with a 1-hour interval.

```http
GET /v3/uptime-monitors/{monitor_id}/server-agent/metrics?interval=auto
```

```http
GET /v3/uptime-monitors/{monitor_id}/server-agent/metrics?from=1789552800&to=1789560000&interval=1h
```

--------------------------------

### GET /blacklists 200 response body

Source: https://docs.hetrixtools.com/api/v3

Successful 200 response body for the GET /blacklists endpoint. Contains two arrays, ipv4 and domains, each listing blacklist objects with id, rbl, optional, and ignored fields.

```json
{
  "ipv4": [
    {
      "id": "hostkarma.junkemailfilter.com",
      "rbl": "hostkarma.junkemailfilter.com",
      "optional": false,
      "ignored": false
    },
    {
      "id": "invaluement_sip",
      "rbl": "invaluement SIP",
      "optional": false,
      "ignored": false
    },
    {
      "id": "invaluement_sip_24",
      "rbl": "invaluement SIP/24",
      "optional": false,
      "ignored": false
    },
    {
      "id": "nordspam",
      "rbl": "NordSpam",
      "optional": false,
      "ignored": false
    },
    {
      "id": "ips.backscatterer.org",
      "rbl": "ips.backscatterer.org",
      "optional": false,
      "ignored": false
    }
  ],
  "domains": [
    {
      "id": "dnsbl.spfbl.net",
      "rbl": "dnsbl.spfbl.net",
      "optional": false,
      "ignored": false
    },
    {
      "id": "phishtank",
      "rbl": "PhishTank",
      "optional": false,
      "ignored": false
    },
    {
      "id": "nordspam",
      "rbl": "NordSpam",
      "optional": false,
      "ignored": false
    },
    {
      "id": "hostkarma.junkemailfilter.com",
      "rbl": "hostkarma.junkemailfilter.com",
      "optional": false,
      "ignored": false
    },
    {
      "id": "invaluement_uri",
      "rbl": "invaluement URI",
      "optional": false,
      "ignored": false
    }
  ]
}
```

--------------------------------

### GET /uptime-monitors/{monitor_id}/web-snapshot

Source: https://docs.hetrixtools.com/api/v3

Retrieves the Web Snapshot for a specific downtime of an uptime monitor. Requires a monitor ID and downtime ID, and returns a snapshot object or null if no snapshot is available.

```APIDOC
## GET /uptime-monitors/{monitor_id}/web-snapshot

### Description
API call used to get an uptime monitor's Web Snapshot for a specific downtime. A downtime may not have a Web Snapshot. If no usable snapshot is available, including when capture is pending or has failed, the endpoint returns `200` with `web_snapshot` set to `null`. The screenshot and content URLs include a daily access key; request this endpoint again when you need fresh URLs.

### Method
GET

### Endpoint
https://api.hetrixtools.com/v3/uptime-monitors/{monitor_id}/web-snapshot

### Parameters
#### Path Parameters
- **monitor_id** (string, pattern: ^[A-Za-z0-9]{32}$) - Required - The unique uptime monitor id, which can be found by running the GET - Uptime Monitors API.

#### Query Parameters
- **downtime_id** (string, pattern: ^[A-Za-z0-9]{32}$) - Required - The unique downtime id, which can be found by running the GET - Downtimes API for this monitor. The downtime must belong to the specified monitor. Missing, malformed, unknown, or mismatched downtime ids return `400`.

### Request Example
GET /uptime-monitors/{monitor_id}/web-snapshot?downtime_id={downtime_id}

### Response
#### Success Response (200)
- **web_snapshot** (object or null) - The available Web Snapshot, or `null` when no usable snapshot is available for this downtime. At least one of the screenshot or content URLs is non-null when this object is returned.
  - **captured_at** (integer) - Timestamp when the snapshot was captured.
  - **http_code** (integer) - HTTP status code observed during capture.
  - **screenshot_url** (string) - URL to the screenshot image, includes daily access key.
  - **content_url** (string) - URL to the content text, includes daily access key.

#### Response Example
```json
{
  "web_snapshot": {
    "captured_at": 1641909671,
    "http_code": 503,
    "screenshot_url": "https://ws.hetrix.io/example.png?k=0123456789abcdef0123456789abcdef01234567",
    "content_url": "https://ws.hetrix.io/example.txt?k=0123456789abcdef0123456789abcdef01234567"
  }
}
```

#### Error Responses
- **400** - Bad Request - API request is invalid or not properly formatted.
- **401** - Unauthorized - Missing or invalid authentication API key (bearer token).
- **403** - Forbidden - Your API key does not have access to perform this request.
- **429** - Rate Limited - You are performing API requests too frequently.
- **503** - Service Unavailable - A temporary server error prevented the request from completing.

```
Tokens:
Raw