Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Koyeb Snapshots API

The Snapshots API from Koyeb — 2 operation(s) for snapshots.

Koyeb Snapshots API is one of 42 APIs that Koyeb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Snapshots. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://app.koyeb.com.

5 operations 2 paths 14 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://app.koyeb.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Koyeb Snapshots API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Snapshots 5
GET
/v1/snapshots
List all Snapshots
ListSnapshots 5 params → 200400401403404500503default
POST
/v1/snapshots
Create a Snapshot
CreateSnapshot 1 param → 200400401403404500503default
GET
/v1/snapshots/{id}
Get a Snapshot
GetSnapshot 1 param → 200400401403404500503default
DELETE
/v1/snapshots/{id}
Delete a Snapshot
DeleteSnapshot 1 param → 200400401403404500503default
POST
/v1/snapshots/{id}
Update a Snapshot
UpdateSnapshot 2 params → 200400401403404500503default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Snapshot (11 properties), ListSnapshotsReply (4 properties), ErrorWithFields (4 properties), google.rpc.Status (3 properties). Each schema is shown below with its type and property counts.

CreateSnapshotReply
object
1 property
UpdateSnapshotReply
object
1 property
google.rpc.Status
object
3 properties
ListSnapshotsReply
object
4 properties
SnapshotStatus
string
SnapshotType
string
GetSnapshotReply
object
1 property
ErrorWithFields
object
4 properties
Snapshot
object
The object that represents a snapshot. It can either be local, on a node, or remote, in a cold storage.
11 properties
google.protobuf.Any
object
1 property
CreateSnapshotRequest
object
3 properties
ErrorField
object
2 properties
Error
object
3 properties
DeleteSnapshotReply
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koyeb-snapshots-api-openapi.yml Raw ↑

Other APIs Koyeb publishes across the network.

Koyeb activity API
Koyeb Apps API
Koyeb Archives API
Koyeb billing API
Koyeb CatalogDatacenters API
Koyeb CatalogInstances API
Koyeb CatalogInstanceUsage API
Koyeb CatalogRegions API
Koyeb Compose API
Koyeb Coupons API
Koyeb Credentials API
Koyeb Deployments API