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

The organization API from Koyeb — 12 operation(s) for organization.

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

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

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

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

19 operations 12 paths 34 schemas 2 DELETE3 GET1 PATCH10 POST3 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 organization 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 19

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

organization 19
GET
/v1/github/installation
Fetch Github Installation configuration
GetGithubInstallation → 200400401403404500503default
POST
/v1/github/installation
Start Github Installation
GithubInstallation 1 param → 200400401403404500503default
POST
/v1/organizations
Create Organization
CreateOrganization 1 param → 200400401403404500503default
GET
/v1/organizations/{id}
Get Organization
GetOrganization 1 param → 200400401403404500503default
DELETE
/v1/organizations/{id}
Delete an Organization
DeleteOrganization 1 param → 200400401403404500503default
PUT
/v1/organizations/{id}
Update Organization
UpdateOrganization 3 params → 200400401403404500503default
PATCH
/v1/organizations/{id}
Update Organization
UpdateOrganization2 3 params → 200400401403404500503default
POST
/v1/organizations/{id}/access_token
CreateAccessToken
CreateAccessToken 2 params → 200400401403404500503default
POST
/v1/organizations/{id}/deactivate
Deactivate an Organization
DeactivateOrganization 2 params → 200400401403404500503default
PUT
/v1/organizations/{id}/name
Update Organization Name
UpdateOrganizationName 2 params → 200400401403404500503default
POST
/v1/organizations/{id}/plan
Update Organization plan
UpdateOrganizationPlan 2 params → 200400401403404500503default
POST
/v1/organizations/{id}/reactivate
Reactivate an Organization
ReactivateOrganization 2 params → 200400401403404500503default
POST
/v1/organizations/{id}/signup_qualification
Upsert Organization's signup qualification
UpsertSignupQualification 2 params → 200400401403404500503default
POST
/v1/organizations/{id}/switch
Switch Organization context
SwitchOrganization 3 params → 200400401403404500503default
GET
/v1/organizations/{organization_id}/budget
Get Budget
GetBudget 1 param → 200400401403404500503default
DELETE
/v1/organizations/{organization_id}/budget
Delete Budget
DeleteBudget 1 param → 200400401403404500503default
POST
/v1/organizations/{organization_id}/budget
Create Budget
CreateBudget 2 params → 200400401403404500503default
PUT
/v1/organizations/{organization_id}/budget
Update Budget
UpdateBudget 2 params → 200400401403404500503default
POST
/v1/unscope_organization_token
Unscope Organization Token
UnscopeOrganizationToken 2 params → 200400401403404500503default

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Organization (31 properties), GetGithubInstallationReply (10 properties), Token (4 properties), GithubInstallationReply (4 properties). Each schema is shown below with its type and property counts.

DeleteOrganizationReply
object
1 property
GetBudgetReply
object
1 property
CreateOrganizationRequest
object
1 property
GithubInstallationReply
object
4 properties
CreateAccessTokenReply
object
1 property
CreateBudgetReply
object
1 property
ReactivateOrganizationReply
object
1 property
Token
object
4 properties
UpdateOrganizationPlanReply
object
1 property
GithubInstallationRequest
object
1 property
GetGithubInstallationReply
object
10 properties
DeactivateOrganizationReply
object
1 property
ErrorWithFields
object
4 properties
Budget
object
2 properties
ErrorField
object
2 properties
Error
object
3 properties
UnscopeOrganizationTokenRequest
object
Plan
string
OrganizationDetailedStatus
string
UpdateOrganizationReply
object
1 property
kgitproxy.IndexingStatus
string
UpdateOrganizationNameReply
object
1 property
google.rpc.Status
object
3 properties
Organization
object
31 properties
UpdateBudgetReply
object
1 property
Organization.Status
string
LoginReply
object
1 property
GetOrganizationReply
object
1 property
DeleteBudgetReply
object
CreateOrganizationReply
object
1 property
kgitproxy.GithubInstallation.Status
string
Organization.DeactivationReason
string
google.protobuf.Any
object
1 property
UpsertSignupQualificationReply
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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