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

The Services API from Koyeb — 8 operation(s) for services.

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

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

This API exposes 14 operations across 8 paths, and defines 100 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.

14 operations 8 paths 100 schemas 2 DELETE4 GET1 PATCH5 POST2 PUT

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 Services 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 14

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

Services 14
GET
/v1/service_events
List Service events
ListServiceEvents 5 params → 200400401403404500503default
GET
/v1/services
List Services
ListServices 9 params → 200400401403404500503default
POST
/v1/services
Create Service
CreateService 1 param body → 200400401403404500503default
POST
/v1/services-autocomplete
Autocomplete definition
Autocomplete body → 200400401403404500503default
GET
/v1/services/{id}
Get Service
GetService 1 param → 200400401403404500503default
DELETE
/v1/services/{id}
Delete Service
DeleteService 1 param → 200400401403404500503default
PUT
/v1/services/{id}
Update Service
UpdateService 3 params body → 200400401403404500503default
PATCH
/v1/services/{id}
Update Service
UpdateService2 3 params body → 200400401403404500503default
POST
/v1/services/{id}/pause
Pause Service
PauseService 1 param → 200400401403404500503default
POST
/v1/services/{id}/redeploy
ReDeploy Service
ReDeploy 1 param body → 200400401403404500503default
POST
/v1/services/{id}/resume
Resume Service
ResumeService 3 params → 200400401403404500503default
GET
/v1/services/{id}/scale
Get Service Scaling
GetServiceScaling 1 param → 200400401403404500503default
DELETE
/v1/services/{id}/scale
Delete Service Scaling
DeleteServiceScaling 1 param → 200400401403404500503default
PUT
/v1/services/{id}/scale
Update Service Scaling
UpdateServiceScaling 1 param body → 200400401403404500503default

Schemas 100

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

ServiceListItem
object
16 properties
Service.Type
string
NeonPostgresDatabase
object
5 properties
ArchiveSource
object
3 properties
DeploymentRoute
object
3 properties
UpdateServiceScalingReply
object
DeleteServiceReply
object
Deployment.Status
string
AutoRelease.Group
object
4 properties
GitSource
object
10 properties
NetworkPolicy
object
2 properties
DeploymentNeonPostgresDatabaseInfo
object
14 properties
DockerBuilder
object
6 properties
DeploymentDatabaseInfo
object
1 property
ResumeServiceReply
object
CreateService
object
7 properties
DockerSource
object
6 properties
ProxyPortProtocol
string
Error
object
3 properties
PauseServiceReply
object
AutocompleteRequest
object
1 property
ServiceState
object
2 properties
DeploymentHealthCheck
object
6 properties
DeploymentScalingTargetSleepIdleDelay
object
3 properties
DeploymentProxyPortMetadata
object
4 properties
ConfigFile
object
3 properties
DeploymentProvisioningInfo.Stage
object
6 properties
GitDeploymentMetadata
object
2 properties
DeploymentDefinition.Type
string
DeploymentScalingTargetRequestsResponseTime
object
2 properties
TriggerGitDeploymentMetadata.Provider
string
SecurityPolicies
object
2 properties
DeploymentVolume
object
4 properties
GetServiceScalingReply
object
1 property
DeploymentScalingTargetAverageMem
object
1 property
DeploymentProvisioningInfo
object
3 properties
DeleteServiceScalingReply
object
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
GetServiceReply
object
1 property
DeploymentMetadata
object
6 properties
BuildpackBuilder
object
3 properties
TriggerDeploymentMetadata.ActorType
string
DesiredDeployment
object
1 property
RedeployReply
object
1 property
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
ServiceEvent
object
7 properties
Service
object
22 properties
BasicAuthPolicy
object
2 properties
UpdateServiceReply
object
1 property
google.rpc.Status
object
3 properties
DatabaseSource
object
1 property
DatabaseDeploymentMetadata
object
1 property
HTTPHealthCheck
object
4 properties
ListServiceEventsReply
object
5 properties
DeploymentEnv
object
4 properties
DesiredDeployment.Group
object
2 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
CreateServiceReply
object
1 property
TriggerGitDeploymentMetadata
object
8 properties
AutoRelease
object
1 property
GitEnvDeploymentMetadata
object
3 properties
Deployment
object
25 properties
EgressPolicyMode
string
DeploymentDefinition
object
20 properties
DeploymentNeonPostgresDatabaseInfoRole
object
2 properties
Service.Status
string
UpdateService
object
6 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
RedeployRequest.Info
object
4 properties
DeploymentMesh
string
ListServicesReply
object
5 properties
DeploymentScalingTargetConcurrentRequests
object
1 property
ServiceLifeCycle
object
2 properties
ErrorField
object
2 properties
AutocompleteReply
object
3 properties
ManualServiceScaling
object
2 properties
NetworkPolicyDestination
object
1 property
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-services-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 Deployments API
Where this information came from

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