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

The CatalogInstances API from Koyeb — 2 operation(s) for cataloginstances.

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

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

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

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

2 operations 2 paths 7 schemas 2 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 CatalogInstances 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 2

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

CatalogInstances 2
GET
/v1/catalog/instances
List Instances
ListCatalogInstances 3 params → 200default
GET
/v1/catalog/instances/{id}
Get Instance
GetCatalogInstance 1 param → 200default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are CatalogInstanceListItem (19 properties), CatalogInstance (19 properties), CatalogGPUDetails (4 properties), ListCatalogInstancesReply (4 properties). Each schema is shown below with its type and property counts.

google.rpc.Status
object
3 properties
CatalogInstance
object
19 properties
ListCatalogInstancesReply
object
4 properties
CatalogGPUDetails
object
4 properties
google.protobuf.Any
object
1 property
CatalogInstanceListItem
object
19 properties
GetCatalogInstanceReply
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koyeb-cataloginstances-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 CatalogInstanceUsage API
Koyeb CatalogRegions API
Koyeb Compose API
Koyeb Coupons API
Koyeb Credentials API
Koyeb Deployments API
Koyeb DockerHelper API