hello,
Home Page
Overview
Error Handling
Error Handling
Methods
- Account/Auth/
- Account/SSH/Key/
- Billing/Invoice/
- Billing/Payment/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Server/
- Cloud/Template/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/Services/
- Network/DNS/Domain/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/Region/
- Network/Zone/
- Notifications/
- Order/AddOn/
- Product/
- Server/
- Server/VirtualDomain/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Support/Alert/
- Utilities/Info/
- VIP/
- VPN/
API Documentation (API Version v1)
Monitoring/Services/
DESCRIPTION
This section of the API allows for remotely querying service status data for a server, as well as managing monitoring settings.
get
URL:
https://api.liquidweb.com/v1/Monitoring/Services/get
Description:
Get the current monitoring settings for a server.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| can_monitor | An array of a string of text, containing no newlines or other control characters. | |
| enabled | A boolean value (0 or 1). | * Required if:
|
| services | An array of a string of text, containing no newlines or other control characters. | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | |
| unmonitored | A boolean value (0 or 1). | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
monitoringIps
URL:
https://api.liquidweb.com/v1/Monitoring/Services/monitoringIps
Description:
Returns a list of IPs that our monitoring system runs from.
Parameters:
No Values Defined
Returns:
| Field | Type |
|---|---|
| ips | An array of a valid IP address (v4 or v6) or a valid IP address (v4 or v6) with a mask |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
status
URL:
https://api.liquidweb.com/v1/Monitoring/Services/status
Description:
Get the current service status for each monitored service on a server.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| One or more keys matching: a single word, consisting of only letters and digits. | A single word, consisting of only letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
update
URL:
https://api.liquidweb.com/v1/Monitoring/Services/update
Description:
Update service monitoring settings for a server, if they already exist.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| enabled | A boolean value (0 or 1). | |
| services | An array of a string of text, containing no newlines or other control characters. | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| can_monitor | An array of a string of text, containing no newlines or other control characters. | |
| enabled | A boolean value (0 or 1). | * Required if:
|
| services | An array of a string of text, containing no newlines or other control characters. | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | |
| unmonitored | A boolean value (0 or 1). | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
