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

The Deployments API from Koyeb — 5 operation(s) for deployments.

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

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

This API exposes 5 operations across 5 paths, and defines 73 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 5 paths 73 schemas 4 GET1 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 Deployments 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 5 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Deployments 5
GET
/v1/deployment/{id}/scaling
Get Deployment Scaling
GetDeploymentScaling 3 params → 200400401403404500503default
GET
/v1/deployment_events
List Deployment events
ListDeploymentEvents 5 params → 200400401403404500503default
GET
/v1/deployments
List Deployments
ListDeployments 5 params → 200400401403404500503default
GET
/v1/deployments/{id}
Get Deployment
GetDeployment 1 param → 200400401403404500503default
POST
/v1/deployments/{id}/cancel
Cancel Deployment
CancelDeployment 1 param → 200400401403404500503default

Schemas 73

The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are Deployment (22 properties), DeploymentListItem (20 properties), Instance (19 properties), DeploymentDefinition (18 properties). Each schema is shown below with its type and property counts.

GitSource
object
10 properties
DeploymentListItem
object
20 properties
NeonPostgresDatabase.NeonRole
object
2 properties
BasicAuthPolicy
object
2 properties
DatabaseDeploymentMetadata
object
1 property
TriggerDeploymentMetadata.ActorType
string
DeploymentProvisioningInfo.Stage.BuildAttempt
object
10 properties
CancelDeploymentReply
object
Deployment.Role
string
DeploymentScalingTargetSleepIdleDelay
object
3 properties
GetDeploymentScalingReply
object
1 property
DeploymentMetadata
object
5 properties
DeploymentStrategy
object
1 property
DeploymentDefinition
object
18 properties
ProxyPortProtocol
string
DeploymentProvisioningInfo.Stage.BuildAttempt.BuildStep
object
5 properties
DockerSource
object
6 properties
DeploymentProxyPort
object
2 properties
DeploymentPort
object
2 properties
DeploymentNeonPostgresDatabaseInfo
object
14 properties
GetDeploymentReply
object
1 property
BuildpackBuilder
object
3 properties
DeploymentEvent
object
7 properties
DeploymentScaling
object
4 properties
DeploymentScalingTarget
object
6 properties
DeploymentScalingTargetConcurrentRequests
object
1 property
NeonPostgresDatabase
object
5 properties
DeploymentScalingTargetAverageCPU
object
1 property
ArchiveDeploymentMetadata
object
1 property
DeploymentStrategyType
string
- DEPLOYMENTSTRATEGYTYPEINVALID: DEPRECATED: Use DEPLOYMENTSTRATEGYTYPEDEFAULT instead. - DEPLOYMENTSTRATEGYTYPEDEFAULT: Default/unspecified strategy (resolves…
Deployment.Status
string
NeonPostgresDatabase.NeonDatabase
object
2 properties
ErrorWithFields
object
4 properties
Deployment
object
22 properties
GitDeploymentMetadata
object
2 properties
DeploymentProxyPortMetadata
object
4 properties
ErrorField
object
2 properties
DeploymentInstanceType
object
2 properties
Error
object
3 properties
ArchiveSource
object
3 properties
DeploymentRoute
object
3 properties
google.rpc.Status
object
3 properties
DeploymentProvisioningInfo.Stage.Status
string
ListDeploymentsReply
object
5 properties
DeploymentEnv
object
4 properties
ListDeploymentEventsReply
object
5 properties
DatabaseSource
object
1 property
DeploymentDefinition.Type
string
TriggerDeploymentMetadata.TriggerType
string
Instance
object
19 properties
NeonPostgresDatabaseDeploymentMetadata
object
1 property
DockerBuilder
object
6 properties
DeploymentScalingTargetRequestsPerSecond
object
1 property
GitEnvDeploymentMetadata
object
3 properties
HTTPHeader
object
2 properties
DeploymentHealthCheck
object
6 properties
DeploymentNeonPostgresDatabaseInfoRole
object
2 properties
DeploymentDatabaseInfo
object
1 property
DeploymentProvisioningInfo
object
3 properties
TCPHealthCheck
object
1 property
TriggerGitDeploymentMetadata.Provider
string
DeploymentScalingTargetAverageMem
object
1 property
ConfigFile
object
3 properties
HTTPHealthCheck
object
4 properties
DeploymentVolume
object
4 properties
DeploymentScalingTargetRequestsResponseTime
object
2 properties
SecurityPolicies
object
2 properties
TriggerGitDeploymentMetadata
object
8 properties
TriggerDeploymentMetadata
object
3 properties
DeploymentProvisioningInfo.Stage
object
6 properties
google.protobuf.Any
object
1 property
GetDeploymentScalingReplyItem
object
3 properties
Instance.Status
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koyeb-deployments-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 DockerHelper API