GET /v2/monitoring/metrics/droplet/bandwidth

To retrieve bandwidth metrics for a given Droplet, send a GET request to /v2/monitoring/metrics/droplet/bandwidth. Use the interface query parameter to specify if the results should be for the private or public interface. Use the direction query parameter to specify if the results should be for inbound or outbound traffic. The metrics in the response body are in megabits per second (Mbps).

Servers

Query parameters

Name Type Required Description
end String Yes

UNIX timestamp to end metric window.

direction String Yes

The traffic direction.

Possible values:

  • "inbound"
  • "outbound"
host_id String Yes

The droplet ID.

interface String Yes

The network interface.

Possible values:

  • "public"
  • "private"
start String Yes

UNIX timestamp to start metric window.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.