Network Usage
Access network transfer statistics and current network usage for your UpCloud account. These endpoints provide detailed information about network traffic, quotas, and transfer pool usage.
Get network transfer statistics
Returns network transfer statistics. Maximum window size is 31 days for JSON output. CSV format has no limit and is available by setting the Accept header to text/csv.
Query parameters
- Name
from- Type
- string
- Description
First start time timestamp in RFC 3339 format (UTC). Required.
- Name
to- Type
- string
- Description
Last start time timestamp in RFC 3339 format (UTC). Required.
- Name
accumulate- Type
- string
- Description
Data accumulation in hours or days. Default: day.
Request
curl -X GET "https://api.upcloud.com/1.3/account/network_usage/?from=2020-09-30T22:00:00Z&to=2020-10-01T00:00:00Z&accumulate=hour" \
-u your_username:your_password
Get resource transfer statistics
Returns resource transfer statistics. Maximum window size is 31 days for JSON output. CSV format has no limit.
Query parameters
- Name
from- Type
- string
- Description
Data start timestamp in RFC 3339 format (UTC). Required.
- Name
to- Type
- string
- Description
Data end timestamp in RFC 3339 format (UTC). Required.
- Name
zone- Type
- string
- Description
Get statistics from selected zone(s). Default: all zones.
- Name
resource_id- Type
- string
- Description
Limits search results for given resource (valid UUID).
Request
curl -X GET "https://api.upcloud.com/1.3/account/resource_network_usage/?from=2020-09-07T00:00:00Z&to=2020-09-09T23:59:59Z&accumulate=day" \
-u your_username:your_password
Get current network usage
Returns the latest network transfer pool usage report.
Response content
- Name
accumulated_quota_bytes- Type
- integer
- Description
Accumulated quota in bytes.
- Name
projected_monthly_quota_bytes- Type
- integer
- Description
Projected quota estimation for end of month.
- Name
hourly_quota_increase_bytes- Type
- integer
- Description
Hourly quota incrementation.
- Name
total_sent_bytes- Type
- integer
- Description
Bytes sent so far in an ongoing month.
Request
curl -X GET https://api.upcloud.com/1.3/account/current_network_usage \
-u your_username:your_password