openapi: 3.1.0
info:
  title: Google Compute Engine Projects API
  description: 'Google Compute Engine is Google Cloud Platform''s Infrastructure-as-a-Service

    offering for creating and running virtual machines on Google''s infrastructure.

    The REST API exposes instances, disks, networks, firewalls, and machine types

    organized by projects, regions, and zones.

    '
  version: v1
servers:
- url: https://compute.googleapis.com/compute/v1
  description: Production Compute Engine API endpoint
security:
- OAuth2:
  - cloud-platform
- OAuth2:
  - compute
tags:
- name: Projects
paths:
  /projects/{project}/zones/{zone}/instances:
    get:
      summary: List instances
      description: Retrieves the list of instances contained within the specified zone.
      operationId: listInstances
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: zone
        in: path
        required: true
        schema:
          type: string
      - name: filter
        in: query
        schema:
          type: string
      - name: maxResults
        in: query
        schema:
          type: integer
      - name: pageToken
        in: query
        schema:
          type: string
      - name: orderBy
        in: query
        schema:
          type: string
      responses:
        '200':
          description: List of instances
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceList'
      tags:
      - Projects
    post:
      summary: Create instance
      description: Creates an instance resource in the specified project using the data included in the request.
      operationId: insertInstance
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: zone
        in: path
        required: true
        schema:
          type: string
      - name: requestId
        in: query
        schema:
          type: string
      - name: sourceInstanceTemplate
        in: query
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Instance'
      responses:
        '200':
          description: Long-running operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Operation'
      tags:
      - Projects
  /projects/{project}/zones/{zone}/instances/{instance}:
    get:
      summary: Get instance
      operationId: getInstance
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: zone
        in: path
        required: true
        schema:
          type: string
      - name: instance
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Instance details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Instance'
      tags:
      - Projects
    delete:
      summary: Delete instance
      operationId: deleteInstance
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: zone
        in: path
        required: true
        schema:
          type: string
      - name: instance
        in: path
        required: true
        schema:
          type: string
      - name: requestId
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Long-running operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Operation'
      tags:
      - Projects
  /projects/{project}/zones/{zone}/instances/{instance}/start:
    post:
      summary: Start instance
      operationId: startInstance
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: zone
        in: path
        required: true
        schema:
          type: string
      - name: instance
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Long-running operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Operation'
      tags:
      - Projects
  /projects/{project}/zones/{zone}/instances/{instance}/stop:
    post:
      summary: Stop instance
      operationId: stopInstance
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: zone
        in: path
        required: true
        schema:
          type: string
      - name: instance
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Long-running operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Operation'
      tags:
      - Projects
  /projects/{project}/zones/{zone}/disks:
    get:
      summary: List disks
      operationId: listDisks
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: zone
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of disks
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Disk'
      tags:
      - Projects
    post:
      summary: Create disk
      operationId: insertDisk
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: zone
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Disk'
      responses:
        '200':
          description: Long-running operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Operation'
      tags:
      - Projects
  /projects/{project}/global/networks:
    get:
      summary: List networks
      operationId: listNetworks
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of networks
          content:
            application/json:
              schema:
                type: object
      tags:
      - Projects
    post:
      summary: Create network
      operationId: insertNetwork
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Long-running operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Operation'
      tags:
      - Projects
  /projects/{project}/global/firewalls:
    get:
      summary: List firewalls
      operationId: listFirewalls
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of firewall rules
          content:
            application/json:
              schema:
                type: object
      tags:
      - Projects
    post:
      summary: Create firewall rule
      operationId: insertFirewall
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Long-running operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Operation'
      tags:
      - Projects
  /projects/{project}/zones/{zone}/machineTypes:
    get:
      summary: List machine types
      operationId: listMachineTypes
      parameters:
      - name: project
        in: path
        required: true
        schema:
          type: string
      - name: zone
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of machine types
          content:
            application/json:
              schema:
                type: object
      tags:
      - Projects
components:
  schemas:
    Instance:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        machineType:
          type: string
        status:
          type: string
        zone:
          type: string
        networkInterfaces:
          type: array
          items:
            type: object
        disks:
          type: array
          items:
            type: object
        metadata:
          type: object
        tags:
          type: object
        creationTimestamp:
          type: string
          format: date-time
    Disk:
      type: object
      properties:
        name:
          type: string
        sizeGb:
          type: string
        type:
          type: string
        sourceImage:
          type: string
        zone:
          type: string
    InstanceList:
      type: object
      properties:
        kind:
          type: string
        id:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/Instance'
        nextPageToken:
          type: string
    Operation:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        operationType:
          type: string
        status:
          type: string
        targetLink:
          type: string
        progress:
          type: integer
        startTime:
          type: string
          format: date-time
        endTime:
          type: string
          format: date-time
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            cloud-platform: View and manage your data across Google Cloud Platform services
            compute: View and manage your Google Compute Engine resources
            compute.readonly: View your Google Compute Engine resources