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 Instances API

The Instances API from Koyeb — 4 operation(s) for instances.

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

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

This API exposes 4 operations across 4 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.

4 operations 4 paths 14 schemas 4 GET

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 Instances 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 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Instances 4
GET
/v1/streams/instances/exec
Exec Command
ExecCommand 8 params → 200400401403404500503default
GET
/v1/instance_events
List Instance events
ListInstanceEvents 5 params → 200400401403404500503default
GET
/v1/instances
List Instances
ListInstances 12 params → 200400401403404500503default
GET
/v1/instances/{id}
Get Instance
GetInstance 1 param → 200400401403404500503default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Instance (19 properties), InstanceListItem (15 properties), InstanceEvent (7 properties), ListInstanceEventsReply (5 properties). Each schema is shown below with its type and property counts.

google.rpc.Status
object
3 properties
GetInstanceReply
object
1 property
InstanceEvent
object
7 properties
Instance.Status
string
InstanceListItem
object
15 properties
ErrorWithFields
object
4 properties
Instance
object
19 properties
ListInstanceEventsReply
object
5 properties
google.protobuf.Any
object
1 property
ExecCommandIO
object
2 properties
ErrorField
object
2 properties
ExecCommandReply
object
4 properties
Error
object
3 properties
ListInstancesReply
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koyeb-instances-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