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

The Compose API from Koyeb — 1 operation(s) for compose.

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

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

This API exposes 1 operation across 1 path, and defines 61 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

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

1 operations 1 paths 61 schemas 1 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 Compose 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Compose 1
POST
/v1/compose
Create resources from compose.
Compose 1 param → 200400401403404500503default

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are Service (20 properties), DeploymentDefinition (18 properties), Domain (15 properties), App (15 properties). Each schema is shown below with its type and property counts.

GitSource
object
10 properties
DesiredDeployment.Group
object
2 properties
NeonPostgresDatabase.NeonRole
object
2 properties
BasicAuthPolicy
object
2 properties
ServiceState
object
2 properties
AutoRelease
object
1 property
DeploymentScalingTargetSleepIdleDelay
object
3 properties
Domain.LoadBalancerKoyeb
object
1 property
DeploymentStrategy
object
1 property
DesiredDeployment
object
1 property
DeploymentDefinition
object
18 properties
ProxyPortProtocol
string
DockerSource
object
6 properties
DeploymentProxyPort
object
2 properties
DeploymentPort
object
2 properties
Domain.LoadBalancerCloudflare
object
BuildpackBuilder
object
3 properties
DeploymentScalingTargetAverageCPU
object
1 property
DeploymentScaling
object
4 properties
DeploymentScalingTarget
object
6 properties
DeploymentScalingTargetConcurrentRequests
object
1 property
NeonPostgresDatabase
object
5 properties
CreateService
object
4 properties
AutoRelease.Group
object
4 properties
DeploymentStrategyType
string
- DEPLOYMENTSTRATEGYTYPEINVALID: DEPRECATED: Use DEPLOYMENTSTRATEGYTYPEDEFAULT instead. - DEPLOYMENTSTRATEGYTYPEDEFAULT: Default/unspecified strategy (resolves…
ErrorWithFields
object
4 properties
NeonPostgresDatabase.NeonDatabase
object
2 properties
AppLifeCycle
object
1 property
ComposeReply
object
2 properties
CreateCompose
object
2 properties
App
object
15 properties
Service.Type
string
DeploymentInstanceType
object
2 properties
ErrorField
object
2 properties
Error
object
3 properties
ArchiveSource
object
3 properties
DeploymentRoute
object
3 properties
google.rpc.Status
object
3 properties
App.Status
string
Domain.Type
string
Domain.Status
string
DeploymentEnv
object
4 properties
DatabaseSource
object
1 property
DeploymentDefinition.Type
string
CreateApp
object
3 properties
Domain
object
15 properties
DockerBuilder
object
6 properties
DeploymentScalingTargetRequestsPerSecond
object
1 property
HTTPHeader
object
2 properties
DeploymentHealthCheck
object
6 properties
TCPHealthCheck
object
1 property
DeploymentScalingTargetAverageMem
object
1 property
ConfigFile
object
3 properties
Service.Status
string
HTTPHealthCheck
object
4 properties
DeploymentVolume
object
4 properties
DeploymentScalingTargetRequestsResponseTime
object
2 properties
SecurityPolicies
object
2 properties
google.protobuf.Any
object
1 property
ServiceLifeCycle
object
2 properties
Service
object
20 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koyeb-compose-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 Coupons API
Koyeb Credentials API
Koyeb Deployments API
Koyeb DockerHelper API