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

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

Koyeb Services API is one of 42 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 92 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

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

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

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 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 8 params → 200400401403404500503default
POST
/v1/services
Create Service
CreateService 2 params → 200400401403404500503default
POST
/v1/services-autocomplete
Autocomplete definition
Autocomplete 1 param → 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 4 params → 200400401403404500503default
PATCH
/v1/services/{id}
Update Service
UpdateService2 4 params → 200400401403404500503default
POST
/v1/services/{id}/pause
Pause Service
PauseService 1 param → 200400401403404500503default
POST
/v1/services/{id}/redeploy
ReDeploy Service
ReDeploy 2 params → 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 2 params → 200400401403404500503default

Schemas 92

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

DeploymentProvisioningInfo.Stage.BuildAttempt
object
10 properties
DeploymentScalingTargetSleepIdleDelay
object
3 properties
DeploymentProxyPort
object
2 properties
RedeployRequest.Info
object
4 properties
ErrorWithFields
object
4 properties
DeleteServiceScalingReply
object
GitDeploymentMetadata
object
2 properties
ArchiveSource
object
3 properties
UpdateServiceReply
object
1 property
UpdateService
object
5 properties
DeleteServiceReply
object
DeploymentDefinition.Type
string
DeploymentDatabaseInfo
object
1 property
ServiceListItem
object
14 properties
HTTPHealthCheck
object
4 properties
TriggerGitDeploymentMetadata
object
8 properties
DesiredDeployment.Group
object
2 properties
BasicAuthPolicy
object
2 properties
Deployment.Role
string
RedeployReply
object
1 property
DeploymentMetadata
object
5 properties
DeploymentProvisioningInfo.Stage.BuildAttempt.BuildStep
object
5 properties
BuildpackBuilder
object
3 properties
DeploymentStrategyType
string
- DEPLOYMENTSTRATEGYTYPEINVALID: DEPRECATED: Use DEPLOYMENTSTRATEGYTYPEDEFAULT instead. - DEPLOYMENTSTRATEGYTYPEDEFAULT: Default/unspecified strategy (resolves…
NeonPostgresDatabase.NeonDatabase
object
2 properties
DeploymentProxyPortMetadata
object
4 properties
DeploymentProvisioningInfo.Stage.Status
string
TriggerDeploymentMetadata.TriggerType
string
ListServiceEventsReply
object
5 properties
DockerBuilder
object
6 properties
GitEnvDeploymentMetadata
object
3 properties
DeploymentHealthCheck
object
6 properties
Service.Status
string
DeploymentScalingTargetRequestsResponseTime
object
2 properties
GetServiceScalingReply
object
1 property
google.protobuf.Any
object
1 property
ServiceLifeCycle
object
2 properties
PauseServiceReply
object
DatabaseDeploymentMetadata
object
1 property
ServiceState
object
2 properties
AutoRelease
object
1 property
CreateServiceReply
object
1 property
DeploymentStrategy
object
1 property
DesiredDeployment
object
1 property
DeploymentPort
object
2 properties
DeploymentScalingTargetAverageCPU
object
1 property
DeploymentScaling
object
4 properties
NeonPostgresDatabase
object
5 properties
ArchiveDeploymentMetadata
object
1 property
Service.Type
string
ErrorField
object
2 properties
Error
object
3 properties
DeploymentRoute
object
3 properties
google.rpc.Status
object
3 properties
ResumeServiceReply
object
DatabaseSource
object
1 property
ListServicesReply
object
5 properties
DeploymentProvisioningInfo
object
3 properties
DeploymentScalingTargetAverageMem
object
1 property
SecurityPolicies
object
2 properties
DeploymentProvisioningInfo.Stage
object
6 properties
TriggerDeploymentMetadata
object
3 properties
TriggerGitDeploymentMetadata.Provider
string
DeploymentNeonPostgresDatabaseInfo
object
14 properties
Service
object
20 properties
GitSource
object
10 properties
NeonPostgresDatabase.NeonRole
object
2 properties
TriggerDeploymentMetadata.ActorType
string
DeploymentDefinition
object
18 properties
ProxyPortProtocol
string
DockerSource
object
6 properties
AutocompleteReply
object
3 properties
DeploymentScalingTarget
object
6 properties
DeploymentScalingTargetConcurrentRequests
object
1 property
AutoRelease.Group
object
4 properties
Deployment.Status
string
CreateService
object
4 properties
AutocompleteRequest
object
1 property
Deployment
object
22 properties
DeploymentInstanceType
object
2 properties
ServiceEvent
object
7 properties
DeploymentEnv
object
4 properties
NeonPostgresDatabaseDeploymentMetadata
object
1 property
DeploymentScalingTargetRequestsPerSecond
object
1 property
ManualServiceScaling
object
2 properties
HTTPHeader
object
2 properties
DeploymentNeonPostgresDatabaseInfoRole
object
2 properties
TCPHealthCheck
object
1 property
ConfigFile
object
3 properties
UpdateServiceScalingReply
object
DeploymentVolume
object
4 properties
GetServiceReply
object
1 property

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