openapi: 3.2.0
info:
  title: Oxide Region Floating Ips API
  description: API for interacting with the Oxide control plane
  contact:
    url: https://oxide.computer
    email: api@oxide.computer
  version: 2026081901.0.0
tags:
- name: floating-ips
  description: Floating IPs allow a project to allocate well-known IPs to instances.
  externalDocs:
    url: http://docs.oxide.computer/api/floating-ips
paths:
  /v1/floating-ips:
    get:
      tags:
      - floating-ips
      summary: List floating IPs
      operationId: floating_ip_list
      parameters:
      - in: query
        name: limit
        description: Maximum number of items returned by a single call
        schema:
          type:
          - integer
          - 'null'
          format: uint32
          minimum: 1
      - in: query
        name: page_token
        description: Token returned by previous call to retrieve the subsequent page
        schema:
          type:
          - string
          - 'null'
      - in: query
        name: project
        description: Name or ID of the project
        schema:
          $ref: '#/components/schemas/NameOrId'
      - in: query
        name: sort_by
        schema:
          $ref: '#/components/schemas/NameOrIdSortMode'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FloatingIpResultsPage'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      x-dropshot-pagination:
        required:
        - project
    post:
      tags:
      - floating-ips
      summary: Create floating IP
      description: A specific IP address can be reserved, or an IP can be auto-allocated from a specific pool or the silo's default pool.
      operationId: floating_ip_create
      parameters:
      - in: query
        name: project
        description: Name or ID of the project
        required: true
        schema:
          $ref: '#/components/schemas/NameOrId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FloatingIpCreate'
        required: true
      responses:
        '201':
          description: successful creation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FloatingIp'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
  /v1/floating-ips/{floating_ip}:
    get:
      tags:
      - floating-ips
      summary: Fetch floating IP
      operationId: floating_ip_view
      parameters:
      - in: path
        name: floating_ip
        description: Name or ID of the floating IP
        required: true
        schema:
          $ref: '#/components/schemas/NameOrId'
      - in: query
        name: project
        description: Name or ID of the project
        schema:
          $ref: '#/components/schemas/NameOrId'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FloatingIp'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
    put:
      tags:
      - floating-ips
      summary: Update floating IP
      operationId: floating_ip_update
      parameters:
      - in: path
        name: floating_ip
        description: Name or ID of the floating IP
        required: true
        schema:
          $ref: '#/components/schemas/NameOrId'
      - in: query
        name: project
        description: Name or ID of the project
        schema:
          $ref: '#/components/schemas/NameOrId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FloatingIpUpdate'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FloatingIp'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
    delete:
      tags:
      - floating-ips
      summary: Delete floating IP
      operationId: floating_ip_delete
      parameters:
      - in: path
        name: floating_ip
        description: Name or ID of the floating IP
        required: true
        schema:
          $ref: '#/components/schemas/NameOrId'
      - in: query
        name: project
        description: Name or ID of the project
        schema:
          $ref: '#/components/schemas/NameOrId'
      responses:
        '204':
          description: successful deletion
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
  /v1/floating-ips/{floating_ip}/attach:
    post:
      tags:
      - floating-ips
      summary: Attach floating IP
      description: Attach floating IP to an instance or other resource.
      operationId: floating_ip_attach
      parameters:
      - in: path
        name: floating_ip
        description: Name or ID of the floating IP
        required: true
        schema:
          $ref: '#/components/schemas/NameOrId'
      - in: query
        name: project
        description: Name or ID of the project
        schema:
          $ref: '#/components/schemas/NameOrId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FloatingIpAttach'
        required: true
      responses:
        '202':
          description: successfully enqueued operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FloatingIp'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
  /v1/floating-ips/{floating_ip}/detach:
    post:
      tags:
      - floating-ips
      summary: Detach floating IP
      operationId: floating_ip_detach
      parameters:
      - in: path
        name: floating_ip
        description: Name or ID of the floating IP
        required: true
        schema:
          $ref: '#/components/schemas/NameOrId'
      - in: query
        name: project
        description: Name or ID of the project
        schema:
          $ref: '#/components/schemas/NameOrId'
      responses:
        '202':
          description: successfully enqueued operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FloatingIp'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  schemas:
    FloatingIpAttach:
      description: Parameters for attaching a floating IP address to another resource
      type: object
      properties:
        kind:
          description: The type of `parent`'s resource
          allOf:
          - $ref: '#/components/schemas/FloatingIpParentKind'
        parent:
          description: Name or ID of the resource that this IP address should be attached to
          allOf:
          - $ref: '#/components/schemas/NameOrId'
      required:
      - kind
      - parent
    NameOrId:
      oneOf:
      - title: id
        allOf:
        - type: string
          format: uuid
      - title: name
        allOf:
        - $ref: '#/components/schemas/Name'
    FloatingIpUpdate:
      description: Updateable identity-related parameters
      type: object
      properties:
        description:
          type:
          - string
          - 'null'
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
    Name:
      title: A name unique within the parent collection
      description: Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.
      type: string
      pattern: ^(?![0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)^[a-z]([a-zA-Z0-9-]*[a-zA-Z0-9]+)?$
      minLength: 1
      maxLength: 63
    FloatingIpParentKind:
      description: The type of resource that a floating IP is attached to
      type: string
      enum:
      - instance
    FloatingIpCreate:
      description: Parameters for creating a new floating IP address for instances.
      type: object
      properties:
        address_allocator:
          description: IP address allocation method.
          default:
            pool_selector:
              ip_version: null
              type: auto
            type: auto
          allOf:
          - $ref: '#/components/schemas/AddressAllocator'
        description:
          type: string
        name:
          $ref: '#/components/schemas/Name'
      required:
      - description
      - name
    FloatingIpResultsPage:
      description: A single page of results
      type: object
      properties:
        items:
          description: list of items on this page of results
          type: array
          items:
            $ref: '#/components/schemas/FloatingIp'
        next_page:
          description: token used to fetch the next page of results (if any)
          type:
          - string
          - 'null'
      required:
      - items
    FloatingIp:
      description: A Floating IP is a well-known IP address which can be attached and detached from instances.
      type: object
      properties:
        description:
          description: Human-readable free-form text about a resource
          type: string
        id:
          description: Unique, immutable, system-controlled identifier for each resource
          type: string
          format: uuid
        instance_id:
          description: The ID of the instance that this Floating IP is attached to, if it is presently in use.
          type:
          - string
          - 'null'
          format: uuid
        ip:
          description: The IP address held by this resource.
          type: string
          format: ip
        ip_pool_id:
          description: The ID of the IP pool this resource belongs to.
          type: string
          format: uuid
        name:
          description: Unique, mutable, user-controlled identifier for each resource
          allOf:
          - $ref: '#/components/schemas/Name'
        project_id:
          description: The project this resource exists within.
          type: string
          format: uuid
        time_created:
          description: Timestamp when this resource was created
          type: string
          format: date-time
        time_modified:
          description: Timestamp when this resource was last modified
          type: string
          format: date-time
      required:
      - description
      - id
      - ip
      - ip_pool_id
      - name
      - project_id
      - time_created
      - time_modified
    AddressAllocator:
      description: Specify how to allocate a floating IP address.
      oneOf:
      - description: Reserve a specific IP address. The pool is inferred from the address since IP pools cannot have overlapping ranges.
        type: object
        properties:
          ip:
            description: The IP address to reserve.
            type: string
            format: ip
          type:
            type: string
            enum:
            - explicit
        required:
        - ip
        - type
      - description: Automatically allocate an IP address from a pool.
        type: object
        properties:
          pool_selector:
            description: 'Pool selection.


              If omitted, the silo''s default pool is used. If the silo has default pools for both IPv4 and IPv6, the request will fail unless `ip_version` is specified.'
            default:
              ip_version: null
              type: auto
            allOf:
            - $ref: '#/components/schemas/PoolSelector'
          type:
            type: string
            enum:
            - auto
        required:
        - type
    IpVersion:
      description: The IP address version.
      type: string
      enum:
      - v4
      - v6
    PoolSelector:
      description: Specify which IP or external subnet pool to allocate from.
      oneOf:
      - description: Use the specified pool by name or ID.
        type: object
        properties:
          pool:
            description: The pool to allocate from.
            allOf:
            - $ref: '#/components/schemas/NameOrId'
          type:
            type: string
            enum:
            - explicit
        required:
        - pool
        - type
      - description: Use the default pool for the silo.
        type: object
        properties:
          ip_version:
            description: IP version to use when multiple default pools exist. Required if both IPv4 and IPv6 default pools are configured.
            default: null
            allOf:
            - $ref: '#/components/schemas/IpVersion'
          type:
            type: string
            enum:
            - auto
        required:
        - type
    Error:
      description: Error information from a response.
      type: object
      properties:
        error_code:
          type: string
        message:
          type: string
        request_id:
          type: string
      required:
      - message
      - request_id
    NameOrIdSortMode:
      description: Supported set of sort modes for scanning by name or id
      oneOf:
      - description: Sort in increasing order of "name"
        type: string
        enum:
        - name_ascending
      - description: Sort in decreasing order of "name"
        type: string
        enum:
        - name_descending
      - description: Sort in increasing order of "id"
        type: string
        enum:
        - id_ascending
  responses:
    Error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'