Zones

Create a zone

Creates a new zone using the parameters passed in the body of the request.

You can also create a zone on the dashboard.

Creating a zone may result in charges being made against your account balance, these charges are detailed in the cost response object. For example, if the create operation results in provisioning a reserved datacenter zone subject to per-IP charges. In the event of the available account balance being insufficient an HTTP 402 Payment Required response will be returned.

📘 Previewing zone charges

To preview any charges required to create the zone use the preview query parameter. When preview=true the proposed new zone is returned in the zone response object and any associated charges are returned in the cost response object, but no changes are actually committed. This is useful to dry run creating a zone and view its` cost impact, before committing to the zone create operation.

POST

zones

Authorizations

X-API-KEY

string

header

required

Query Parameters

preview

boolean

Set to true preview zone changes and associated charges without committing them.

skip_resource_check

boolean

Set to true to skip the resource check and create the zone even if there may be a delay before the zone is available to use (where it enters the "waiting for approval" state), false to only create the zone if the platform has sufficient resources to create it immediately (otherwise an HTTP 202 insufficient_resource_likely response will be returned). Defaults to true if the skip_resource_check parameter is not supplied. For more information see the Docs - https://docs.bytio.com/zones/waiting-for-approval

Body

application/json

alert

object | null

An object representing the type of alert to configure for this zone. To remove the alert for a zone, pass null`` in the value of the alert` property.

billing_method

enum<string>

The billing method used for the zone.

Available options:

per_gigabyte,

per_connection

connection_count

integer

The number of simultaneous connections allowed when billing_method is set to per_connection.

Required range: 1 < x < 50000

countries

string[] | null

An array of ISO 3166 two-letter country codes representing the available country exit nodes for IPs in the zone.

domains

string[]

When exclusivity_type=domains contains an array of string domain names (i.e. example.com) that the IPs in this datacenter zone are exclusive for when ip_type=reserved.

enabled

boolean

Set to true if the Zone is enabled, false otherwise. Disabled zones will not allow any requests to be routed through them.

exclusivity_type

enum<string>

The IP pool exclusivity type a datacenter zone is using when ip_type is reserved.

Available options:

non_exclusive,

all,

domains

ip_type

enum<string>

Set to shared`` to use the shared datacenter network or reserved` to configure a custom IP pool.

Available options:

shared,

reserved

name

string

The name of the zone.

Maximum length: 100

network

enum<string>

The proxy network requests to this zone are routed through. Note that the residential network is not available during the Free Trial (you must Top Up your account to use the Residential network).

Available options:

datacenter,

mobile,

residential

pool_size

integer

The number of reserved IPs used in datacenter zones when ip_type is reserved.

Required range: 1 < x < 10000

Response

200 - application/json

info

object

preview

boolean

Whether the zone has actually been committed to your account, or is just a preview (set to true when the preview=true request parameter is set).

status

enum<string>

Available options:

ok

zone

object

zone.alert

object

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.

zone.billing_method

enum<string>

The billing method used for the zone.

Available options:

per_gigabyte,

per_connection

zone.cost

object

zone.cost.exclusivity_all_domains_cents_monthly_total

integer

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.

zone.cost.exclusivity_all_domains_per_ip_cents_monthly

integer

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.

zone.cost.exclusivity_per_domain_cents_monthly_total

integer

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.

zone.cost.exclusivity_per_domain_count

integer

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.

zone.cost.exclusivity_per_domain_per_ip_cents_monthly

integer

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.

zone.cost.ip_pool_cents_monthly_total

integer

Returns the result of ip_pool_per_ip_cents_monthly multipled by ip_pool_count.

zone.cost.ip_pool_count

integer

Present when network=datacenter and ip_type=reserved. Returns the count of the number of IPs in the zones' IP pool.

zone.cost.ip_pool_per_ip_cents_monthly

integer

Present when network=datacenter and ip_type=reserved. Returns the cost, in cents per month, for each IP in the IP pool.

zone.cost.per_connection_cents_monthly

integer

Present when billing_method=per_connection. Returns the cost, in cents per month, for each simultaneous connection allowed through the zone.

zone.cost.per_connection_cents_monthly_total

integer

Present when billing_method=per_connection. Returns the result of per_connection_cents_monthly multipled by per_connection_count.

zone.cost.per_connection_count

integer

Present when billing_method=per_connection. Returns the number of simultaneous connections allowed through the zone.

zone.cost.per_gigabyte_cents

integer

Present when billing_method=per_gigabyte. Returns the cost, in cents, per-gigabyte of data transferred through the zone.

zone.cost.standing_charges_cents_monthly

integer

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.

zone.countries

string[] | null

An array of ISO 3166 two-letter country codes representing the available country exit nodes for IPs in the zone.

zone.created_on

string

The date and time the zone was created, in ISO 8601 format.

zone.current_thoughput_bps

integer

The current thruput of the zone in bits-per-second.

zone.domains

string[]

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.

zone.enabled

boolean

Whether the zone is enabled. Disabled zones will not allow any requests to be routed through them.

zone.exclusivity_type

enum<string>

The IP pool exclusivity type a datacenter zone is using when ip_type is reserved.

Available options:

non_exclusive,

all,

domains

zone.has_standing_charges

boolean

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.

zone.ip_type

enum<string>

Set to shared when the shared datacenter network is used or reserved when a custom IP pool is used for this zone.

Available options:

shared,

reserved

zone.last_updated

string

The date and time the zone was last updated, in ISO 8601 format.

zone.name

string

The name of the zone.

Maximum length: 25

zone.network

enum<string>

The proxy network requests to this zone are routed through.

Available options:

datacenter,

mobile,

residential

zone.open_connections

integer

The current number of open connections currently being made to the zone.

zone.pool_size

integer

The number of reserved IPs used in datacenter zone ip_type=reserved.

Required range: 1 < x < 10000

zone.pool_size_actual

integer

The 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.

Required range: 1 < x < 10000

zone.provisioning_status

enum<string>

The provisioning status of the zone.

Available options:

provisioning,

provisioned,

reprovisioning,

deprovisioning,

deprovisioned,

insufficient_resource,

partially_provisioned

zone.spend_this_month_cents

number

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.

zone.spend_today_cents

number

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.

zone.usage_this_month_bytes

integer

The amount of data (download and upload), in bytes, passed through this zone in the current month (i.e. the current billing period).

zone.usage_today_bytes

integer

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.

zone.zone_id

string

The ID of the zone.

Search zones Delete multiple zones

Introduction

Zones

Zones IPs

Zone proxy credentials

Users

Account

Plans

Create a zone

Authorizations

Query Parameters

Body

Response