Koyeb Instances API

openapi: 3.2.0
info:
  title: Koyeb Rest Instances 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
servers:
- url: https://app.koyeb.com
security:
- Bearer: []
tags:
- name: Instances
paths:
  /v1/instance_events:
    get:
      summary: List Instance events
      operationId: ListInstanceEvents
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInstanceEventsReply'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorWithFields'
        '401':
          description: Returned when the token is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Returned when the user does not have permission to access the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Returned when the resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Returned in case of server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      parameters:
      - name: instance_ids
        description: (Optional) Filter on list of instance id
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: types
        description: (Optional) Filter on instance event types
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: limit
        description: (Optional) The number of items to return
        in: query
        required: false
        schema:
          type: string
      - name: offset
        description: (Optional) The offset in the list of item to return
        in: query
        required: false
        schema:
          type: string
      - name: order
        description: (Optional) Sorts the list in the ascending or the descending order
        in: query
        required: false
        schema:
          type: string
      tags:
      - Instances
  /v1/instances:
    get:
      summary: List Instances
      operationId: ListInstances
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInstancesReply'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorWithFields'
        '401':
          description: Returned when the token is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Returned when the user does not have permission to access the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Returned when the resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Returned in case of server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      parameters:
      - name: app_id
        description: (Optional) Filter on application id
        in: query
        required: false
        schema:
          type: string
      - name: service_id
        description: (Optional) Filter on service id
        in: query
        required: false
        schema:
          type: string
      - name: deployment_id
        description: (Optional) Filter on deployment id
        in: query
        required: false
        schema:
          type: string
      - name: regional_deployment_id
        description: (Optional) Filter on regional deployment id
        in: query
        required: false
        schema:
          type: string
      - name: allocation_id
        description: (Optional) Filter on allocation id
        in: query
        required: false
        schema:
          type: string
      - name: replica_index
        description: (Optional) Filter on replica index
        in: query
        required: false
        schema:
          type: string
      - name: statuses
        description: (Optional) Filter on instance statuses
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - ALLOCATING
            - STARTING
            - HEALTHY
            - UNHEALTHY
            - STOPPING
            - STOPPED
            - ERROR
            - SLEEPING
      - name: limit
        description: (Optional) The number of items to return
        in: query
        required: false
        schema:
          type: string
      - name: offset
        description: (Optional) The offset in the list of item to return
        in: query
        required: false
        schema:
          type: string
      - name: order
        description: (Optional) Sorts the list in the ascending or the descending order
        in: query
        required: false
        schema:
          type: string
      - name: starting_time
        description: (Optional) The starting time of the period of running instance
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: ending_time
        description: (Optional) The ending time of the period of running instance
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: ids
        description: (Optional) Filter on instance ids
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      tags:
      - Instances
  /v1/instances/{id}:
    get:
      summary: Get Instance
      operationId: GetInstance
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInstanceReply'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorWithFields'
        '401':
          description: Returned when the token is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Returned when the user does not have permission to access the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Returned when the resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Returned in case of server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      parameters:
      - name: id
        description: The id of the instance
        in: path
        required: true
        schema:
          type: string
      tags:
      - Instances
  /v1/streams/instances/exec:
    get:
      summary: Exec Command
      description: This endpoint opens a websocket. Once open, all frames going through the websocket should be formatted in JSON. Input frames should match the format specified below. Output frames will match the response schema.
      operationId: ExecCommand
      responses:
        '200':
          description: A successful response.(streaming responses)
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    $ref: '#/components/schemas/ExecCommandReply'
                  error:
                    $ref: '#/components/schemas/google.rpc.Status'
                title: Stream result of ExecCommandReply
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorWithFields'
        '401':
          description: Returned when the token is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Returned when the user does not have permission to access the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Returned when the resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Returned in case of server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      parameters:
      - name: id
        description: ID of the resource to exec on.
        in: query
        required: false
        schema:
          type: string
      - name: body.command
        description: Command to exec. Mandatory in the first frame sent
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: body.tty_size.height
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: body.tty_size.width
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: body.stdin.data
        description: Data is base64 encoded
        in: query
        required: false
        schema:
          type: string
          format: byte
      - name: body.stdin.close
        description: Indicate last data frame
        in: query
        required: false
        schema:
          type: boolean
      - name: body.disableTty
        description: Disable TTY. It's enough to specify it in the first frame
        in: query
        required: false
        schema:
          type: boolean
      - name: id_type
        description: When specified, it is used to determine if the kind of resource the id refers to. If missing, defaults to the instance id.
        in: query
        required: false
        schema:
          type: string
          enum:
          - INVALID
          - INSTANCE_ID
          - SERVICE_ID
          default: INVALID
      tags:
      - Instances
components:
  schemas:
    ErrorField:
      type: object
      properties:
        field:
          type: string
        description:
          type: string
    google.protobuf.Any:
      type: object
      properties:
        '@type':
          type: string
          description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
      additionalProperties: {}
      description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := &pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
    ListInstanceEventsReply:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/InstanceEvent'
          title: The collection of events
        limit:
          type: integer
          format: int64
          title: The limit in the request
        offset:
          type: integer
          format: int64
          title: The offset in the request
        order:
          type: string
          title: The order in the request
        has_next:
          type: boolean
          title: If there is more items after in the collection
    ListInstancesReply:
      type: object
      properties:
        instances:
          type: array
          items:
            $ref: '#/components/schemas/InstanceListItem'
          title: The collection of instances
        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
        order:
          type: string
          title: The order in the request
    ExecCommandIO:
      type: object
      properties:
        data:
          type: string
          format: byte
          description: Data is base64 encoded
        close:
          type: boolean
          description: Indicate last data frame
    Error:
      type: object
      properties:
        status:
          type: integer
          format: int32
        code:
          type: string
        message:
          type: string
    InstanceListItem:
      type: object
      properties:
        id:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        organization_id:
          type: string
        app_id:
          type: string
        service_id:
          type: string
        regional_deployment_id:
          type: string
        allocation_id:
          type: string
        type:
          type: string
        replica_index:
          type: integer
          format: int64
        region:
          type: string
        datacenter:
          type: string
        status:
          $ref: '#/components/schemas/Instance.Status'
        messages:
          type: array
          items:
            type: string
        xyz_deployment_id:
          type: string
          description: 'WARNING: Please don''t use the following attribute.

            Koyeb doesn''t guarantee backwards compatible breaking change and reserve the right to completely drop it without notice.

            USE AT YOUR OWN RISK.'
    GetInstanceReply:
      type: object
      properties:
        instance:
          $ref: '#/components/schemas/Instance'
    ExecCommandReply:
      type: object
      properties:
        stdout:
          $ref: '#/components/schemas/ExecCommandIO'
        stderr:
          $ref: '#/components/schemas/ExecCommandIO'
        exited:
          type: boolean
        exit_code:
          type: integer
          format: int32
    Instance:
      type: object
      properties:
        id:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        organization_id:
          type: string
        app_id:
          type: string
        service_id:
          type: string
        regional_deployment_id:
          type: string
        allocation_id:
          type: string
        type:
          type: string
        replica_index:
          type: integer
          format: int64
        region:
          type: string
        datacenter:
          type: string
        hypervisor:
          type: string
        status:
          $ref: '#/components/schemas/Instance.Status'
        messages:
          type: array
          items:
            type: string
        started_at:
          type: string
          format: date-time
        succeeded_at:
          type: string
          format: date-time
        terminated_at:
          type: string
          format: date-time
        xyz_deployment_id:
          type: string
          description: 'WARNING: Please don''t use the following attribute.

            Koyeb doesn''t guarantee backwards compatible breaking change and reserve the right to completely drop it without notice.

            USE AT YOUR OWN RISK.'
    ErrorWithFields:
      type: object
      properties:
        status:
          type: integer
          format: int32
        code:
          type: string
        message:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ErrorField'
    InstanceEvent:
      type: object
      properties:
        id:
          type: string
        when:
          type: string
          format: date-time
        organization_id:
          type: string
        instance_id:
          type: string
        type:
          type: string
        message:
          type: string
        metadata:
          type: object
    Instance.Status:
      type: string
      enum:
      - ALLOCATING
      - STARTING
      - HEALTHY
      - UNHEALTHY
      - STOPPING
      - STOPPED
      - ERROR
      - SLEEPING
      default: ALLOCATING
    google.rpc.Status:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
x-tagGroups:
- name: Introduction
  tags:
  - intro
- name: API
  tags:
  - Profile
  - Sessions
  - Users
  - organization
  - Projects
  - 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