How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 44 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 68 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.koyeb.com.

1 operations 1 paths 68 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.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 body → 200400401403404500503default

Schemas 68

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

DeploymentScalingTargetRequestsResponseTime
object
2 properties
EgressPolicyMode
string
SecurityPolicies
object
2 properties
Domain.LoadBalancerKoyeb
object
1 property
Service.Type
string
DeploymentDefinition
object
20 properties
NeonPostgresDatabase
object
5 properties
ArchiveSource
object
3 properties
Domain
object
16 properties
DeploymentRoute
object
3 properties
Service.Status
string
DeploymentVolume
object
4 properties
Mesh
object
Mesh groups the mesh scope selector and the (optional) custom mesh name. Kept inside NetworkPolicy so scope/name and other network-policy dimensions (egress, f…
2 properties
Domain.Type
string
DeploymentScaling
object
4 properties
DeploymentScalingTargetAverageMem
object
1 property
HTTPHeader
object
2 properties
AutoRelease.Group
object
4 properties
GitSource
object
10 properties
NetworkPolicy
object
2 properties
DeploymentMesh
string
Service
object
22 properties
DockerBuilder
object
6 properties
BasicAuthPolicy
object
2 properties
App.Status
string
CreateService
object
7 properties
DeploymentScalingTargetConcurrentRequests
object
1 property
DockerSource
object
6 properties
ServiceLifeCycle
object
2 properties
Domain.LoadBalancerCloudflare
object
ProxyPortProtocol
string
google.rpc.Status
object
3 properties
ErrorField
object
2 properties
DeploymentScalingTargetAverageCPU
object
1 property
google.protobuf.Any
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
DatabaseSource
object
1 property
Error
object
3 properties
HTTPHealthCheck
object
4 properties
BuildpackBuilder
object
3 properties
ServiceState
object
2 properties
AppLifeCycle
object
1 property
DesiredDeployment
object
1 property
App
object
15 properties
CreateCompose
object
2 properties
DeploymentScalingTarget
object
6 properties
DeploymentHealthCheck
object
6 properties
DesiredDeployment.Group
object
2 properties
DeploymentEnv
object
4 properties
DeploymentScalingTargetSleepIdleDelay
object
3 properties
DeploymentPort
object
2 properties
ComposeReply
object
2 properties
TCPHealthCheck
object
1 property
MeshScope
string
MeshScope selects which set of services can communicate over the mesh. Only meaningful when the mesh is on (i.e. DeploymentMesh is ENABLED, or AUTO and the ser…
NetworkPolicyDestination
object
1 property
NeonPostgresDatabase.NeonDatabase
object
2 properties
NeonPostgresDatabase.NeonRole
object
2 properties
ConfigFile
object
3 properties
EgressPolicy
object
2 properties
Domain.Status
string
DeploymentProxyPort
object
2 properties
AutoRelease
object
1 property
DeploymentInstanceType
object
2 properties
DeploymentDefinition.Type
string
ErrorWithFields
object
4 properties
DeploymentStrategyType
string
- DEPLOYMENTSTRATEGYTYPEINVALID: DEPRECATED: Use DEPLOYMENTSTRATEGYTYPEDEFAULT instead. - DEPLOYMENTSTRATEGYTYPEDEFAULT: Default/unspecified strategy (resolves…
DeploymentScalingTargetRequestsPerSecond
object
1 property
CreateApp
object
3 properties
DeploymentStrategy
object
1 property

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
Where this information came from

This is an independent, third-party profile of Koyeb Compose API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.