openapi: 3.0.3
info:
  title: International Business Machines IBM Cloud Object Storage Analyze VPCs 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: VPCs
  description: Manage Virtual Private Clouds.
paths:
  /v1/vpcs:
    get:
      operationId: listVpcs
      summary: International Business Machines List VPCs
      description: List all VPCs in the region.
      tags:
      - VPCs
      parameters:
      - name: version
        in: query
        required: true
        schema:
          type: string
      - name: generation
        in: query
        required: true
        schema:
          type: integer
          enum:
          - 2
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  vpcs:
                    type: array
                    items:
                      $ref: '#/components/schemas/VPC'
    post:
      operationId: createVpc
      summary: International Business Machines Create a VPC
      description: Create a new VPC.
      tags:
      - VPCs
      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:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                address_prefix_management:
                  type: string
                resource_group:
                  type: object
                  properties:
                    id:
                      type: string
      responses:
        '201':
          description: VPC created
components:
  schemas:
    VPC:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
        crn:
          type: string
        classic_access:
          type: boolean
        created_at:
          type: string
          format: date-time
        default_security_group:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
        resource_group:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: IAM Token