Koyeb PersistentVolumes API

openapi: 3.2.0
info:
  title: Koyeb Rest Persistent Volumes 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: PersistentVolumes
paths:
  /v1/volume_events:
    get:
      summary: List Persistent Volume events
      operationId: ListPersistentVolumeEvents
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPersistentVolumeEventsReply'
        '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: persistent_volume_id
        description: (Optional) Filter on persistent volume id
        in: query
        required: false
        schema:
          type: string
      - name: types
        description: (Optional) Filter on persistent volume 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:
      - PersistentVolumes
  /v1/volumes:
    get:
      summary: List all PersistentVolumes
      operationId: ListPersistentVolumes
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPersistentVolumesReply'
        '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: 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: service_id
        description: (Optional) A filter for the service id
        in: query
        required: false
        schema:
          type: string
      - name: region
        description: (Optional) A filter for the region
        in: query
        required: false
        schema:
          type: string
      - name: name
        description: (Optional) A filter for the name
        in: query
        required: false
        schema:
          type: string
      - name: project_id
        description: (Optional) A filter for the project ID
        in: query
        required: false
        schema:
          type: string
      - name: ids
        description: (Optional) Filter on volume ids
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      tags:
      - PersistentVolumes
    post:
      summary: Create a PersistentVolume
      operationId: CreatePersistentVolume
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePersistentVolumeReply'
        '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'
      tags:
      - PersistentVolumes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePersistentVolumeRequest'
        required: true
  /v1/volumes/{id}:
    get:
      summary: Get a PersistentVolume
      operationId: GetPersistentVolume
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPersistentVolumeReply'
        '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
        in: path
        required: true
        schema:
          type: string
      tags:
      - PersistentVolumes
    delete:
      summary: Delete a PersistentVolume
      operationId: DeletePersistentVolume
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePersistentVolumeReply'
        '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
        in: path
        required: true
        schema:
          type: string
      tags:
      - PersistentVolumes
    post:
      summary: Update a PersistentVolume
      operationId: UpdatePersistentVolume
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePersistentVolumeReply'
        '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
        in: path
        required: true
        schema:
          type: string
      tags:
      - PersistentVolumes
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  title: (Optional) change the name of the volume
                max_size:
                  type: integer
                  format: int64
                  title: (Optional) increase the volume size (in Gigabyte / GB)
        required: true
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    }"
    PersistentVolume:
      type: object
      properties:
        id:
          type: string
          title: the identifier for the volume object
        name:
          type: string
          title: the volume name
        snapshot_id:
          type: string
          title: (optional) the id of the snapshot whence the volume comes from
        created_at:
          type: string
          format: date-time
          title: creation timestamp
        updated_at:
          type: string
          format: date-time
          title: last change timestamp
        deleted_at:
          type: string
          format: date-time
          title: deletion timestamp
        organization_id:
          type: string
          title: the organization to which the volume belongs to
        service_id:
          type: string
          title: the service_id to which the volume is eventually bound to
        region:
          type: string
          title: the region where the volume exists
        read_only:
          type: boolean
          title: whether to mount the volume in read-only mode
        max_size:
          type: integer
          format: int64
          title: the maximum size of the volume (in Gigabyte / GB)
        cur_size:
          type: integer
          format: int64
          title: the used amount of space as measured the last time (in Gigabyte / GB)
        status:
          $ref: '#/components/schemas/PersistentVolumeStatus'
          title: the status of the volume
        backing_store:
          $ref: '#/components/schemas/PersistentVolumeBackingStore'
          title: the backing store type
      title: The object that represent a volume to handle persistency for deployments
    PersistentVolumeEvent:
      type: object
      properties:
        id:
          type: string
        when:
          type: string
          format: date-time
        organization_id:
          type: string
        persistent_volume_id:
          type: string
        type:
          type: string
        message:
          type: string
        metadata:
          type: object
    PersistentVolumeStatus:
      type: string
      enum:
      - PERSISTENT_VOLUME_STATUS_INVALID
      - PERSISTENT_VOLUME_STATUS_ATTACHED
      - PERSISTENT_VOLUME_STATUS_DETACHED
      - PERSISTENT_VOLUME_STATUS_DELETING
      - PERSISTENT_VOLUME_STATUS_DELETED
      - PERSISTENT_VOLUME_STATUS_ARCHIVING
      default: PERSISTENT_VOLUME_STATUS_INVALID
      title: "- PERSISTENT_VOLUME_STATUS_INVALID: zero value, invalid\n - PERSISTENT_VOLUME_STATUS_ATTACHED: the volume is attached to an instance\n - PERSISTENT_VOLUME_STATUS_DETACHED: the volume is free to use\n - PERSISTENT_VOLUME_STATUS_DELETING: the volume will be deleted\n - PERSISTENT_VOLUME_STATUS_DELETED: the volume was deleted\n - PERSISTENT_VOLUME_STATUS_ARCHIVING: the volume is being archived (snapshot being created and migrated to remote storage)"
    ListPersistentVolumesReply:
      type: object
      properties:
        volumes:
          type: array
          items:
            $ref: '#/components/schemas/PersistentVolume'
          title: The collection of persistent volumes
        limit:
          type: integer
          format: int64
          title: The limit in the request
        offset:
          type: integer
          format: int64
          title: The offset in the request
        has_next:
          type: boolean
          title: If there is more items after in the collection
    UpdatePersistentVolumeReply:
      type: object
      properties:
        volume:
          $ref: '#/components/schemas/PersistentVolume'
    GetPersistentVolumeReply:
      type: object
      properties:
        volume:
          $ref: '#/components/schemas/PersistentVolume'
    Error:
      type: object
      properties:
        status:
          type: integer
          format: int32
        code:
          type: string
        message:
          type: string
    CreatePersistentVolumeReply:
      type: object
      properties:
        volume:
          $ref: '#/components/schemas/PersistentVolume'
    DeletePersistentVolumeReply:
      type: object
      properties:
        volume:
          $ref: '#/components/schemas/PersistentVolume'
    CreatePersistentVolumeRequest:
      type: object
      properties:
        volume_type:
          $ref: '#/components/schemas/PersistentVolumeBackingStore'
          title: the volume backing store type
        name:
          type: string
          title: the volume name
        region:
          type: string
          title: the volume region
        read_only:
          type: boolean
          title: whether the volume must be set as read only
        max_size:
          type: integer
          format: int64
          title: the size of the volume (in Gigabyte / GB)
        snapshot_id:
          type: string
          title: (optional) the id of the snapshot whence the volume comes from
        project_id:
          type: string
          title: (Optional) The project ID to associate with the volume
    ErrorWithFields:
      type: object
      properties:
        status:
          type: integer
          format: int32
        code:
          type: string
        message:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ErrorField'
    ListPersistentVolumeEventsReply:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/PersistentVolumeEvent'
          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
    PersistentVolumeBackingStore:
      type: string
      enum:
      - PERSISTENT_VOLUME_BACKING_STORE_INVALID
      - PERSISTENT_VOLUME_BACKING_STORE_LOCAL_BLK
      default: PERSISTENT_VOLUME_BACKING_STORE_INVALID
      title: "- PERSISTENT_VOLUME_BACKING_STORE_INVALID: zero value, invalid\n - PERSISTENT_VOLUME_BACKING_STORE_LOCAL_BLK: the backing store is a locally reachable block device"
    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