openapi: 3.1.0
info:
  title: Infoblox WAPI (Web API) DHCP IP Address Management API
  description: RESTful API for managing Infoblox NIOS DDI (DNS, DHCP, IPAM) services, network objects, and configuration. The WAPI uses standard HTTP methods for CRUD operations and supports JSON and XML input and output formats. Authentication is handled via HTTP basic authentication or certificate-based authentication, and sessions can be maintained using cookies returned after initial authentication. The API follows a resource-oriented design where each NIOS object type is accessible as a REST resource.
  version: '2.12'
  contact:
    name: Infoblox Support
    email: support@infoblox.com
    url: https://www.infoblox.com/support/
  termsOfService: https://www.infoblox.com/company/legal/website-terms-and-conditions/
servers:
- url: https://{grid-master}/wapi/v2.12
  description: Infoblox NIOS Grid Master
  variables:
    grid-master:
      default: grid-master.example.com
      description: The hostname or IP address of the Infoblox NIOS Grid Master appliance.
security:
- basicAuth: []
- cookieAuth: []
tags:
- name: IP Address Management
  description: Operations for managing IP addresses, querying address utilization, and performing next available IP lookups.
paths:
  /ipv4address:
    get:
      operationId: listIPv4Addresses
      summary: Infoblox List IPv4 addresses
      description: Retrieves a list of IPv4 address objects. This is a read-only object that provides information about the usage and status of IPv4 addresses in the Infoblox system. Supports filtering by IP address, network, status, and associated names.
      tags:
      - IP Address Management
      parameters:
      - $ref: '#/components/parameters/ReturnFields'
      - $ref: '#/components/parameters/MaxResults'
      - name: ip_address
        in: query
        description: Filter by the IPv4 address.
        schema:
          type: string
          format: ipv4
      - name: network
        in: query
        description: Filter by the network in CIDR notation.
        schema:
          type: string
      - name: status
        in: query
        description: Filter by the IP address status.
        schema:
          type: string
          enum:
          - USED
          - UNUSED
      - name: network_view
        in: query
        description: Filter by the network view name.
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved list of IPv4 addresses.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IPv4Address'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Authentication failed or credentials were not provided.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: The request was malformed or contained invalid parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        Error:
          type: string
          description: The error type identifier.
        code:
          type: string
          description: The error code.
        text:
          type: string
          description: A human-readable error message.
    IPv4Address:
      type: object
      properties:
        _ref:
          type: string
          description: The object reference for this IPv4 address.
        ip_address:
          type: string
          format: ipv4
          description: The IPv4 address.
        network:
          type: string
          description: The network containing this address in CIDR notation.
        network_view:
          type: string
          description: The network view containing this address.
        status:
          type: string
          enum:
          - USED
          - UNUSED
          description: The utilization status of the address.
        names:
          type: array
          items:
            type: string
          description: The DNS names associated with this address.
        types:
          type: array
          items:
            type: string
          description: The types of objects using this address (e.g. A, HOST, RESERVATION).
        objects:
          type: array
          items:
            type: string
          description: The object references of objects using this address.
        mac_address:
          type: string
          description: The MAC address associated with this IP if available.
        is_conflict:
          type: boolean
          description: Whether a conflict has been detected for this address.
  parameters:
    ReturnFields:
      name: _return_fields
      in: query
      description: Comma-separated list of field names to include in the response. Use _return_fields+ to add fields to the default set.
      schema:
        type: string
    MaxResults:
      name: _max_results
      in: query
      description: The maximum number of results to return. The default is 1000. Use a negative value to return all results.
      schema:
        type: integer
        default: 1000
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using NIOS admin credentials.
    cookieAuth:
      type: apiKey
      in: cookie
      name: ibapauth
      description: Session cookie returned after successful authentication. Pass the ibapauth cookie with subsequent requests to maintain an authenticated session.
externalDocs:
  description: Infoblox WAPI Documentation
  url: https://docs.infoblox.com/space/niosapi/