account

Get top network usage

Returns the resources with the highest network usage.

get/1.3/account/network_top_usage

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/account/network_top_usage
  • Auth: HTTP bearer

Query parameters

fromstring date-time required

Datetime in RFC 3339 format

Example:2026-07-01T00:00:00Z

Start of the usage period.

tostring date-time required

Datetime in RFC 3339 format

Example:2026-07-01T00:00:00Z

End of the usage period.

service'load_balancer_private' | 'load_balancer_private_vlan' | 'load_balancer_public' | 'network_gateway_private' | 'network_gateway_private_vlan' | 'network_gateway_public' | 'object_storage_v2_private' | 'object_storage_v2_public' | 'server_private' | 'server_private_vlan' | 'server_public'

Network usage type for resource

Filter by service type. Repeat the parameter to include multiple service types.

zonestring

Zone identifier

Example:fi-hel1

Filter by zone. Repeat the parameter to include multiple zones.

accumulate'hour' | 'day'

Usage accumulator hour or day parameter

Accumulation period for the usage statistics.

Response

Top resource network usage statistics.

Example response

{
  "stats": {
    "stat": [
      {
        "resource_id": "00777436-a6f8-43af-9daf-89e8e6833a7a",
        "sent_bytes": 10094,
        "service": "server_public",
        "start_time": "2020-09-07T00:00:00Z",
        "zone": "de-fra1"
      },
      {
        "resource_id": "00777436-a6f8-43af-9daf-89e8e6833a7a",
        "sent_bytes": 35174050,
        "service": "server_public",
        "start_time": "2020-09-08T00:00:00Z",
        "zone": "de-fra1"
      },
      {
        "resource_id": "00777436-a6f8-43af-9daf-89e8e6833a7a",
        "sent_bytes": 32790622,
        "service": "server_public",
        "start_time": "2020-09-09T00:00:00Z",
        "zone": "de-fra1"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.