openapi: 3.0.3
info:
  title: International Business Machines IBM Cloud Object Storage Analyze Instances API
  description: The IBM Cloud Object Storage API provides a RESTful interface compatible with S3 for storing and retrieving objects in buckets. It supports features such as multipart uploads, versioning, lifecycle policies, and server-side encryption.
  version: 1.0.0
  contact:
    name: IBM Cloud
    url: https://cloud.ibm.com/docs/cloud-object-storage
  license:
    name: IBM Cloud Terms
    url: https://www.ibm.com/terms
servers:
- url: https://s3.us-south.cloud-object-storage.appdomain.cloud
  description: US South
- url: https://s3.eu-de.cloud-object-storage.appdomain.cloud
  description: EU Germany
- url: https://s3.eu-gb.cloud-object-storage.appdomain.cloud
  description: EU Great Britain
security:
- bearerAuth: []
tags:
- name: Instances
  description: Manage virtual server instances.
paths:
  /v1/instances:
    get:
      operationId: listInstances
      summary: International Business Machines List instances
      description: List all virtual server instances in the region.
      tags:
      - Instances
      parameters:
      - name: version
        in: query
        required: true
        schema:
          type: string
      - name: generation
        in: query
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response
    post:
      operationId: createInstance
      summary: International Business Machines Create an instance
      description: Create a new virtual server instance.
      tags:
      - Instances
      parameters:
      - name: version
        in: query
        required: true
        schema:
          type: string
      - name: generation
        in: query
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInstanceRequest'
      responses:
        '201':
          description: Instance created
components:
  schemas:
    CreateInstanceRequest:
      type: object
      required:
      - name
      - profile
      - vpc
      - primary_network_interface
      - image
      - zone
      properties:
        name:
          type: string
        profile:
          type: object
          properties:
            name:
              type: string
        vpc:
          type: object
          properties:
            id:
              type: string
        primary_network_interface:
          type: object
          properties:
            subnet:
              type: object
              properties:
                id:
                  type: string
        image:
          type: object
          properties:
            id:
              type: string
        zone:
          type: object
          properties:
            name:
              type: string
        keys:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: IAM Token