Orbit Secrets API
Org secret store — encrypted credentials, write-only values
Org secret store — encrypted credentials, write-only values
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/orbitapps-io:orbitapps-io-secrets-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Orbit Apps Secrets API
version: 1.0.0
description: Public REST API for Orbit Apps.
servers:
- url: https://api.orbitapps.io
description: Production
security:
- bearerAuth: []
tags:
- name: Secrets
description: Org secret store — encrypted credentials, write-only values
paths:
/api/v1/orgs/{id}/secrets:
get:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Org id from GET /api/v1/orgs
responses:
'200':
description: Secret metadata for the org.
content:
application/json:
schema:
title: SecretList
type: object
properties:
data:
type: array
items:
title: Secret
description: Secret metadata. Values are write-only — no endpoint returns them.
type: object
properties:
description:
oneOf:
- type: string
- type: 'null'
accessed_at:
description: Last time a workflow/deploy decrypted this secret.
oneOf:
- type: string
- type: 'null'
slug:
description: Resolve-key an app manifest's integration looks this credential up by (its `secret-slug`). Null means the row answers no integration, so a deploy skips it.
oneOf:
- type: string
- type: 'null'
name:
description: Unique name within the org — the address workflows reference.
type: string
org_id:
description: Owning org id.
type: string
format: uuid
key_version:
description: Encryption key version of the stored ciphertext.
oneOf:
- type: integer
- type: 'null'
updated_at:
oneOf:
- type: string
- type: 'null'
status:
description: valid | invalid (provider validation outcome).
oneOf:
- type: string
- type: 'null'
id:
description: Stable UUIDv7 identifier.
type: string
format: uuid
provider:
description: Provider tag (e.g. github, stripe) when the secret is a known integration credential.
oneOf:
- type: string
- type: 'null'
created_at:
oneOf:
- type: string
- type: 'null'
required:
- id
- org_id
- name
- slug
- status
additionalProperties: false
required:
- data
additionalProperties: false
'403':
description: Caller's role cannot read secrets.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'404':
description: Org does not exist, or the caller has no visibility.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Secrets
summary: List the org's secrets (metadata only)
description: 'Names, providers, statuses, and timestamps — never values or ciphertext. Internal per-app deploy keys are excluded.
Authorization: `[:read :secret]` (owner/admin/member; viewer is rejected with 403).'
operationId: getApiV1OrgsByIdSecrets
x-operation-id-source: derived
/api/v1/orgs/{id}/secrets/{name}:
put:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Org id from GET /api/v1/orgs
- in: path
name: name
required: true
schema:
type: string
description: Secret name — unique within the org; may contain `/` (matched as a catch-all). Workflows reference secrets by the row id from the list endpoint.
requestBody:
content:
application/json:
schema:
title: SecretPut
description: Create or replace the named secret's value. The value is encrypted at rest and never readable back through this api.
type: object
properties:
value:
description: The plaintext credential to encrypt and store.
allOf:
- type: string
- {}
slug:
description: Resolve-key an app manifest's integration looks this credential up by — the integration's `secret-slug`. Set it to make a deploy of that app find this row; without it the deploy skips the integration and the app runs with no credential. Omitting it on a PUT over an existing secret keeps the slug that row already carries.
oneOf:
- type: string
- type: 'null'
provider:
description: Provider tag, e.g. github.
oneOf:
- type: string
- type: 'null'
description:
oneOf:
- type: string
- type: 'null'
required:
- value
additionalProperties: false
responses:
'200':
description: The re-encrypted secret's metadata.
content:
application/json:
schema:
title: Secret
description: Secret metadata. Values are write-only — no endpoint returns them.
type: object
properties:
description:
oneOf:
- type: string
- type: 'null'
accessed_at:
description: Last time a workflow/deploy decrypted this secret.
oneOf:
- type: string
- type: 'null'
slug:
description: Resolve-key an app manifest's integration looks this credential up by (its `secret-slug`). Null means the row answers no integration, so a deploy skips it.
oneOf:
- type: string
- type: 'null'
name:
description: Unique name within the org — the address workflows reference.
type: string
org_id:
description: Owning org id.
type: string
format: uuid
key_version:
description: Encryption key version of the stored ciphertext.
oneOf:
- type: integer
- type: 'null'
updated_at:
oneOf:
- type: string
- type: 'null'
status:
description: valid | invalid (provider validation outcome).
oneOf:
- type: string
- type: 'null'
id:
description: Stable UUIDv7 identifier.
type: string
format: uuid
provider:
description: Provider tag (e.g. github, stripe) when the secret is a known integration credential.
oneOf:
- type: string
- type: 'null'
created_at:
oneOf:
- type: string
- type: 'null'
required:
- id
- org_id
- name
- slug
- status
additionalProperties: false
'201':
description: The created secret's metadata.
content:
application/json:
schema:
title: Secret
description: Secret metadata. Values are write-only — no endpoint returns them.
type: object
properties:
description:
oneOf:
- type: string
- type: 'null'
accessed_at:
description: Last time a workflow/deploy decrypted this secret.
oneOf:
- type: string
- type: 'null'
slug:
description: Resolve-key an app manifest's integration looks this credential up by (its `secret-slug`). Null means the row answers no integration, so a deploy skips it.
oneOf:
- type: string
- type: 'null'
name:
description: Unique name within the org — the address workflows reference.
type: string
org_id:
description: Owning org id.
type: string
format: uuid
key_version:
description: Encryption key version of the stored ciphertext.
oneOf:
- type: integer
- type: 'null'
updated_at:
oneOf:
- type: string
- type: 'null'
status:
description: valid | invalid (provider validation outcome).
oneOf:
- type: string
- type: 'null'
id:
description: Stable UUIDv7 identifier.
type: string
format: uuid
provider:
description: Provider tag (e.g. github, stripe) when the secret is a known integration credential.
oneOf:
- type: string
- type: 'null'
created_at:
oneOf:
- type: string
- type: 'null'
required:
- id
- org_id
- name
- slug
- status
additionalProperties: false
'403':
description: Caller's role cannot write secrets.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'404':
description: Org does not exist, or the caller has no visibility.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'503':
description: The api instance has no vault master key configured.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Secrets
summary: Create or replace a secret
description: 'Encrypts `value` (AES-256-GCM envelope) and stores it under `name`. PUT on an existing name re-encrypts in place (same id, so workflow references keep working) — 200; a new name creates — 201.
Values are write-only: neither this response nor any other endpoint returns the plaintext. Workflows and deploys decrypt internally at run time.
Authorization: `[:manage :secret]` (owner/admin).'
operationId: putApiV1OrgsByIdSecretsByName
x-operation-id-source: derived
delete:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Org id from GET /api/v1/orgs
- in: path
name: name
required: true
schema:
type: string
description: Secret name — unique within the org; may contain `/` (matched as a catch-all). Workflows reference secrets by the row id from the list endpoint.
responses:
'204':
description: Secret deleted.
'403':
description: Caller's role cannot write secrets.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'404':
description: Org or secret not found / not visible.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Secrets
summary: Delete a secret
description: 'Permanently removes the named secret. Workflows that reference it will fail their next run — update them first.
Authorization: `[:manage :secret]` (owner/admin).'
operationId: deleteApiV1OrgsByIdSecretsByName
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: opaque
description: 'An Orbit api token, sent as `Authorization: Bearer <token>`.
Mint one with the RFC 8628 device-authorization grant (`POST /api/v1/device/code`, then poll `POST /api/v1/device/token`), or from Studio.
Every token carries a scope set from the `[verb resource]` RBAC catalog — `read:app`, `write:deployment`, `manage:secret`, and so on. The full vocabulary is published as `scopes_supported` at `/.well-known/oauth-protected-resource` (RFC 9728) and `/.well-known/oauth-authorization-server` (RFC 8414). Grant an agent the narrowest set that does its job.'
externalDocs:
description: Full documentation
url: https://docs.orbitapps.io
x-id:
- reitit.openapi/default