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

# List bandwidth blocks

> ### Overview

Lists bandwidth blocks in the current team, newest first. Includes active blocks and pending purchases with `status_label` and `progress_message`. Blocks under billing review or with no remaining bandwidth are omitted. `totals` summarizes the listed blocks. `pooled_locations` lists the locations where the current team's servers share an allowance.

### Permissions

Requires the `network.read` (View networking) permission for the selected team. Resources outside that team return 404.



## OpenAPI

````yaml https://console.advinservers.com/docs/openapi.json get /bandwidth-blocks
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:
    get:
      tags:
        - Bandwidth
      summary: List bandwidth blocks
      description: >-
        ### Overview


        Lists bandwidth blocks in the current team, newest first. Includes
        active blocks and pending purchases with `status_label` and
        `progress_message`. Blocks under billing review or with no remaining
        bandwidth are omitted. `totals` summarizes the listed blocks.
        `pooled_locations` lists the locations where the current team's servers
        share an allowance.


        ### Permissions


        Requires the `network.read` (View networking) permission for the
        selected team. Resources outside that team return 404.
      operationId: bandwidthBlock.list
      responses:
        '200':
          description: The record, as a JSON object. There is no envelope.
          content:
            application/json:
              schema:
                type: object
                examples:
                  - items:
                      - uuid: 23653478-238e-4db3-b263-91a221b5e7c2
                        region: us_eu
                        region_label: Americas & EMEA
                        size: 2199023255552
                        consumed: 549755813888
                        remaining: 1649267441664
                        terabytes: 2
                        status: active
                        status_label: Active
                        progress_message: null
                        needs_funds: false
                        assignment: servers
                        servers:
                          - id: 304e1794
                            uuid: 304e1794-a5b7-41f2-9a20-c0d444eb6683
                            name: sector-c-db
                            hostname: sector-c-db.blackmesa.example.com
                            template_name: Debian 13
                            template_icon_url: https://img.icons8.com/color/48/debian.png
                            windows: false
                            address: 203.0.113.57
                            location: Kansas City, MO
                        servers_in_other_teams: 0
                        attachable_servers: 1
                        location: null
                        unit_price: '1.00'
                        billing:
                          service_id: null
                          invoice_id: 17853
                          invoice_url: null
                          checkout_uuid: null
                          invoice_status: Paid
                          amount: '2.00'
                          currency: USD
                          billing_cycle: null
                          payment_due_at: null
                          payment_window_minutes: 30
                          paid_at: '2026-08-20T11:26:19+00:00'
                        can_cancel: true
                        created_at: '2026-08-20T11:26:14+00:00'
                        cancellation_refund: '1.50'
                        refund_amount: null
                        refund_pending: false
                    totals:
                      blocks: 1
                      size: 2199023255552
                      consumed: 549755813888
                      remaining: 1649267441664
                      pending: 0
                      by_region:
                        us_eu:
                          label: Americas & EMEA
                          blocks: 1
                          size: 2199023255552
                          remaining: 1649267441664
                        apac:
                          label: APAC
                          blocks: 0
                          size: 0
                          remaining: 0
                    pooled_locations: []
                properties:
                  items:
                    type: array
                    description: >-
                      The blocks themselves. Every byte figure is a plain byte
                      count.
                    examples:
                      - - uuid: 23653478-238e-4db3-b263-91a221b5e7c2
                          region: us_eu
                          region_label: Americas & EMEA
                          size: 2199023255552
                          consumed: 549755813888
                          remaining: 1649267441664
                          terabytes: 2
                          status: active
                          status_label: Active
                          progress_message: null
                          needs_funds: false
                          assignment: servers
                          servers:
                            - id: 304e1794
                              uuid: 304e1794-a5b7-41f2-9a20-c0d444eb6683
                              name: sector-c-db
                              hostname: sector-c-db.blackmesa.example.com
                              template_name: Debian 13
                              template_icon_url: https://img.icons8.com/color/48/debian.png
                              windows: false
                              address: 203.0.113.57
                              location: Kansas City, MO
                          servers_in_other_teams: 0
                          attachable_servers: 1
                          location: null
                          unit_price: '1.00'
                          billing:
                            service_id: null
                            invoice_id: 17853
                            invoice_url: null
                            checkout_uuid: null
                            invoice_status: Paid
                            amount: '2.00'
                            currency: USD
                            billing_cycle: null
                            payment_due_at: null
                            payment_window_minutes: 30
                            paid_at: '2026-08-20T11:26:19+00:00'
                          can_cancel: true
                          created_at: '2026-08-20T11:26:14+00:00'
                          cancellation_refund: '1.50'
                          refund_amount: null
                          refund_pending: false
                    items:
                      $ref: '#/components/schemas/BandwidthBlockData'
                  totals:
                    description: The same rows added up, overall and by region.
                    examples:
                      - blocks: 1
                        size: 2199023255552
                        consumed: 549755813888
                        remaining: 1649267441664
                        pending: 0
                        by_region:
                          us_eu:
                            label: Americas & EMEA
                            blocks: 1
                            size: 2199023255552
                            remaining: 1649267441664
                          apac:
                            label: APAC
                            blocks: 0
                            size: 0
                            remaining: 0
                    allOf:
                      - $ref: '#/components/schemas/BandwidthTotalsData'
                  pooled_locations:
                    type: array
                    description: >-
                      The ids of the cities where the current team's servers
                      share one budget.
                    examples:
                      - []
                    items:
                      type: integer
                      examples:
                        - 1
                required:
                  - items
                  - totals
                  - pooled_locations
        '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
        '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:
    BandwidthBlockData:
      type: object
      description: A purchased or granted bandwidth allowance.
      examples:
        - uuid: 23653478-238e-4db3-b263-91a221b5e7c2
          region: us_eu
          region_label: Americas & EMEA
          size: 2199023255552
          consumed: 549755813888
          remaining: 1649267441664
          terabytes: 2
          status: active
          status_label: Active
          progress_message: null
          needs_funds: false
          assignment: servers
          servers:
            - id: 304e1794
              uuid: 304e1794-a5b7-41f2-9a20-c0d444eb6683
              name: sector-c-db
              hostname: sector-c-db.blackmesa.example.com
              template_name: Debian 13
              template_icon_url: https://img.icons8.com/color/48/debian.png
              windows: false
              address: 203.0.113.57
              location: Kansas City, MO
          servers_in_other_teams: 0
          attachable_servers: 1
          location: null
          unit_price: '1.00'
          billing:
            service_id: null
            invoice_id: 17853
            invoice_url: null
            checkout_uuid: null
            invoice_status: Paid
            amount: '2.00'
            currency: USD
            billing_cycle: null
            payment_due_at: null
            payment_window_minutes: 30
            paid_at: '2026-08-20T11:26:19+00:00'
          can_cancel: true
          created_at: '2026-08-20T11:26:14+00:00'
          cancellation_refund: '1.50'
          refund_amount: null
          refund_pending: false
      properties:
        uuid:
          type: string
          description: The uuid UUID.
          examples:
            - 23653478-238e-4db3-b263-91a221b5e7c2
        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
        size:
          type: integer
          description: The value of `size`.
          examples:
            - 2199023255552
        consumed:
          type: integer
          description: The value of `consumed`.
          examples:
            - 549755813888
        remaining:
          type: integer
          description: The value of `remaining`.
          examples:
            - 1649267441664
        terabytes:
          type: integer
          description: The value of `terabytes`.
          examples:
            - 2
        status:
          type: string
          description: The value of `status`.
          enum:
            - pending_payment
            - active
            - expired
            - cancelled
            - payment_review
            - revoked
          examples:
            - active
        status_label:
          type: string
          description: The value of `status_label`.
          examples:
            - Active
        progress_message:
          type:
            - string
            - 'null'
          description: >-
            One sentence about why a purchase is waiting, most often how much
            the account is short by. Null once there is nothing to say.
          examples:
            - null
        needs_funds:
          type: boolean
          description: Whether the purchase is waiting for enough account credit.
          examples:
            - false
        assignment:
          type: string
          description: Whether the block is assigned to individual servers or a city.
          examples:
            - servers
        servers:
          type: array
          description: The value of `servers`.
          examples:
            - - id: 304e1794
                uuid: 304e1794-a5b7-41f2-9a20-c0d444eb6683
                name: sector-c-db
                hostname: sector-c-db.blackmesa.example.com
                template_name: Debian 13
                template_icon_url: https://img.icons8.com/color/48/debian.png
                windows: false
                address: 203.0.113.57
                location: Kansas City, MO
          items:
            $ref: '#/components/schemas/BandwidthBlockServerData'
        servers_in_other_teams:
          type: integer
          description: >-
            The rest of what it covers, counted rather than named. Nought for
            the account holder, who is shown every one of them, and for anyone
            else not standing inside a single team.
          examples:
            - 0
        attachable_servers:
          type:
            - integer
            - 'null'
          description: >-
            How many of the account's servers this block could still be put
            behind: metered, in the region it was bought for, and not already
            covered by it. Null where it was not counted, which is not the same
            as none.
          examples:
            - 1
        location:
          description: The value of `location`.
          examples:
            - null
          anyOf:
            - $ref: '#/components/schemas/BandwidthBlockLocationData'
            - type: 'null'
        unit_price:
          type: string
          description: The value of `unit_price`.
          examples:
            - '1.00'
        billing:
          $ref: '#/components/schemas/BillingData'
          description: The value of `billing`.
          examples:
            - service_id: null
              invoice_id: 17853
              invoice_url: null
              checkout_uuid: null
              invoice_status: Paid
              amount: '2.00'
              currency: USD
              billing_cycle: null
              payment_due_at: null
              payment_window_minutes: 30
              paid_at: '2026-08-20T11:26:19+00:00'
        can_cancel:
          type: boolean
          description: Whether the customer can cancel.
          examples:
            - true
        created_at:
          type:
            - string
            - 'null'
          description: The date and time for created at, in UTC.
          examples:
            - '2026-08-20T11:26:14+00:00'
        cancellation_refund:
          type: string
          description: The value of `cancellation_refund`.
          examples:
            - '1.50'
        refund_amount:
          type:
            - string
            - 'null'
          description: The value of `refund_amount`.
          examples:
            - null
        refund_pending:
          type: boolean
          description: The value of `refund_pending`.
          examples:
            - false
      required:
        - uuid
        - region
        - region_label
        - size
        - consumed
        - remaining
        - terabytes
        - status
        - status_label
        - progress_message
        - needs_funds
        - assignment
        - servers
        - servers_in_other_teams
        - attachable_servers
        - location
        - unit_price
        - billing
        - can_cancel
        - created_at
        - cancellation_refund
        - refund_amount
        - refund_pending
      title: BandwidthBlockData
    BandwidthTotalsData:
      type: object
      description: >-
        The headline figures for the whole account: what is usable now, and what
        is still being paid for.
      examples:
        - blocks: 1
          size: 2199023255552
          consumed: 549755813888
          remaining: 1649267441664
          pending: 0
          by_region:
            us_eu:
              label: Americas & EMEA
              blocks: 1
              size: 2199023255552
              remaining: 1649267441664
            apac:
              label: APAC
              blocks: 0
              size: 0
              remaining: 0
      properties:
        blocks:
          type: integer
          description: The value of `blocks`.
          examples:
            - 1
        size:
          type: integer
          description: The value of `size`.
          examples:
            - 2199023255552
        consumed:
          type: integer
          description: The value of `consumed`.
          examples:
            - 549755813888
        remaining:
          type: integer
          description: The value of `remaining`.
          examples:
            - 1649267441664
        pending:
          type: integer
          description: >-
            Purchases still awaiting payment, which are no part of the totals
            above.
          examples:
            - 0
        by_region:
          description: The value of `by_region`.
          examples:
            - us_eu:
                label: Americas & EMEA
                blocks: 1
                size: 2199023255552
                remaining: 1649267441664
              apac:
                label: APAC
                blocks: 0
                size: 0
                remaining: 0
          anyOf:
            - type: object
              additionalProperties:
                $ref: '#/components/schemas/BandwidthRegionTotalsData'
            - type: array
              items: {}
              maxItems: 0
      required:
        - blocks
        - size
        - consumed
        - remaining
        - pending
        - by_region
      title: BandwidthTotalsData
    BandwidthBlockServerData:
      type: object
      description: A server covered by a bandwidth block.
      examples:
        - id: 304e1794
          uuid: 304e1794-a5b7-41f2-9a20-c0d444eb6683
          name: sector-c-db
          hostname: sector-c-db.blackmesa.example.com
          template_name: Debian 13
          template_icon_url: https://img.icons8.com/color/48/debian.png
          windows: false
          address: 203.0.113.57
          location: Kansas City, MO
      properties:
        id:
          type: string
          description: The id ID.
          examples:
            - 304e1794
        uuid:
          type: string
          description: The uuid UUID.
          examples:
            - 304e1794-a5b7-41f2-9a20-c0d444eb6683
        name:
          type: string
          description: The name shown to customers.
          examples:
            - sector-c-db
        hostname:
          type: string
          description: The fully qualified hostname.
          examples:
            - sector-c-db.blackmesa.example.com
        template_name:
          type:
            - string
            - 'null'
          description: >-
            What a badge or a picker paints the machine with, the same as the
            dashboard.
          examples:
            - Debian 13
        template_icon_url:
          type:
            - string
            - 'null'
          description: The value of `template_icon_url`.
          examples:
            - https://img.icons8.com/color/48/debian.png
        windows:
          type: boolean
          description: The value of `windows`.
          examples:
            - false
        address:
          type:
            - string
            - 'null'
          description: >-
            The machine's primary IPv4, so a picker names it the way a customer
            does.
          examples:
            - 203.0.113.57
        location:
          type:
            - string
            - 'null'
          description: The city it sits in, or null when its location is unknown.
          examples:
            - Kansas City, MO
      required:
        - id
        - uuid
        - name
        - hostname
        - template_name
        - template_icon_url
        - windows
        - address
        - location
      title: BandwidthBlockServerData
    BandwidthBlockLocationData:
      type: object
      description: The city whose shared pool a block is feeding.
      examples:
        - id: 3
          name: Kansas City, MO
      properties:
        id:
          type: integer
          description: The id ID.
          examples:
            - 3
        name:
          type: string
          description: The name shown to customers.
          examples:
            - Kansas City, MO
      required:
        - id
        - name
      title: BandwidthBlockLocationData
    BillingData:
      type: object
      description: >-
        The billing details shared by customer-owned resources and pending
        orders.
      examples:
        - service_id: 7312
          invoice_id: 15542
          invoice_url: null
          checkout_uuid: null
          invoice_status: Paid
          amount: '12.00'
          currency: USD
          billing_cycle: monthly
          payment_due_at: null
          payment_window_minutes: null
          paid_at: '2026-03-02T19:13:58+00:00'
      properties:
        service_id:
          type:
            - integer
            - 'null'
          description: The customer's service number, once a recurring service exists.
          examples:
            - 7312
        invoice_id:
          type:
            - integer
            - 'null'
          description: The customer's invoice number, once an invoice exists.
          examples:
            - 15542
        invoice_url:
          type:
            - string
            - 'null'
          description: A complete URL where the invoice can be paid.
          examples:
            - null
        checkout_uuid:
          type:
            - string
            - 'null'
          description: The checkout UUID, or null when no checkout is available.
          examples:
            - null
        invoice_status:
          type:
            - string
            - 'null'
          description: The current invoice status, or null before an invoice exists.
          examples:
            - Paid
        amount:
          type:
            - string
            - 'null'
          description: The amount in the currency shown by `currency`.
          examples:
            - '12.00'
        currency:
          type:
            - string
            - 'null'
          description: The three-letter currency code used for `amount`.
          examples:
            - USD
        billing_cycle:
          type:
            - string
            - 'null'
          description: How often the service renews, or null for a one-time charge.
          examples:
            - monthly
        payment_due_at:
          type:
            - string
            - 'null'
          description: When payment is due before the reservation is released.
          examples:
            - null
        payment_window_minutes:
          type:
            - integer
            - 'null'
          description: How many minutes the original payment window allowed.
          examples:
            - null
        paid_at:
          type:
            - string
            - 'null'
          description: When the charge was paid, or null while payment is outstanding.
          examples:
            - '2026-03-02T19:13:58+00:00'
      required:
        - service_id
        - invoice_id
        - invoice_url
        - checkout_uuid
        - invoice_status
        - amount
        - currency
        - billing_cycle
        - payment_due_at
        - payment_window_minutes
        - paid_at
      title: BillingData
    BandwidthRegionTotalsData:
      type: object
      description: What the account holds in one billing region.
      examples:
        - label: Americas & EMEA
          blocks: 1
          size: 2199023255552
          remaining: 1649267441664
      properties:
        label:
          type: string
          description: A short label shown to customers.
          examples:
            - Americas & EMEA
        blocks:
          type: integer
          description: The value of `blocks`.
          examples:
            - 1
        size:
          type: integer
          description: The value of `size`.
          examples:
            - 2199023255552
        remaining:
          type: integer
          description: The value of `remaining`.
          examples:
            - 1649267441664
      required:
        - label
        - blocks
        - size
        - remaining
      title: BandwidthRegionTotalsData
  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.