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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Koyeb

Koyeb Deployments API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Deployment. 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 81 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.

5 operations 5 paths 81 schemas 4 GET1 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 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 6 params → 200400401403404500503default
GET
/v1/deployments/{id}
Get Deployment
GetDeployment 1 param → 200400401403404500503default
POST
/v1/deployments/{id}/cancel
Cancel Deployment
CancelDeployment 1 param → 200400401403404500503default

Schemas 81

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

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

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
AE Profile APIs.io
Koyeb Apps API
AE Profile APIs.io
Koyeb Archives API
AE Profile APIs.io
Koyeb billing API
AE Profile APIs.io
Koyeb CatalogDatacenters API
AE Profile APIs.io
Koyeb CatalogInstances API
AE Profile APIs.io
Koyeb CatalogInstanceUsage API
AE Profile APIs.io
Koyeb CatalogRegions API
AE Profile APIs.io
Koyeb Compose API
AE Profile APIs.io
Koyeb Coupons API
AE Profile APIs.io
Koyeb Credentials API
AE Profile APIs.io
Koyeb DockerHelper API
AE Profile APIs.io
#Deployment
← Back to K APIs
API Details
ID
koyeb:koyeb-deployments-api
Base URL
https://app.koyeb.com
Docs
https://www.koyeb.com/docs/api
Provider
Koyeb
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=koyeb-deployments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/koyeb-deployments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Koyeb Deployments 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.