openapi: 3.2.0 info: title: Koyeb Rest Instance Snapshots 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: InstanceSnapshots paths: /v1/instance_snapshot_events: get: operationId: ListInstanceSnapshotEvents responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/ListInstanceSnapshotEventsReply' '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_snapshot_id description: (Optional) Filter on instance snapshot id in: query required: false schema: type: string - name: types description: (Optional) Filter on instance snapshot 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: - InstanceSnapshots /v1/instance_snapshots: get: operationId: ListInstanceSnapshots responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/ListInstanceSnapshotsReply' '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 in: query required: false schema: type: string - name: offset in: query required: false schema: type: string - name: name in: query required: false schema: type: string - name: statuses in: query required: false style: form explode: true schema: type: array items: type: string enum: - INSTANCE_SNAPSHOT_STATUS_INVALID - INSTANCE_SNAPSHOT_STATUS_CREATING - INSTANCE_SNAPSHOT_STATUS_AVAILABLE - INSTANCE_SNAPSHOT_STATUS_ERROR - INSTANCE_SNAPSHOT_STATUS_DELETING - INSTANCE_SNAPSHOT_STATUS_DELETED - name: type in: query required: false schema: type: string enum: - INSTANCE_SNAPSHOT_TYPE_INVALID - INSTANCE_SNAPSHOT_TYPE_FILESYSTEM - INSTANCE_SNAPSHOT_TYPE_FULL default: INSTANCE_SNAPSHOT_TYPE_INVALID - name: ids in: query required: false style: form explode: true schema: type: array items: type: string tags: - InstanceSnapshots post: operationId: CreateInstanceSnapshot responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/CreateInstanceSnapshotReply' '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: - InstanceSnapshots requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateInstanceSnapshotRequest' required: true /v1/instance_snapshots/{id}: get: operationId: GetInstanceSnapshot responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/GetInstanceSnapshotReply' '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: - InstanceSnapshots delete: operationId: DeleteInstanceSnapshot responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/DeleteInstanceSnapshotReply' '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: - InstanceSnapshots components: schemas: ErrorField: type: object properties: field: type: string description: type: string InstanceSnapshotEvent: type: object properties: id: type: string when: type: string format: date-time organization_id: type: string instance_snapshot_id: type: string type: type: string message: type: string metadata: type: object 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\": ,\n \"lastName\": \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 }" InstanceSnapshot: type: object properties: id: type: string name: type: string created_at: type: string format: date-time updated_at: type: string format: date-time available_at: type: string format: date-time deleted_at: type: string format: date-time organization_id: type: string project_id: type: string service_id: type: string deployment_id: type: string regional_deployment_id: type: string instance_id: type: string status: $ref: '#/components/schemas/InstanceSnapshotStatus' type: $ref: '#/components/schemas/InstanceSnapshotType' version: type: string format: uint64 messages: type: array items: type: string GetInstanceSnapshotReply: type: object properties: instance_snapshot: $ref: '#/components/schemas/InstanceSnapshot' InstanceSnapshotType: type: string enum: - INSTANCE_SNAPSHOT_TYPE_INVALID - INSTANCE_SNAPSHOT_TYPE_FILESYSTEM - INSTANCE_SNAPSHOT_TYPE_FULL default: INSTANCE_SNAPSHOT_TYPE_INVALID InstanceSnapshotStatus: type: string enum: - INSTANCE_SNAPSHOT_STATUS_INVALID - INSTANCE_SNAPSHOT_STATUS_CREATING - INSTANCE_SNAPSHOT_STATUS_AVAILABLE - INSTANCE_SNAPSHOT_STATUS_ERROR - INSTANCE_SNAPSHOT_STATUS_DELETING - INSTANCE_SNAPSHOT_STATUS_DELETED default: INSTANCE_SNAPSHOT_STATUS_INVALID ListInstanceSnapshotEventsReply: type: object properties: events: type: array items: $ref: '#/components/schemas/InstanceSnapshotEvent' 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 ListInstanceSnapshotsReply: type: object properties: instance_snapshots: type: array items: $ref: '#/components/schemas/InstanceSnapshot' limit: type: integer format: int64 offset: type: integer format: int64 count: type: integer format: int64 has_next: type: boolean DeleteInstanceSnapshotReply: type: object properties: instance_snapshot: $ref: '#/components/schemas/InstanceSnapshot' CreateInstanceSnapshotReply: type: object properties: instance_snapshot: $ref: '#/components/schemas/InstanceSnapshot' Error: type: object properties: status: type: integer format: int32 code: type: string message: type: string CreateInstanceSnapshotRequest: type: object properties: instance_id: type: string name: type: string type: $ref: '#/components/schemas/InstanceSnapshotType' ErrorWithFields: type: object properties: status: type: integer format: int32 code: type: string message: type: string fields: type: array items: $ref: '#/components/schemas/ErrorField' 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