> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xerobi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List all business IP assignments

> Returns all IP addresses and ranges assigned to the authenticated business account, including their status and reverse DNS configuration.

**Use Cases:**
- Inventory management of IP assets
- Audit IP allocation
- Configure reverse DNS records
- Network planning and documentation

Returns all IP addresses and ranges assigned to the authenticated business account, including their status and reverse DNS configuration.

**Use Cases:**

* Inventory management of IP assets
* Audit IP allocation
* Configure reverse DNS records
* Network planning and documentation


## OpenAPI

````yaml GET /business/ip/assignments
openapi: 3.1.0
info:
  title: Xerobi Fiber API
  description: >-
    API for Xerobi Fiber customers and business clients.


    ## Overview


    The Xerobi Fiber API provides two distinct interfaces:


    - **Consumer API**: Simple, user-friendly endpoints for residential
    customers to check their network status, account details, usage statistics,
    and run speed tests.

    - **Business API**: Advanced endpoints for enterprise clients to manage IP
    assignments, monitor bandwidth usage, and automate network operations.


    ## Authentication


    All endpoints require Bearer token authentication. Include your JWT token in
    the Authorization header:


    ```

    Authorization: Bearer YOUR_JWT_TOKEN

    ```


    Tokens can be obtained from your Xerobi account dashboard.


    ## Versioning


    All requests must include the `Hixe-Version` header with the API version
    date (format: YYYY-MM-DD). Current version: `2026-01-01`


    ## Rate Limiting


    - Consumer endpoints: 100 requests per minute

    - Business endpoints: 1000 requests per minute


    Rate limit information is included in response headers:

    - `X-RateLimit-Limit`: Maximum requests allowed

    - `X-RateLimit-Remaining`: Requests remaining in current window

    - `X-RateLimit-Reset`: Unix timestamp when the limit resets
  version: '2026-01-01'
  contact:
    name: Xerobi API Support
    email: support@xerobi.com
    url: https://support.hixbe.com
  license:
    name: Proprietary
    url: https://hixbe.com/terms
servers:
  - url: https://api.hixbe.com/fiber
    description: Production API
security:
  - bearerAuth: []
tags:
  - name: Consumer
    description: Endpoints for residential customers
  - name: Business
    description: Endpoints for enterprise clients
paths:
  /business/ip/assignments:
    get:
      tags:
        - Business
      summary: List all business IP assignments
      description: >-
        Returns all IP addresses and ranges assigned to the authenticated
        business account, including their status and reverse DNS configuration.


        **Use Cases:**

        - Inventory management of IP assets

        - Audit IP allocation

        - Configure reverse DNS records

        - Network planning and documentation
      operationId: listBusinessIPAssignments
      parameters:
        - $ref: '#/components/parameters/hixeVersionHeader'
      responses:
        '200':
          description: Successfully retrieved IP assignments
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BusinessIPAssignment'
              example:
                - ip: 198.51.100.0/24
                  status: active
                  rdns: mail.example.com
                  assigned_date: '2025-06-15'
                  type: ipv4
                - ip: 2001:db8::/48
                  status: active
                  rdns: null
                  assigned_date: '2025-06-15'
                  type: ipv6
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/RateLimitError'
components:
  parameters:
    hixeVersionHeader:
      name: Hixe-Version
      in: header
      description: 'API version in YYYY-MM-DD format. Current version: 2026-01-01'
      required: true
      schema:
        type: string
        pattern: ^\d{4}-\d{2}-\d{2}$
        example: '2026-01-01'
  schemas:
    BusinessIPAssignment:
      type: object
      description: IP address assignment for business clients
      properties:
        ip:
          type: string
          description: Assigned IP address or CIDR block
          example: 198.51.100.0/24
        status:
          type: string
          description: Assignment status
          enum:
            - active
            - reserved
            - deprecated
          example: active
        rdns:
          type: string
          description: Reverse DNS record for the IP
          example: mail.example.com
          nullable: true
        assigned_date:
          type: string
          format: date
          description: Date when IP was assigned
          example: '2025-06-15'
        type:
          type: string
          description: IP address type
          enum:
            - ipv4
            - ipv6
          example: ipv4
      required:
        - ip
        - status
    Error:
      type: object
      description: Standard error response
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code for programmatic handling
              example: invalid_request
            message:
              type: string
              description: Human-readable error message
              example: The Hixe-Version header is required
            details:
              type: object
              description: Additional error details
              nullable: true
          required:
            - code
            - message
      required:
        - error
  responses:
    UnauthorizedError:
      description: Authentication failed - invalid or missing token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthorized
              message: Invalid or expired authentication token
    ForbiddenError:
      description: Access denied - token valid but lacks required permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: forbidden
              message: Your account does not have access to this resource
    RateLimitError:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limit_exceeded
              message: Too many requests. Please retry after 60 seconds
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Maximum requests allowed per window
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests remaining in current window
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix timestamp when rate limit resets
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait before retrying
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from Xerobi account dashboard

````

## Related topics

- [List Webhooks](https://docs.xerobi.com/sms-api/endpoint/list-webhooks.md)
- [Xerobi Fiber API](https://docs.xerobi.com/network-api/introduction.md)
- [List Test Results](https://docs.xerobi.com/speed-api/endpoint/list-results.md)
- [List Webhook Endpoints](https://docs.xerobi.com/payment-api/endpoint/list-webhook-endpoints.md)
- [List Message Templates](https://docs.xerobi.com/sms-api/endpoint/list-templates.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.