> ## 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 floating IPs

> ### Overview

Lists floating IP addresses in the current team across all locations, including unassigned addresses. `limits` reports usage and allowances for each IP family across the whole account. `sellable` indicates whether IPv4 and IPv6 addresses are available to purchase.

### 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 /floating-ips
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:
  /floating-ips:
    get:
      tags:
        - IP addresses
      summary: List floating IPs
      description: >-
        ### Overview


        Lists floating IP addresses in the current team across all locations,
        including unassigned addresses. `limits` reports usage and allowances
        for each IP family across the whole account. `sellable` indicates
        whether IPv4 and IPv6 addresses are available to purchase.


        ### Permissions


        Requires the `network.read` (View networking) permission for the
        selected team. Resources outside that team return 404.
      operationId: floatingIp.list
      responses:
        '200':
          description: The record, as a JSON object. There is no envelope.
          content:
            application/json:
              schema:
                type: object
                examples:
                  - items:
                      - uuid: 1b8349e5-3568-43e0-bf89-fc3350dd7a08
                        uuid_short: 1b8349e5
                        status: active
                        status_label: Active
                        progress_message: null
                        needs_funds: false
                        type: ipv4
                        address: 198.51.100.42
                        cidr: 24
                        gateway: 198.51.100.1
                        onlink: null
                        is_primary: false
                        location: Kansas City, MO
                        location_id: 3
                        is_granted: false
                        can_release: false
                        billing:
                          service_id: 7421
                          invoice_id: 17214
                          invoice_url: null
                          checkout_uuid: null
                          invoice_status: Paid
                          amount: '3.00'
                          currency: USD
                          billing_cycle: monthly
                          payment_due_at: null
                          payment_window_minutes: null
                          paid_at: '2026-06-20T14:03:58+00:00'
                        can_cancel_checkout: false
                        can_request_cancellation: true
                        can_withdraw_cancellation: false
                        cancellation_type: null
                        cancellation_requested_at: null
                        created_at: '2026-06-20T14:03:51+00:00'
                        server:
                          id: ecc6f4f1
                          name: lambda-core
                          hostname: lambda-core.blackmesa.example.com
                          windows: false
                          template_name: Ubuntu 24.04
                          template_icon_url: https://img.icons8.com/color/48/ubuntu.png
                        attaching_to: null
                        attachment_status: null
                    limits:
                      ipv4:
                        quota: 10
                        used: 1
                        remaining: 9
                      ipv6:
                        quota: 5
                        used: 0
                        remaining: 5
                    sellable:
                      ipv4: true
                      ipv6: true
                properties:
                  items:
                    type: array
                    description: The addresses themselves.
                    examples:
                      - - uuid: 1b8349e5-3568-43e0-bf89-fc3350dd7a08
                          uuid_short: 1b8349e5
                          status: active
                          status_label: Active
                          progress_message: null
                          needs_funds: false
                          type: ipv4
                          address: 198.51.100.42
                          cidr: 24
                          gateway: 198.51.100.1
                          onlink: null
                          is_primary: false
                          location: Kansas City, MO
                          location_id: 3
                          is_granted: false
                          can_release: false
                          billing:
                            service_id: 7421
                            invoice_id: 17214
                            invoice_url: null
                            checkout_uuid: null
                            invoice_status: Paid
                            amount: '3.00'
                            currency: USD
                            billing_cycle: monthly
                            payment_due_at: null
                            payment_window_minutes: null
                            paid_at: '2026-06-20T14:03:58+00:00'
                          can_cancel_checkout: false
                          can_request_cancellation: true
                          can_withdraw_cancellation: false
                          cancellation_type: null
                          cancellation_requested_at: null
                          created_at: '2026-06-20T14:03:51+00:00'
                          server:
                            id: ecc6f4f1
                            name: lambda-core
                            hostname: lambda-core.blackmesa.example.com
                            windows: false
                            template_name: Ubuntu 24.04
                            template_icon_url: https://img.icons8.com/color/48/ubuntu.png
                          attaching_to: null
                          attachment_status: null
                    items:
                      $ref: '#/components/schemas/FloatingIpData'
                  limits:
                    description: >-
                      How many of each family the account may hold, and how many
                      it holds now.
                    examples:
                      - ipv4:
                          quota: 10
                          used: 1
                          remaining: 9
                        ipv6:
                          quota: 5
                          used: 0
                          remaining: 5
                    allOf:
                      - $ref: '#/components/schemas/FloatingIpQuotaSummaryData'
                  sellable:
                    description: Whether IPv4 and IPv6 addresses are available to buy.
                    examples:
                      - ipv4: true
                        ipv6: true
                    allOf:
                      - $ref: '#/components/schemas/FloatingIpSellableData'
                required:
                  - items
                  - limits
                  - sellable
        '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:
    FloatingIpData:
      type: object
      description: A floating IP address and its current assignment.
      examples:
        - uuid: 1b8349e5-3568-43e0-bf89-fc3350dd7a08
          uuid_short: 1b8349e5
          status: active
          status_label: Active
          progress_message: null
          needs_funds: false
          type: ipv4
          address: 198.51.100.42
          cidr: 24
          gateway: 198.51.100.1
          onlink: null
          is_primary: false
          location: Kansas City, MO
          location_id: 3
          is_granted: false
          can_release: false
          billing:
            service_id: 7421
            invoice_id: 17214
            invoice_url: null
            checkout_uuid: null
            invoice_status: Paid
            amount: '3.00'
            currency: USD
            billing_cycle: monthly
            payment_due_at: null
            payment_window_minutes: null
            paid_at: '2026-06-20T14:03:58+00:00'
          can_cancel_checkout: false
          can_request_cancellation: true
          can_withdraw_cancellation: false
          cancellation_type: null
          cancellation_requested_at: null
          created_at: '2026-06-20T14:03:51+00:00'
          server:
            id: ecc6f4f1
            name: lambda-core
            hostname: lambda-core.blackmesa.example.com
            windows: false
            template_name: Ubuntu 24.04
            template_icon_url: https://img.icons8.com/color/48/ubuntu.png
          attaching_to: null
          attachment_status: null
      properties:
        uuid:
          type: string
          description: The uuid UUID.
          examples:
            - 1b8349e5-3568-43e0-bf89-fc3350dd7a08
        uuid_short:
          type: string
          description: >-
            The first eight characters of the UUID. Either form can identify the
            address.
          examples:
            - 1b8349e5
        status:
          type: string
          description: The value of `status`.
          enum:
            - pending_payment
            - active
            - pending_cancellation
            - deleting
            - expired
            - cancelled
            - payment_review
          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, or null.
          examples:
            - null
        needs_funds:
          type: boolean
          description: >-
            Whether the purchase is waiting on account credit, which is the one
            wait the customer can end themselves.
          examples:
            - false
        type:
          type: string
          description: The type of operation or resource.
          enum:
            - ipv4
            - ipv6
          examples:
            - ipv4
        address:
          type:
            - string
            - 'null'
          description: The IP address, or null after it has been released.
          examples:
            - 198.51.100.42
        cidr:
          type:
            - integer
            - 'null'
          description: The network prefix length.
          examples:
            - 24
        gateway:
          type:
            - string
            - 'null'
          description: The gateway address for the network.
          examples:
            - 198.51.100.1
        onlink:
          type:
            - string
            - 'null'
          description: The value of `onlink`.
          examples:
            - null
        is_primary:
          type: boolean
          description: Whether the resource is primary.
          examples:
            - false
        location:
          type:
            - string
            - 'null'
          description: The value of `location`.
          examples:
            - Kansas City, MO
        location_id:
          type:
            - integer
            - 'null'
          description: The location id ID.
          examples:
            - 3
        is_granted:
          type: boolean
          description: Whether the resource is granted.
          examples:
            - false
        can_release:
          type: boolean
          description: Whether the customer can release.
          examples:
            - false
        billing:
          $ref: '#/components/schemas/BillingData'
          description: The value of `billing`.
          examples:
            - service_id: 7421
              invoice_id: 17214
              invoice_url: null
              checkout_uuid: null
              invoice_status: Paid
              amount: '3.00'
              currency: USD
              billing_cycle: monthly
              payment_due_at: null
              payment_window_minutes: null
              paid_at: '2026-06-20T14:03:58+00:00'
        can_cancel_checkout:
          type: boolean
          description: Whether the customer can cancel checkout.
          examples:
            - false
        can_request_cancellation:
          type: boolean
          description: Whether the customer can request cancellation.
          examples:
            - true
        can_withdraw_cancellation:
          type: boolean
          description: >-
            Whether the cancellation standing against this address can still be
            taken back. False for an immediate one, which gave the address away
            as it was filed.
          examples:
            - false
        cancellation_type:
          type:
            - string
            - 'null'
          description: The value of `cancellation_type`.
          enum:
            - immediate
            - end_of_billing
            - null
          examples:
            - null
        cancellation_requested_at:
          type:
            - string
            - 'null'
          description: The date and time for cancellation requested at, in UTC.
          examples:
            - null
        created_at:
          type:
            - string
            - 'null'
          description: The date and time for created at, in UTC.
          examples:
            - '2026-06-20T14:03:51+00:00'
        server:
          description: >-
            Null whenever the address is held but parked on nothing, which is a
            perfectly ordinary state for a floating address to sit in.
          examples:
            - id: ecc6f4f1
              name: lambda-core
              hostname: lambda-core.blackmesa.example.com
              windows: false
              template_name: Ubuntu 24.04
              template_icon_url: https://img.icons8.com/color/48/ubuntu.png
          anyOf:
            - $ref: '#/components/schemas/FloatingIpServerData'
            - type: 'null'
        attaching_to:
          description: >-
            The server this address was bought for, while it waits to be put
            there. It is attached as soon as the purchase has been paid for, and
            this goes back to null.
          examples:
            - null
          anyOf:
            - $ref: '#/components/schemas/FloatingIpServerData'
            - type: 'null'
        attachment_status:
          type:
            - string
            - 'null'
          description: >-
            Which way the address is moving while a worker attaches or detaches
            it, or null once it has settled. An attaching address is not on
            `attaching_to` yet; a detaching one is still on `server`.
          enum:
            - attaching
            - detaching
            - null
          examples:
            - null
      required:
        - uuid
        - uuid_short
        - status
        - status_label
        - progress_message
        - needs_funds
        - type
        - address
        - cidr
        - gateway
        - onlink
        - is_primary
        - location
        - location_id
        - is_granted
        - can_release
        - billing
        - can_cancel_checkout
        - can_request_cancellation
        - can_withdraw_cancellation
        - cancellation_type
        - cancellation_requested_at
        - created_at
        - server
        - attaching_to
        - attachment_status
      title: FloatingIpData
    FloatingIpQuotaSummaryData:
      type: object
      description: The account's floating-address allowance, family by family.
      examples:
        - ipv4:
            quota: 10
            used: 1
            remaining: 9
          ipv6:
            quota: 5
            used: 0
            remaining: 5
      properties:
        ipv4:
          $ref: '#/components/schemas/FloatingIpQuotaData'
          description: The value of `ipv4`.
          examples:
            - quota: 10
              used: 1
              remaining: 9
        ipv6:
          $ref: '#/components/schemas/FloatingIpQuotaData'
          description: The value of `ipv6`.
          examples:
            - quota: 5
              used: 0
              remaining: 5
      required:
        - ipv4
        - ipv6
      title: FloatingIpQuotaSummaryData
    FloatingIpSellableData:
      type: object
      description: The floating IP families currently available for purchase.
      examples:
        - ipv4: true
          ipv6: true
      properties:
        ipv4:
          type: boolean
          description: The value of `ipv4`.
          examples:
            - true
        ipv6:
          type: boolean
          description: The value of `ipv6`.
          examples:
            - true
      required:
        - ipv4
        - ipv6
      title: FloatingIpSellableData
    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
    FloatingIpServerData:
      type: object
      description: The machine a floating address is currently parked on.
      examples:
        - id: ecc6f4f1
          name: lambda-core
          hostname: lambda-core.blackmesa.example.com
          windows: false
          template_name: Ubuntu 24.04
          template_icon_url: https://img.icons8.com/color/48/ubuntu.png
      properties:
        id:
          type: string
          description: The id ID.
          examples:
            - ecc6f4f1
        name:
          type: string
          description: The name shown to customers.
          examples:
            - lambda-core
        hostname:
          type: string
          description: The fully qualified hostname.
          examples:
            - lambda-core.blackmesa.example.com
        windows:
          type: boolean
          description: The value of `windows`.
          examples:
            - false
        template_name:
          type:
            - string
            - 'null'
          description: The value of `template_name`.
          examples:
            - Ubuntu 24.04
        template_icon_url:
          type:
            - string
            - 'null'
          description: The value of `template_icon_url`.
          examples:
            - https://img.icons8.com/color/48/ubuntu.png
      required:
        - id
        - name
        - hostname
        - windows
        - template_name
        - template_icon_url
      title: FloatingIpServerData
    FloatingIpQuotaData:
      type: object
      description: >-
        How many addresses of one family the account may hold, and how many of
        those it is already holding.
      examples:
        - quota: 10
          used: 1
          remaining: 9
      properties:
        quota:
          type: integer
          description: The value of `quota`.
          examples:
            - 10
        used:
          type: integer
          description: The value of `used`.
          examples:
            - 1
        remaining:
          type: integer
          description: The value of `remaining`.
          examples:
            - 9
      required:
        - quota
        - used
        - remaining
      title: FloatingIpQuotaData
  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.