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

# Get a quote for a floating IP

> ### Overview

Returns a price and a signed `quote_token` valid for five minutes. Send `location_id` and `type`. Use the token when buying the address. This request does not reserve an address or charge the account.

### 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 post /floating-ips/quote
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/quote:
    post:
      tags:
        - IP addresses
      summary: Get a quote for a floating IP
      description: >-
        ### Overview


        Returns a price and a signed `quote_token` valid for five minutes. Send
        `location_id` and `type`. Use the token when buying the address. This
        request does not reserve an address or charge the account.


        ### Permissions


        Requires the `network.read` (View networking) permission for the
        selected team. Resources outside that team return 404.
      operationId: floatingIp.quote
      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
                  type: ipv4
              allOf:
                - $ref: '#/components/schemas/QuoteFloatingIpRequest'
      responses:
        '200':
          description: The record, as a JSON object. There is no envelope.
          content:
            application/json:
              schema:
                examples:
                  - type: ipv4
                    location_id: 3
                    location: Kansas City, MO
                    product_name: Floating IPv4 Address
                    recurring_amount: '3.00'
                    currency: USD
                    billing_cycle: monthly
                    quote_token: >-
                      eyJpdiI6InlCb3ZvTkV4NFJwQnpSMHVPNkpMXC9RPT0iLCJ2YWx1ZSI6InF6V2ZzTnIrd3hQcUJMNFZPSlF1MU9IZ0FnWXh1UVhXNm5zSlZBQjk3SHRYZVNVRFFXcGtrUnkxQjBOUXZpaXhPWGJNUzRhSEZxZ0g2dmhpZXkyWXQ5MFwvVVQrU0ViM1lnMTR1bnFPWkJCb0NWVUI1RFdcL1dORkRJSXloK2pyM3EiLCJtYWMiOiJhMTBjM2NmZDNlNWI4NTg3ODQ4ODk2YjFmODMxZGY2NTA5ZTIwMjViMzJhMjljODdlOTdjZDM2NDM2NzljOWQ4IiwidGFnIjoiIn0=
                allOf:
                  - $ref: '#/components/schemas/FloatingIpQuoteData'
        '400':
          description: An address is unavailable for this location or address family.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - The request could not be carried out.
                required:
                  - message
        '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:
    QuoteFloatingIpRequest:
      type: object
      examples:
        - location_id: 3
          type: ipv4
      properties:
        location_id:
          type: integer
          description: The location id ID.
        type:
          type: string
          description: The type of operation or resource.
          enum:
            - ipv4
            - ipv6
      required:
        - location_id
        - type
      title: QuoteFloatingIpRequest
    FloatingIpQuoteData:
      type: object
      description: >-
        What a floating address in one city would cost, signed so the same
        figure can be charged for the next five minutes and no longer.
      examples:
        - type: ipv4
          location_id: 3
          location: Kansas City, MO
          product_name: Floating IPv4 Address
          recurring_amount: '3.00'
          currency: USD
          billing_cycle: monthly
          quote_token: >-
            eyJpdiI6InlCb3ZvTkV4NFJwQnpSMHVPNkpMXC9RPT0iLCJ2YWx1ZSI6InF6V2ZzTnIrd3hQcUJMNFZPSlF1MU9IZ0FnWXh1UVhXNm5zSlZBQjk3SHRYZVNVRFFXcGtrUnkxQjBOUXZpaXhPWGJNUzRhSEZxZ0g2dmhpZXkyWXQ5MFwvVVQrU0ViM1lnMTR1bnFPWkJCb0NWVUI1RFdcL1dORkRJSXloK2pyM3EiLCJtYWMiOiJhMTBjM2NmZDNlNWI4NTg3ODQ4ODk2YjFmODMxZGY2NTA5ZTIwMjViMzJhMjljODdlOTdjZDM2NDM2NzljOWQ4IiwidGFnIjoiIn0=
      properties:
        type:
          type: string
          description: The type of operation or resource.
          enum:
            - ipv4
            - ipv6
          examples:
            - ipv4
        location_id:
          type: integer
          description: The location id ID.
          examples:
            - 3
        location:
          type: string
          description: The value of `location`.
          examples:
            - Kansas City, MO
        product_name:
          type: string
          description: The value of `product_name`.
          examples:
            - Floating IPv4 Address
        recurring_amount:
          type: string
          description: The amount charged each billing cycle.
          examples:
            - '3.00'
        currency:
          type: string
          description: The three-letter currency code used for monetary amounts.
          examples:
            - USD
        billing_cycle:
          type: string
          description: How often the service renews and is billed.
          examples:
            - monthly
        quote_token:
          type: string
          description: The signed offer, handed back at checkout.
          examples:
            - >-
              eyJpdiI6InlCb3ZvTkV4NFJwQnpSMHVPNkpMXC9RPT0iLCJ2YWx1ZSI6InF6V2ZzTnIrd3hQcUJMNFZPSlF1MU9IZ0FnWXh1UVhXNm5zSlZBQjk3SHRYZVNVRFFXcGtrUnkxQjBOUXZpaXhPWGJNUzRhSEZxZ0g2dmhpZXkyWXQ5MFwvVVQrU0ViM1lnMTR1bnFPWkJCb0NWVUI1RFdcL1dORkRJSXloK2pyM3EiLCJtYWMiOiJhMTBjM2NmZDNlNWI4NTg3ODQ4ODk2YjFmODMxZGY2NTA5ZTIwMjViMzJhMjljODdlOTdjZDM2NDM2NzljOWQ4IiwidGFnIjoiIn0=
      required:
        - type
        - location_id
        - location
        - product_name
        - recurring_amount
        - currency
        - billing_cycle
        - quote_token
      title: FloatingIpQuoteData
  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.