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

The Apps API from Koyeb — 5 operation(s) for apps.

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

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

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

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

9 operations 5 paths 25 schemas 1 DELETE3 GET1 PATCH3 POST1 PUT

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 Apps 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 9

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

Apps 9
GET
/v1/app_events
List App events
ListAppEvents 5 params → 200400401403404500503default
GET
/v1/apps
List App
ListApps 4 params → 200400401403404500503default
POST
/v1/apps
Create App
CreateApp 1 param → 200400401403404500503default
GET
/v1/apps/{id}
Get App
GetApp 1 param → 200400401403404500503default
DELETE
/v1/apps/{id}
Delete App
DeleteApp 1 param → 200400401403404500503default
PUT
/v1/apps/{id}
Update App
UpdateApp 3 params → 200400401403404500503default
PATCH
/v1/apps/{id}
Update App
UpdateApp2 3 params → 200400401403404500503default
POST
/v1/apps/{id}/pause
Pause App
PauseApp 1 param → 200400401403404500503default
POST
/v1/apps/{id}/resume
Resume App
ResumeApp 1 param → 200400401403404500503default

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are App (15 properties), Domain (15 properties), AppListItem (8 properties), AppEvent (7 properties). Each schema is shown below with its type and property counts.

GetAppReply
object
1 property
AppListItem
object
8 properties
Domain.LoadBalancerKoyeb
object
1 property
CreateAppReply
object
1 property
Domain.LoadBalancerCloudflare
object
DeleteAppReply
object
ErrorWithFields
object
4 properties
AppLifeCycle
object
1 property
App
object
15 properties
ErrorField
object
2 properties
Error
object
3 properties
AppEvent
object
7 properties
google.rpc.Status
object
3 properties
ListAppsReply
object
5 properties
App.Status
string
Domain.Type
string
Domain.Status
string
ResumeAppReply
object
ListAppEventsReply
object
5 properties
CreateApp
object
3 properties
Domain
object
15 properties
UpdateApp
object
2 properties
PauseAppReply
object
google.protobuf.Any
object
1 property
UpdateAppReply
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koyeb-apps-api-openapi.yml Raw ↑

Other APIs Koyeb publishes across the network.

Koyeb activity 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
Koyeb DockerHelper API