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

The RegionalDeployments API from Koyeb — 3 operation(s) for regionaldeployments.

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

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

This API exposes 3 operations across 3 paths, and defines 47 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

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

3 operations 3 paths 47 schemas 3 GET

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 RegionalDeployments 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 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

RegionalDeployments 3
GET
/v1/regional_deployment_events
List Regional Deployment events
ListRegionalDeploymentEvents 5 params → 200400401403404500503default
GET
/v1/regional_deployments
List Regional Deployments
ListRegionalDeployments 3 params → 200400401403404500503default
GET
/v1/regional_deployments/{id}
Get Regional Deployment
GetRegionalDeployment 1 param → 200400401403404500503default

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are RegionalDeployment (24 properties), RegionalDeploymentDefinition (17 properties), DeploymentProvisioningInfo.Stage.BuildAttempt (10 properties), GitSource (10 properties). Each schema is shown below with its type and property counts.

RegionalDeploymentDefinition
object
17 properties
GitSource
object
10 properties
RegionalDeploymentVolume
object
3 properties
RegionalDeploymentListItem
object
7 properties
BasicAuthPolicy
object
2 properties
DeploymentProvisioningInfo.Stage.BuildAttempt
object
10 properties
DeploymentScalingTargetSleepIdleDelay
object
3 properties
DeploymentStrategy
object
1 property
RegionalDeploymentDefinition.Type
string
DeploymentProvisioningInfo.Stage.BuildAttempt.BuildStep
object
5 properties
DockerSource
object
6 properties
BuildpackBuilder
object
3 properties
DeploymentScalingTargetAverageCPU
object
1 property
DeploymentScalingTarget
object
6 properties
DeploymentScalingTargetConcurrentRequests
object
1 property
RegionalDeploymentMetadata
object
Route
object
3 properties
RegionalDeployment.Status
string
DeploymentStrategyType
string
- DEPLOYMENTSTRATEGYTYPEINVALID: DEPRECATED: Use DEPLOYMENTSTRATEGYTYPEDEFAULT instead. - DEPLOYMENTSTRATEGYTYPEDEFAULT: Default/unspecified strategy (resolves…
ListRegionalDeploymentEventsReply
object
5 properties
ErrorWithFields
object
4 properties
RegionalDeployment.Role
string
ErrorField
object
2 properties
Error
object
3 properties
ArchiveSource
object
3 properties
google.rpc.Status
object
3 properties
DeploymentProvisioningInfo.Stage.Status
string
GetRegionalDeploymentReply
object
1 property
Scaling
object
3 properties
DockerBuilder
object
6 properties
DeploymentScalingTargetRequestsPerSecond
object
1 property
HTTPHeader
object
2 properties
DeploymentHealthCheck
object
6 properties
Env
object
3 properties
RegionalDeploymentEvent
object
7 properties
DeploymentProvisioningInfo
object
3 properties
TCPHealthCheck
object
1 property
DeploymentScalingTargetAverageMem
object
1 property
ConfigFile
object
3 properties
HTTPHealthCheck
object
4 properties
SecurityPolicies
object
2 properties
DeploymentScalingTargetRequestsResponseTime
object
2 properties
google.protobuf.Any
object
1 property
DeploymentProvisioningInfo.Stage
object
6 properties
ListRegionalDeploymentsReply
object
5 properties
Port
object
2 properties
RegionalDeployment
object
24 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koyeb-regionaldeployments-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