Server Monitoring

Register a new server for metric tracking by providing details such as service_id, name, description, and timezone. This endpoint creates a server monitoring resource, allowing you to visualize essential system metrics like CPU, memory, and disk usage through charts.

Once configured, the server will begin reporting usage data to your dashboard, giving your team consistent visibility into system activity across different services and environments.

Use cases:

• Infrastructure setup — Quickly onboard new servers and begin tracking system-level metrics without deep configuration.
• Timezone labeling — Assign a timezone to each server so that metric timestamps in visualizations reflect local server time, improving clarity during reviews.
• Visual trend tracking — View how system resource usage evolves over time to assist in capacity planning or basic diagnostics.
  
  

  Authorization: Bearer YOUR_TOKEN

Delete multiple server monitoring resources in a single request by passing their corresponding monitor_ids as query parameters. This bulk operation is ideal for cleaning up inactive, deprecated, or test servers from your monitoring environment.

It simplifies server management by allowing teams to remove several monitored servers at once instead of deleting them individually.

Use cases:

• Infrastructure cleanup — Remove outdated or unused server entries to keep the monitoring dashboard organized and relevant.
• Environment resets — Clear demo or temporary monitors after staging or testing phases.
• Bulk offboarding — When retiring multiple servers or services, use this endpoint to efficiently decommission their monitors.

Authorization: Bearer YOUR_TOKEN

Expected Behavior:

• On success, the specified server monitoring resources will be deleted, and a confirmation message along with the IDs of the deleted resources will be returned.
• If the request is unauthorized or the provided IDs are invalid, an error message will be returned, specifying the issue.

Update an existing server monitoring resource by specifying its monitor_id in the path and submitting the new configuration values in the request body. You can modify properties such as the name, description, or timezone to keep the server's metadata up to date.

This endpoint is helpful for maintaining clear and meaningful labels in your monitoring dashboard, especially when server roles change, descriptions need refinement, or timezone alignment improves data readability.

Use cases:

• Rename monitored servers — Keep server names consistent with their real-world purpose or environment.
• Update descriptions — Add context or notes that make it easier to identify monitored systems during troubleshooting.
• Correct timezone configuration — Ensure metric timestamps align with local server time for easier data interpretation.

To view the current details of a server before updating, use the Get Specific Server Monitor endpoint.

Authorization: Bearer YOUR_TOKEN

Expected Behavior:

• On success, the server resource will be updated, and a confirmation message along with the updated resource ID will be returned.
• If the request is unauthorized or the provided ID is invalid, an error message will be returned, specifying the issue.

Retrieve a complete list of all server monitoring resources associated with a specific service by providing the service_id in the path. This endpoint returns metadata for each registered server, allowing teams to see which servers are actively being monitored under a given service.

Pagination is supported through the limit and page query parameters, making it easier to manage large infrastructures and avoid overloading responses.

Use cases:

• Monitoring overview — View all servers linked to a service in one place for easy review and filtering.
• Infrastructure audits — Confirm which servers are actively tracked, and identify naming, description, or timezone discrepancies.
• Bulk operations support — Use the returned list to trigger updates, cleanups, or batch actions across monitored servers.

Authorization: Bearer YOUR_TOKEN

Retrieve detailed information about a specific server monitoring resource by providing its monitor_id in the path. The response includes metadata such as the server name, description, timezone, and service association, allowing you to review its current configuration.

This endpoint is helpful for inspecting how a server is registered within your monitoring system before performing updates, deletions, or analysis.

Use cases:

• Pre-update verification — Review server details before applying changes using the Update Server Monitor endpoint.
• Metadata auditing — Validate naming, descriptions, or timezone settings across your monitored infrastructure.
• Troubleshooting support — Identify the specific server configuration when investigating metric charts or alerts.

Authorization: Bearer YOUR_TOKEN

Retrieve time-series metric data for a specific server by providing its monitor_id in the path. This endpoint allows you to query server resource usage — such as CPU, memory, disk, or network — across a specified time window.

You can refine the results using query parameters like type (e.g., cpu, memory), start_date, end_date, interval (e.g., on-demand, hourly), and limit to control the resolution and size of the returned dataset.

Use cases:

• Chart rendering — Populate monitoring dashboards with metric visualizations for a selected server and time period.
• Usage trend analysis — Explore how system resource consumption changes over time to assist with capacity planning.
• Spike investigation — Drill into specific intervals to identify periods of high usage or irregular activity.

Authorization: Bearer YOUR_TOKEN