Get zones
Retrieves one or more zone objects.
curl --request GET \
--url https://api.bytio.com/v1/zones/{zone_ids} \
--header 'X-API-KEY: <api-key>'{
"status": "ok",
"info": {
"current": 1,
"allowed": 100
},
"zones": [
{
"zone_id": "1234ABCD",
"name": "My zone",
"network": "datacenter",
"enabled": true,
"alert": {
"type": "dollars_per_day",
"threshold": 500000.5,
"action": "disable_zone",
"last_triggered": "2023-11-07T05:31:56Z"
},
"billing_method": "per_gigabyte",
"ip_type": "shared",
"pool_size": 5000,
"pool_size_actual": 5000,
"exclusivity_type": "non_exclusive",
"domains": [
"<string>"
],
"countries": [
"<string>"
],
"created_on": "2023-11-07T05:31:56Z",
"last_updated": "2023-11-07T05:31:56Z",
"provisioning_status": "provisioning",
"has_standing_charges": true,
"spend_this_month_cents": 123,
"spend_today_cents": 123,
"usage_this_month_bytes": 123,
"usage_today_bytes": 123,
"cost": {
"per_gigabyte_cents": 123,
"per_connection_cents_monthly": 123,
"per_connection_count": 123,
"per_connection_cents_monthly_total": 123,
"ip_pool_count": 123,
"ip_pool_per_ip_cents_monthly": 123,
"ip_pool_cents_monthly_total": 123,
"exclusivity_all_domains_per_ip_cents_monthly": 123,
"exclusivity_all_domains_cents_monthly_total": 123,
"exclusivity_per_domain_count": 123,
"exclusivity_per_domain_per_ip_cents_monthly": 123,
"exclusivity_per_domain_cents_monthly_total": 123,
"standing_charges_cents_monthly": 123
},
"current_thoughput_bps": 123,
"open_connections": 123
}
]
}Authorizations
Path Parameters
A comma-separated list of zone IDs to retrieve (up to 10 in total).
1024Response
ok The ID of the zone.
The name of the zone.
25The proxy network requests to this zone are routed through.
datacenter, mobile, residential Whether the zone is enabled. Disabled zones will not allow any requests to be routed through them.
An object representing the type of alert configured for this zone. If no alert is configured the alert property is absent. Note that the alert object is only visible to users in the admin role.
The trigger condition used to activate the alert.
dollars_per_day, dollars_per_month, gigabytes_per_day, gigabytes_per_month The threshold value, expressed as a number, that must be met for the alert to be triggered. Either dollars or gigabytes depending on the value of the type property.
1 < x < 1000000The action that will be taken when the alert threshold is met.
disable_zone, send_notification, disable_and_send_notification The UTC date and time the alert was last triggered, in ISO 8601 format. If the alert has never been triggered the last_triggered is absent.
The billing method used for the zone.
per_gigabyte, per_connection Set to shared when the shared datacenter network is used or reserved when a custom IP pool is used for this zone.
shared, reserved The number of reserved IPs used in datacenter zone ip_type=reserved.
1 < x < 10000The number of reserved IPs, for a datacenter zone when ip_type is reserved, that are curerntly configured. This may be less then pool_size if the pool size has recently been increased and the zone is still in the provisioning status.
1 < x < 10000The IP pool exclusivity type a datacenter zone is using when ip_type is reserved.
non_exclusive, all, domains When exclusivity_type=domains contains an array of string domain names (i.e. amazon.com) that the IPs in this datacenter zone are exclusive for when ip_type=reserved.
An array of ISO 3166 two-letter country codes representing the available country exit nodes for IPs in the zone.
The date and time the zone was created, in ISO 8601 format.
The date and time the zone was last updated, in ISO 8601 format.
The provisioning status of the zone.
provisioning, provisioned, reprovisioning, deprovisioning, deprovisioned, insufficient_resource, partially_provisioned Set to true when this zone has standing (time-based) charges (such as IP reservations or per-connection billing) or false if this zone is set to purely usage-based billing.
The cost, in cents, of this zone in the current month (i.e. the current billing period). Note that this is expressed as fractional cents. Only present when requested by a user in the admin role.
The cost, in cents, of this zone today (UTC). Note that this is expressed as fractional cents. Only present when requested by a user in the admin role.
The amount of data (download and upload), in bytes, passed through this zone in the current month (i.e. the current billing period).
The amount of data (download and upload), in bytes, passed through this zone today (UTC). Only present when requested by a user in the admin role.
Present when billing_method=per_gigabyte. Returns the cost, in cents, per-gigabyte of data transferred through the zone.
Present when billing_method=per_connection. Returns the cost, in cents per month, for each simultaneous connection allowed through the zone.
Present when billing_method=per_connection. Returns the number of simultaneous connections allowed through the zone.
Present when billing_method=per_connection. Returns the result of per_connection_cents_monthly multipled by per_connection_count.
Present when network=datacenter and ip_type=reserved. Returns the count of the number of IPs in the zones' IP pool.
Present when network=datacenter and ip_type=reserved. Returns the cost, in cents per month, for each IP in the IP pool.
Returns the result of ip_pool_per_ip_cents_monthly multipled by ip_pool_count.
Present when network=datacenter, ip_type=reserved and exclusivity_type=all. Returns the cost, in cents per month per IP, for all-domains exclusivity for the IPs in the zones` IP pool.
Present when network=datacenter, ip_type=reserved and exclusivity_type=all. Returns the result of exclusivity_all_domains_per_ip_cents_monthly multipled by ip_pool_count.
Present when network=datacenter, ip_type=reserved and exclusivity_type=domains. Returns the count of the number of domains for which per-domain exclusivity is configured.
Present when network=datacenter, ip_type=reserved and exclusivity_type=domains. Returns the cost, in cents per month per domain per IP, for specific-domains exclusivity for the IPs in the zones` IP pool.
Present when network=datacenter, ip_type=reserved and exclusivity_type=domains. Returns the result of exclusivity_all_domains_per_ip_cents_monthly multipled by ip_pool_count then multiplied by exclusivity_per_domain_count.
The total standing (i.e. time-based) charges, in cents, for this zone per month. All standing charges are charged per-minute for provisioned zones. If the zone is purely usage-billing-based (for example, using per-gigabyte billing with no reserved IPs) then standing_charges_cents_monthly would be 0.
The current thruput of the zone in bits-per-second.
The current number of open connections currently being made to the zone.
curl --request GET \
--url https://api.bytio.com/v1/zones/{zone_ids} \
--header 'X-API-KEY: <api-key>'{
"status": "ok",
"info": {
"current": 1,
"allowed": 100
},
"zones": [
{
"zone_id": "1234ABCD",
"name": "My zone",
"network": "datacenter",
"enabled": true,
"alert": {
"type": "dollars_per_day",
"threshold": 500000.5,
"action": "disable_zone",
"last_triggered": "2023-11-07T05:31:56Z"
},
"billing_method": "per_gigabyte",
"ip_type": "shared",
"pool_size": 5000,
"pool_size_actual": 5000,
"exclusivity_type": "non_exclusive",
"domains": [
"<string>"
],
"countries": [
"<string>"
],
"created_on": "2023-11-07T05:31:56Z",
"last_updated": "2023-11-07T05:31:56Z",
"provisioning_status": "provisioning",
"has_standing_charges": true,
"spend_this_month_cents": 123,
"spend_today_cents": 123,
"usage_this_month_bytes": 123,
"usage_today_bytes": 123,
"cost": {
"per_gigabyte_cents": 123,
"per_connection_cents_monthly": 123,
"per_connection_count": 123,
"per_connection_cents_monthly_total": 123,
"ip_pool_count": 123,
"ip_pool_per_ip_cents_monthly": 123,
"ip_pool_cents_monthly_total": 123,
"exclusivity_all_domains_per_ip_cents_monthly": 123,
"exclusivity_all_domains_cents_monthly_total": 123,
"exclusivity_per_domain_count": 123,
"exclusivity_per_domain_per_ip_cents_monthly": 123,
"exclusivity_per_domain_cents_monthly_total": 123,
"standing_charges_cents_monthly": 123
},
"current_thoughput_bps": 123,
"open_connections": 123
}
]
}