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

The Domains API from Koyeb — 3 operation(s) for domains.

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

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

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

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

6 operations 3 paths 18 schemas 1 DELETE2 GET1 PATCH2 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 Domains 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 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Domains 6
GET
/v1/domains
List Domains
ListDomains 7 params → 200400401403404500503default
POST
/v1/domains
Create Domain
CreateDomain 1 param → 200400401403404500503default
GET
/v1/domains/{id}
Get Domain
GetDomain 1 param → 200400401403404500503default
DELETE
/v1/domains/{id}
Delete Domain
DeleteDomain 1 param → 200400401403404500503default
PATCH
/v1/domains/{id}
Update Domain
UpdateDomain 4 params → 200400401403404500503default
POST
/v1/domains/{id}/refresh
Refresh Domain Status
RefreshDomainStatus 1 param → 200400401403404500503default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Domain (15 properties), CreateDomain (6 properties), ErrorWithFields (4 properties), ListDomainsReply (4 properties). Each schema is shown below with its type and property counts.

ErrorField
object
2 properties
Domain.LoadBalancerCloudflare
object
GetDomainReply
object
1 property
DeleteDomainReply
object
google.rpc.Status
object
3 properties
CreateDomain
object
6 properties
CreateDomainReply
object
1 property
Domain.Status
string
Domain.Type
string
ErrorWithFields
object
4 properties
ListDomainsReply
object
4 properties
UpdateDomain
object
2 properties
google.protobuf.Any
object
1 property
Domain.LoadBalancerKoyeb
object
1 property
Domain
object
15 properties
UpdateDomainReply
object
1 property
Error
object
3 properties
RefreshDomainStatusReply
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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