> ## Documentation Index > Fetch the complete documentation index at: https://docs.advinservers.com/llms.txt > Use this file to discover all available pages before exploring further. # Enable or disable bandwidth pooling for a location > ### Overview Enables or disables bandwidth pooling for a location in the current team. Send `location_id` and `enabled`. With pooling enabled, the team's servers there share one bandwidth allowance. Each team has its own pools, so servers in the account's other teams are not affected. Otherwise, each server is metered separately. Disabling pooling detaches blocks bound to that location, distributes recorded usage back to individual servers and may immediately throttle servers over their limits. Request a preview first. Returns the team's updated figures for every location. ### Permissions Requires the `network.update` (Change networking) permission for the selected team. Resources outside that team return 404. ## OpenAPI ````yaml https://console.advinservers.com/docs/openapi.json patch /bandwidth-blocks/pooling openapi: 3.1.0 info: title: API reference version: 1.0.0 description: >- Use this API to manage your team's servers, networks, backups, and other resources. ## Authentication Create an API key under **API Keys** and send it as a bearer token with every request: ``` Authorization: Bearer {YOUR_API_KEY} Accept: application/json ``` Copy the key when you create it. It cannot be shown again. Revoking a key takes effect immediately. ## Permissions Give each key only the permissions it needs. Every endpoint lists the required permission. Permissions cover servers and other resources in the key's team. ## Team scope A key can access resources in the team selected when it was created. This includes servers, snapshots, backups, firewall groups, images, SSH keys, scripts, networks and addresses. Resources in other teams return `404 Not Found`. Create a separate key for each team. The key determines the team for every request. Legacy keys that had no team are assigned to the account's first owned team. ## Actions that need the panel API keys cannot do the following, even with every permission. Sign in to the panel in a browser to do them: - Create, edit or revoke API keys - Edit the IP groups that restrict API keys - End signed-in sessions - Change two-factor authentication - Change the account's email address - Accept or decline team invitations - Switch or leave a team This keeps a leaked key from widening its own access or locking you out of your account. ## Source IP restrictions A key can be restricted to one or more IP groups. Requests from other addresses are rejected. ## Requests and responses Each endpoint lists its path, query, header, and body parameters. Examples use fictional data. Single records use JSON objects. Collections use JSON arrays unless the endpoint supports pagination. Timestamps use ISO 8601 in UTC. Error responses include `message`. Validation errors also include an `errors` object for each field. Each endpoint lists its status codes. ## Audit log Every API request, including reads, is recorded in the account audit log with the key that made it. servers: - url: https://console.advinservers.com/api/v1/client security: - http: [] tags: - name: Account description: Billing contact details and account setup progress. - name: Account activity description: Actions performed in the current team by people and API keys. - name: Servers description: >- Order and list servers, read their state and resource use, open a console, and control power. - name: Server settings description: >- Rename a server, rebuild it, and change its hardware, media, resolvers and credentials. - name: Backups description: Scheduled server copies stored separately from the server. - name: Snapshots description: >- Take, restore and move server snapshots. Snapshots are kept in snapshot storage that the team buys by the GiB. - name: Firewall groups description: Reusable sets of firewall rules, and the servers they apply to. - name: IP groups description: Reusable source address lists for firewall rules. - name: Server firewall description: >- Read default traffic policies and rules managed outside your firewall groups. - name: IP addresses description: Manage floating IPs and server address assignments. - name: Private networks description: Connect servers over a private network in the same location. - name: Reverse DNS description: Set the hostnames returned by IP address lookups. - name: DDoS protection description: Configure attack filtering for server addresses. - name: Bandwidth description: Buy extra bandwidth and share it between servers or location pools. - name: SSH keys description: Public keys the account can install on a server when it is built. - name: Setup scripts description: Scripts the account can run on a server when it is built. - name: ISO images description: ISO images you have downloaded, and the servers they are mounted on. - name: Server upgrades description: Change an existing server's plan. - name: Checkout description: Choose a payment method and pay for a purchase. - name: Invoices description: View and pay account invoices. - name: Billing description: Manage service renewals, payment methods and account credit. - name: Transfers description: Move resources between teams or transfer ownership. - name: Teams description: Manage the team assigned to your API key. - name: Team members description: Invite people and manage their team access. - name: Team roles description: Define the permissions granted to team members. - name: Team activity description: View actions performed in a team. - name: Support tickets description: >- Open, read, reply to and close support tickets. Tickets belong to the account holder and are not shared with team members. paths: /bandwidth-blocks/pooling: patch: tags: - Bandwidth summary: Enable or disable bandwidth pooling for a location description: >- ### Overview Enables or disables bandwidth pooling for a location in the current team. Send `location_id` and `enabled`. With pooling enabled, the team's servers there share one bandwidth allowance. Each team has its own pools, so servers in the account's other teams are not affected. Otherwise, each server is metered separately. Disabling pooling detaches blocks bound to that location, distributes recorded usage back to individual servers and may immediately throttle servers over their limits. Request a preview first. Returns the team's updated figures for every location. ### Permissions Requires the `network.update` (Change networking) permission for the selected team. Resources outside that team return 404. operationId: bandwidthBlock.updatePooling requestBody: description: >- Send a JSON object containing the fields below. Required fields are marked in the schema. required: true content: application/json: schema: examples: - location_id: 3 enabled: false allOf: - $ref: '#/components/schemas/UpdateBandwidthPoolingRequest' responses: '200': description: The record, as a JSON object. There is no envelope. content: application/json: schema: type: object examples: - location_id: 3 pooling: false pooled_locations: [] pools: - location_id: 3 name: Kansas City, MO region: us_eu region_label: Americas & EMEA pooling: false servers: 2 shaped_servers: 0 base_limit: 10995116277760 usage: 1358993459200 capacity: 12644383719424 covered: 1649267441664 remaining: 11285390260224 blocks: 1 block_bytes_available: 1649267441664 exhausted: false properties: location_id: type: integer description: The city that was switched. examples: - 3 pooling: type: boolean description: Whether it pools now. examples: - false pooled_locations: type: array description: Every city where the team pools, after the change. examples: - [] items: type: integer examples: - 1 pools: type: array description: Every city's figures, as they stand after the change. examples: - - location_id: 3 name: Kansas City, MO region: us_eu region_label: Americas & EMEA pooling: false servers: 2 shaped_servers: 0 base_limit: 10995116277760 usage: 1358993459200 capacity: 12644383719424 covered: 1649267441664 remaining: 11285390260224 blocks: 1 block_bytes_available: 1649267441664 exhausted: false items: $ref: '#/components/schemas/BandwidthPoolData' required: - location_id - pooling - pooled_locations - pools '401': description: >- The key was missing, malformed, revoked, or belongs to an account that no longer exists. content: application/json: schema: type: object properties: message: type: string examples: - Unauthenticated. required: - message '403': description: >- Access denied. Check the key's team, permissions and allowed IP addresses. Some actions, such as managing API keys, require a browser session. The response message explains the reason. content: application/json: schema: type: object properties: message: type: string examples: - >- This API key is not allowed to do that in this team. It needs the "snapshot.delete" permission. required: - message '422': description: >- A field is missing or invalid, or the resource cannot accept this change in its current state. Check `message` for details. Field validation also includes an `errors` object keyed by field name. content: application/json: schema: type: object properties: message: type: string description: >- A summary of the validation error or the reason the change was refused. examples: - The name field is required. errors: type: object description: Validation errors grouped by field name. additionalProperties: type: array items: type: string required: - message '429': description: >- Too many requests. The `Retry-After` header says how many seconds to wait. Limits are per account, so several keys on one account share them. content: application/json: schema: type: object properties: message: type: string examples: - Too Many Attempts. required: - message components: schemas: UpdateBandwidthPoolingRequest: type: object examples: - location_id: 3 enabled: false properties: location_id: type: integer description: The location id ID. enabled: type: boolean description: The value of `enabled`. required: - location_id - enabled title: UpdateBandwidthPoolingRequest BandwidthPoolData: type: object description: What one team's transfer looks like in one city. examples: - location_id: 3 name: Kansas City, MO region: us_eu region_label: Americas & EMEA pooling: false servers: 2 shaped_servers: 0 base_limit: 10995116277760 usage: 1358993459200 capacity: 12644383719424 covered: 1649267441664 remaining: 11285390260224 blocks: 1 block_bytes_available: 1649267441664 exhausted: false properties: location_id: type: integer description: The location id ID. examples: - 3 name: type: string description: The name shown to customers. examples: - Kansas City, MO region: type: string description: The value of `region`. enum: - us_eu - apac examples: - us_eu region_label: type: string description: The value of `region_label`. examples: - Americas & EMEA pooling: type: boolean description: >- Whether the team's servers here share one budget or are metered one by one. examples: - false servers: type: integer description: The value of `servers`. examples: - 2 shaped_servers: type: integer description: The value of `shaped_servers`. examples: - 0 base_limit: type: integer description: What the plans alone allow here, in bytes. examples: - 10995116277760 usage: type: integer description: The value of `usage`. examples: - 1358993459200 capacity: type: integer description: The budget in force, plans and blocks together. examples: - 12644383719424 covered: type: integer description: How much of that budget the team's blocks are responsible for. examples: - 1649267441664 remaining: type: integer description: The value of `remaining`. examples: - 11285390260224 blocks: type: integer description: The value of `blocks`. examples: - 1 block_bytes_available: type: integer description: The value of `block_bytes_available`. examples: - 1649267441664 exhausted: type: boolean description: >- With pooling on, the whole city at once. With it off, whether at least one server here has been shaped. examples: - false required: - location_id - name - region - region_label - pooling - servers - shaped_servers - base_limit - usage - capacity - covered - remaining - blocks - block_bytes_available - exhausted title: BandwidthPoolData securitySchemes: http: type: http description: >- Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request. scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.