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

The Secrets API from Koyeb — 3 operation(s) for secrets.

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

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

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

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

7 operations 3 paths 22 schemas 1 DELETE2 GET1 PATCH2 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 Secrets 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 7

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

Secrets 7
GET
/v1/secrets
List Secrets
ListSecrets 5 params → 200400401403404500503default
POST
/v1/secrets
Create Secret
CreateSecret 1 param → 200400401403404500503default
GET
/v1/secrets/{id}
Get Secret
GetSecret 1 param → 200400401403404500503default
DELETE
/v1/secrets/{id}
Delete Secret
DeleteSecret 1 param → 200400401403404500503default
PUT
/v1/secrets/{id}
Update Secret
UpdateSecret 3 params → 200400401403404500503default
PATCH
/v1/secrets/{id}
Update Secret
UpdateSecret2 3 params → 200400401403404500503default
POST
/v1/secrets/{id}/reveal
Reveal Secret
RevealSecret 2 params → 200400401403404500503default

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Secret (15 properties), CreateSecret (11 properties), ListSecretsReply (4 properties), ErrorWithFields (4 properties). Each schema is shown below with its type and property counts.

PrivateRegistryConfiguration
object
3 properties
CreateSecretReply
object
1 property
CreateSecret
object
11 properties
ListSecretsReply
object
4 properties
DigitalOceanRegistryConfiguration
object
2 properties
GitLabRegistryConfiguration
object
2 properties
GetSecretReply
object
1 property
ErrorWithFields
object
4 properties
RevealSecretReply
object
1 property
ErrorField
object
2 properties
Error
object
3 properties
DeleteSecretReply
object
google.rpc.Status
object
3 properties
GitHubRegistryConfiguration
object
2 properties
UpdateSecretReply
object
1 property
AzureContainerRegistryConfiguration
object
3 properties
DatabaseRolePassword
object
2 properties
Secret
object
15 properties
SecretType
string
GCPContainerRegistryConfiguration
object
2 properties
DockerHubRegistryConfiguration
object
2 properties
google.protobuf.Any
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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