Oracle VNIC Attachments API

openapi: 3.1.0
info:
  title: Oracle OCI Compute Console Connections VNIC Attachments API
  description: The Oracle Cloud Infrastructure Compute API provides REST endpoints for managing compute instances, shapes, and images. You can launch and manage virtual machine (VM) and bare metal instances, query available compute shapes, list and manage custom images, and configure instance console connections. All API requests require OCI request signing for authentication.
  version: '20160918'
  contact:
    name: Oracle Cloud Infrastructure Support
    url: https://support.oracle.com
  license:
    name: Oracle Technology Network License Agreement
    url: https://www.oracle.com/downloads/licenses/oracle-oci-api-license.html
  termsOfService: https://www.oracle.com/legal/terms.html
servers:
- url: https://iaas.{region}.oraclecloud.com/20160918
  description: OCI Compute API regional endpoint
  variables:
    region:
      description: The OCI region identifier (e.g., us-ashburn-1, us-phoenix-1, eu-frankfurt-1, ap-tokyo-1)
      default: us-ashburn-1
      enum:
      - us-ashburn-1
      - us-phoenix-1
      - us-chicago-1
      - us-sanjose-1
      - ca-toronto-1
      - ca-montreal-1
      - eu-frankfurt-1
      - eu-amsterdam-1
      - eu-zurich-1
      - eu-madrid-1
      - uk-london-1
      - ap-tokyo-1
      - ap-osaka-1
      - ap-seoul-1
      - ap-mumbai-1
      - ap-sydney-1
      - ap-melbourne-1
      - sa-saopaulo-1
      - me-jeddah-1
      - af-johannesburg-1
security:
- ociRequestSigning: []
tags:
- name: VNIC Attachments
  description: Manage virtual network interface card attachments for instances
paths:
  /vnicAttachments:
    get:
      operationId: listVnicAttachments
      summary: Oracle List Vnic Attachments
      description: Lists the VNIC attachments in the specified compartment. A VNIC attachment represents the connection between an instance and a VNIC.
      tags:
      - VNIC Attachments
      parameters:
      - $ref: '#/components/parameters/compartmentId'
      - name: instanceId
        in: query
        description: The OCID of the instance to filter by
        schema:
          type: string
        example: '500123'
      - name: availabilityDomain
        in: query
        description: The name of the availability domain to filter by
        schema:
          type: string
        example: example_value
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: The list of VNIC attachments
          headers:
            opc-next-page:
              description: Pagination token for the next page of results
              schema:
                type: string
            opc-request-id:
              description: Unique Oracle-assigned identifier for the request
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VnicAttachment'
              examples:
                Listvnicattachments200Example:
                  summary: Default listVnicAttachments 200 response
                  x-microcks-default: true
                  value:
                  - id: abc123
                    instanceId: '500123'
                    compartmentId: '500123'
                    availabilityDomain: example_value
                    displayName: example_value
                    vnicId: '500123'
                    subnetId: '500123'
                    nicIndex: 10
                    vlanTag: 10
                    vlanId: '500123'
                    lifecycleState: ATTACHING
                    timeCreated: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    NotFound:
      description: Not found - the specified resource does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized - missing or invalid authentication credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request - invalid parameters or missing required fields
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Too many requests - rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      description: Error response returned by the OCI API
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: A short error code that defines the error, meant for programmatic parsing
          example: example_value
        message:
          type: string
          description: A human-readable error string
          example: example_value
        status:
          type: integer
          description: The HTTP status code
          example: 10
        opcRequestId:
          type: string
          description: Unique Oracle-assigned identifier for the request
          example: '500123'
    VnicAttachment:
      type: object
      description: Represents the attachment between an instance and a VNIC. Each instance has a primary VNIC attachment created during launch.
      required:
      - id
      - instanceId
      - compartmentId
      - availabilityDomain
      - lifecycleState
      - timeCreated
      properties:
        id:
          type: string
          description: The OCID of the VNIC attachment
          example: abc123
        instanceId:
          type: string
          description: The OCID of the instance
          example: '500123'
        compartmentId:
          type: string
          description: The OCID of the compartment
          example: '500123'
        availabilityDomain:
          type: string
          description: The availability domain of the instance
          example: example_value
        displayName:
          type: string
          description: A user-friendly name for the attachment
          example: example_value
        vnicId:
          type: string
          description: The OCID of the VNIC
          example: '500123'
        subnetId:
          type: string
          description: The OCID of the subnet of the VNIC
          example: '500123'
        nicIndex:
          type: integer
          description: Which physical network interface card (NIC) the VNIC uses. 0 for the primary VNIC.
          example: 10
        vlanTag:
          type: integer
          description: The Oracle-assigned VLAN tag of the VNIC attachment
          example: 10
        vlanId:
          type: string
          description: The OCID of the VLAN to create the VNIC in
          example: '500123'
        lifecycleState:
          type: string
          description: The lifecycle state of the VNIC attachment
          enum:
          - ATTACHING
          - ATTACHED
          - DETACHING
          - DETACHED
          example: ATTACHING
        timeCreated:
          type: string
          format: date-time
          description: The date and time the VNIC attachment was created
          example: '2026-01-15T10:30:00Z'
  parameters:
    compartmentId:
      name: compartmentId
      in: query
      required: true
      description: The OCID of the compartment. List operations return resources in the compartment and its sub-compartments unless specified otherwise.
      schema:
        type: string
    page:
      name: page
      in: query
      description: For list pagination. The value of the opc-next-page response header from the previous list call.
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: For list pagination. The maximum number of results per page, or items to return in a paginated list call. The value must be between 1 and 1000.
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 100
  securitySchemes:
    ociRequestSigning:
      type: http
      scheme: bearer
      description: OCI uses a custom request signing scheme based on RSA key pairs. Each API request must include an Authorization header with the signature computed from the request headers, method, and path. See https://docs.oracle.com/en-us/iaas/Content/API/Concepts/signingrequests.htm
externalDocs:
  description: OCI Compute Service Documentation
  url: https://docs.oracle.com/en-us/iaas/Content/Compute/Concepts/computeoverview.htm