openapi: 3.0.3
info:
  title: Oracle Cloud Compute Alarms Internet Gateways API
  description: Manage compute instances, images, shapes, and related resources in Oracle Cloud Infrastructure.
  version: '20160918'
  x-generated-from: documentation
  x-last-validated: '2026-04-18'
  contact:
    name: Oracle Cloud Infrastructure
    url: https://docs.oracle.com/en-us/iaas/Content/Compute/home.htm
servers:
- url: https://iaas.{region}.oraclecloud.com/20160918
  description: OCI Compute API server
  variables:
    region:
      default: us-ashburn-1
      description: OCI region identifier
security:
- ociSignature: []
tags:
- name: Internet Gateways
paths:
  /internetGateways:
    get:
      operationId: listInternetGateways
      summary: Oracle Cloud List Internet Gateways
      description: Lists the internet gateways in the specified VCN and compartment.
      tags:
      - Internet Gateways
      parameters:
      - name: compartmentId
        in: query
        required: true
        description: The OCID of the compartment.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      - name: vcnId
        in: query
        required: false
        description: The OCID of the VCN.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      responses:
        '200':
          description: Successfully retrieved internet gateways.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InternetGateway'
              examples:
                ListInternetGateways200Example:
                  summary: Default listInternetGateways 200 response
                  x-microcks-default: true
                  value:
                  - id: ocid1.resource.oc1.iad.abcdefg123456
                    compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    vcnId: ocid1.resource.oc1.iad.abcdefg123456
                    displayName: my-internet-gateway
                    isEnabled: true
                    lifecycleState: PROVISIONING
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createInternetGateway
      summary: Oracle Cloud Create Internet Gateway
      description: Creates a new internet gateway for the specified VCN.
      tags:
      - Internet Gateways
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInternetGatewayDetails'
            examples:
              CreateInternetGatewayRequestExample:
                summary: Default createInternetGateway request
                x-microcks-default: true
                value:
                  compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                  vcnId: ocid1.resource.oc1.iad.abcdefg123456
                  isEnabled: true
                  displayName: my-resource
      responses:
        '200':
          description: Successfully created internet gateway.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternetGateway'
              examples:
                CreateInternetGateway200Example:
                  summary: Default createInternetGateway 200 response
                  x-microcks-default: true
                  value:
                    id: ocid1.resource.oc1.iad.abcdefg123456
                    compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    vcnId: ocid1.resource.oc1.iad.abcdefg123456
                    displayName: my-internet-gateway
                    isEnabled: true
                    lifecycleState: PROVISIONING
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    InternetGateway:
      type: object
      description: An internet gateway for a VCN.
      properties:
        id:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        compartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        vcnId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        displayName:
          type: string
          example: my-internet-gateway
        isEnabled:
          type: boolean
          example: true
        lifecycleState:
          type: string
          enum:
          - PROVISIONING
          - AVAILABLE
          - TERMINATING
          - TERMINATED
          example: PROVISIONING
        timeCreated:
          type: string
          format: date-time
          example: '2026-04-18T10:30:00Z'
    CreateInternetGatewayDetails:
      type: object
      required:
      - compartmentId
      - vcnId
      - isEnabled
      properties:
        compartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        vcnId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        isEnabled:
          type: boolean
          default: true
          example: true
        displayName:
          type: string
          example: my-resource
  securitySchemes:
    ociSignature:
      type: http
      scheme: bearer
      description: OCI request signature authentication using API signing keys.