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

The Projects API from Koyeb — 2 operation(s) for projects.

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

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

This API exposes 6 operations across 2 paths, and defines 12 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 2 paths 12 schemas 1 DELETE2 GET1 PATCH1 POST1 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 Projects 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 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Projects 6
GET
/v1/projects
List projects
ListProjects 2 params → 200400401403404500503default
POST
/v1/projects
Create project
CreateProject 1 param → 200400401403404500503default
GET
/v1/projects/{id}
Get project
GetProject 1 param → 200400401403404500503default
DELETE
/v1/projects/{id}
Delete project
DeleteProject 1 param → 200400401403404500503default
PUT
/v1/projects/{id}
Update project
UpdateProject 3 params → 200400401403404500503default
PATCH
/v1/projects/{id}
Update project
UpdateProject2 3 params → 200400401403404500503default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Project (6 properties), ErrorWithFields (4 properties), Error (3 properties), google.rpc.Status (3 properties). Each schema is shown below with its type and property counts.

UpdateProjectReply
object
1 property
CreateProject
object
2 properties
DeleteProjectReply
object
google.rpc.Status
object
3 properties
ListProjectsReply
object
3 properties
CreateProjectReply
object
1 property
ErrorWithFields
object
4 properties
google.protobuf.Any
object
1 property
GetProjectReply
object
1 property
ErrorField
object
2 properties
Error
object
3 properties
Project
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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