Update a zone
Updates the specified zone by setting the values of the parameters passed in the body of the request. Any parameters not provided will be left unchanged.
Some parameters are nullable and can be unset by passing null as the parameter value. For example, if you pass null for the countries parameter, then the zone will have the countries setting removed.
Updating 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 update operation results in provisioning a larger pool_size in a reserved datacenter zone. In the event of the available account balance being insufficient an HTTP 402 Payment Required response will be returned.
📘 Preview zone changes
To preview changes to a zone before committing them use the
previewquery parameter. Whenpreview=truethe changes to the zone are returned in thezoneresponse object and any associated charges are returned in thecostresponse object, but no changes are actually committed. This is useful todry runchanges to a zone and view their cost impact, before committing to the change.
Authorizations
Path Parameters
The ID of the zone to update.
8Query Parameters
Set to true preview zone changes and associated charges without committing them.
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
The name of the zone.
100The 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).
datacenter, mobile, residential Set to true if the Zone is enabled, false otherwise. Disabled zones will not allow any requests to be routed through them.
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.
The billing method used for the zone.
per_gigabyte, per_connection The number of simultaneous connections allowed when billing_method is set to per_connection.
1 < x < 50000Set to shared`` to use the shared datacenter network or reserved` to configure a custom IP pool.
shared, reserved The number of reserved IPs used in datacenter zones when ip_type is reserved.
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. example.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.
Response
ok 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).