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

# List the instance's network interfaces

> Returns the instance's NIC bindings ordered by boot index
(primary first), each resolved with the interface's current
MAC/IP/subnet detail and with the floating IP attached to that
interface.

This is the read that answers "what are this instance's public
addresses". The instance's own `public_ip` reports the primary NIC
alone, so an address that `networks[].assign_public_ip` put on a
secondary NIC appears here and nowhere else.




## OpenAPI

````yaml /api-reference/specs/compute.yaml get /v1/instances/{instance_id}/nics
openapi: 3.0.3
info:
  title: Basaltic Compute API
  version: 1.0.0
  description: |
    Virtual machine instances, and the images, flavors, SSH keypairs and
    instance pools they are built from. Covers the whole instance lifecycle:
    start, stop, reboot, resize and reinstall.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://compute.{region}.basaltic.sh
    description: Regional API endpoint
    variables:
      region:
        default: sa-saopaulo-1
        description: Region code
security:
  - SignatureAuth: []
paths:
  /v1/instances/{instance_id}/nics:
    get:
      tags:
        - Compute
      summary: List the instance's network interfaces
      description: |
        Returns the instance's NIC bindings ordered by boot index
        (primary first), each resolved with the interface's current
        MAC/IP/subnet detail and with the floating IP attached to that
        interface.

        This is the read that answers "what are this instance's public
        addresses". The instance's own `public_ip` reports the primary NIC
        alone, so an address that `networks[].assign_public_ip` put on a
        secondary NIC appears here and nowhere else.
      operationId: listInstanceNICs
      parameters:
        - $ref: '#/components/parameters/InstanceId'
      responses:
        '200':
          description: NIC list
          content:
            application/json:
              schema:
                type: object
                properties:
                  nics:
                    type: array
                    items:
                      type: object
                      properties:
                        interface_id:
                          type: string
                          format: uuid
                          example: e8a1c2d3-4b5f-4a6e-9c0d-1e2f3a4b5c6d
                        boot_index:
                          type: integer
                          example: 0
                        primary:
                          type: boolean
                          description: >-
                            The lowest-boot-index NIC — the one carrying the
                            guest's default and metadata routes.
                          example: true
                        external:
                          type: boolean
                          description: >-
                            A customer-attached standalone interface — detach
                            unbinds it instead of destroying it.
                          example: false
                        name:
                          type: string
                          example: web-1-nic0
                        mac:
                          type: string
                          example: 02:1a:2b:3c:4d:5e
                        ip_address:
                          type: string
                          example: 10.0.1.42
                        ipv6_address:
                          type: string
                          example: 2804:1234:5678::42
                        public_ip:
                          type: string
                          description: >-
                            The floating IP NATed to THIS interface, absent when
                            it has none. A floating IP fronting several NICs at
                            once reports the same address on each of them.
                          example: 212.66.52.130
                        floating_ip_id:
                          type: string
                          format: uuid
                          description: >-
                            The floating IP resource behind `public_ip`, so
                            detaching or releasing it needs no lookup.
                          example: f6a7b8c9-d0e1-4234-f5a6-b7c8d9e0f1a2
                        subnet_id:
                          type: string
                          format: uuid
                          example: 9b2e4f1a-3c5d-4e6f-8a90-1b2c3d4e5f60
                        vpc_id:
                          type: string
                          format: uuid
                          example: 3f8a1b2c-4d5e-4f60-8a9b-0c1d2e3f4a5b
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - SignatureAuth: []
components:
  parameters:
    InstanceId:
      name: instance_id
      in: path
      description: Instance ID
      required: true
      schema:
        type: string
        format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    Unauthorized:
      description: Authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              request_id: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Error code identifying the type of error
              example: INVALID_INPUT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameters
            request_id:
              type: string
              format: uuid
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    SignatureAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Request signing with an access key issued to a service account. An

        HMAC-SHA256 over a canonical form of the request, close to AWS SigV4.

        The `basaltic` CLI signs for you.


        Send `Authorization`, `X-Date` (UTC, `YYYYMMDDTHHMMSSZ`) and `X-Nonce`

        (random per request); add `X-Content-Sha256` to bind a body, and

        `X-Amz-Security-Token` when using temporary credentials.


        ```

        Authorization: BASALTIC-HMAC-SHA256
        Credential=<access_key_id>/<date>/<region>/basaltic/basaltic_request,
        SignedHeaders=host;x-date;x-nonce, Signature=<hex>

        ```


        `<region>` is the region code you are calling, or `global` for the
        global

        services. A signature is valid for 5 minutes from `X-Date`, and mutating

        requests are replay-guarded on the nonce.


        **Full signing procedure, including a working implementation:**

        https://docs.basaltic.sh/authentication


        ## Rate limits

        There is no global request budget. A limit applies only where an

        operation documents a `429`, and that operation says what it counts.

        Those responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining`,

        `X-RateLimit-Reset` and, on a `429`, `Retry-After` — read them rather

        than hard-coding a number. Retrying before `Retry-After` is refused and

        extends the window. Everything else is bounded by quota, not by request

        rate.

````