swagger: '2.0'
info:
  title: Koyeb Rest activity CatalogInstances API
  description: 'The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests.

    '
  version: 1.0.0
host: app.koyeb.com
schemes:
- https
security:
- Bearer: []
tags:
- name: CatalogInstances
paths:
  /v1/catalog/instances:
    get:
      summary: List Instances
      operationId: ListCatalogInstances
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/ListCatalogInstancesReply'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/google.rpc.Status'
      parameters:
      - name: limit
        description: (Optional) The number of items to return
        in: query
        required: false
        type: string
      - name: offset
        description: (Optional) The offset in the list of item to return
        in: query
        required: false
        type: string
      - name: id
        description: (Optional) A filter for instances
        in: query
        required: false
        type: string
      tags:
      - CatalogInstances
  /v1/catalog/instances/{id}:
    get:
      summary: Get Instance
      operationId: GetCatalogInstance
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/GetCatalogInstanceReply'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/google.rpc.Status'
      parameters:
      - name: id
        description: The name of the instance
        in: path
        required: true
        type: string
      tags:
      - CatalogInstances
definitions:
  google.rpc.Status:
    type: object
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/google.protobuf.Any'
  CatalogInstance:
    type: object
    properties:
      id:
        type: string
        title: The name of the instance
      description:
        type: string
        title: A short description of the instance
      vcpu:
        type: integer
        format: int64
        description: The number of cpus. Deprecated. Use vcpu_shares instead.
      memory:
        type: string
        title: The memory in bytes in a format like 5MB
      disk:
        type: string
        title: The size of the disk in bytes in a format like 5MB
      price_per_second:
        type: string
        title: The price to pay per second
      price_hourly:
        type: string
        title: The price to pay per hour
      price_monthly:
        type: string
        title: The price to pay per month
      regions:
        type: array
        items:
          type: string
        title: The regions where this instance type is available
      status:
        type: string
        title: The status of the instance
      require_plan:
        type: array
        items:
          type: string
        title: The plan required to use instance
      vcpu_shares:
        type: number
        format: float
        description: The number of vcpu shares reserved for the instance.
      display_name:
        type: string
        title: The display name of the instance
      aliases:
        type: array
        items:
          type: string
        title: Aliases
      type:
        type: string
        title: The type of the instance (e.g. "gpu")
      gpu:
        $ref: '#/definitions/CatalogGPUDetails'
        title: GPU details
      service_types:
        type: array
        items:
          type: string
        title: Allowed service types for this instance (e.g. ["web", "worker"])
      volumes_enabled:
        type: boolean
        title: Are the volumes enabled for this instance type
      light_sleep_enabled:
        type: boolean
        title: Is light sleep enabled for this instance type
  ListCatalogInstancesReply:
    type: object
    properties:
      instances:
        type: array
        items:
          $ref: '#/definitions/CatalogInstanceListItem'
      limit:
        type: integer
        format: int64
        title: The limit in the request
      offset:
        type: integer
        format: int64
        title: The offset in the request
      count:
        type: integer
        format: int64
        title: The total number of items
  CatalogGPUDetails:
    type: object
    properties:
      count:
        type: integer
        format: int64
        title: The number of GPUs
      brand:
        type: string
        title: The brand of GPU
      memory:
        type: string
        title: GPU memory
      name:
        type: string
        title: Name of GPU
  google.protobuf.Any:
    type: object
    properties:
      '@type':
        type: string
    additionalProperties: {}
  CatalogInstanceListItem:
    type: object
    properties:
      id:
        type: string
        title: The name of the instance
      description:
        type: string
        title: A short description of the instance
      vcpu:
        type: integer
        format: int64
        description: The number of cpus. Deprecated. Use vcpu_shares instead.
      memory:
        type: string
        title: The memory in bytes in a format like 5MB
      disk:
        type: string
        title: The size of the disk in bytes in a format like 5MB
      price_per_second:
        type: string
        title: The price to pay per second
      price_hourly:
        type: string
        title: The price to pay per hour
      price_monthly:
        type: string
        title: The price to pay per month
      regions:
        type: array
        items:
          type: string
        title: The regions where this instance type is available
      status:
        type: string
        title: The status of the instance
      require_plan:
        type: array
        items:
          type: string
        title: The plan required to use instance
      vcpu_shares:
        type: number
        format: float
        description: The number of vcpu shares reserved for the instance.
      display_name:
        type: string
        title: The display name of the instance
      aliases:
        type: array
        items:
          type: string
        title: Aliases
      type:
        type: string
        title: The type of the instance (e.g. "gpu")
      gpu:
        $ref: '#/definitions/CatalogGPUDetails'
        title: GPU details
      service_types:
        type: array
        items:
          type: string
        title: Allowed service types for this instance (e.g. ["web", "worker"])
      volumes_enabled:
        type: boolean
        title: Are the volumes enabled for this instance type
      light_sleep_enabled:
        type: boolean
        title: Is light sleep enabled for this instance type
  GetCatalogInstanceReply:
    type: object
    properties:
      instance:
        $ref: '#/definitions/CatalogInstance'
        title: The instance retrieved
securityDefinitions:
  Bearer:
    type: apiKey
    name: Authorization
    in: header
x-tagGroups:
- name: Introduction
  tags:
  - intro
- name: API
  tags:
  - Profile
  - Sessions
  - Users
  - organization
  - OrganizationMembers
  - OrganizationInvitations
  - OrganizationConfirmations
  - Subscriptions
  - Coupons
  - Credentials
  - Secrets
  - activity
  - Apps
  - Services
  - Deployments
  - Archives
  - RegionalDeployments
  - Instances
  - Domains
  - PersistentVolumes
  - Snapshots
  - Compose
  - Repositories
  - Logs
  - Metrics
  - Catalog
  - CatalogRegions
  - CatalogInstances
  - Usages
  - Summary
  - DockerHelper