API reference

Configs

The config registry: create, version, upload YAML, and switch which version is active.

Configs are the semantic layer over a connection. This is the registry that stores them.

CRUD

GET    /api/configs
POST   /api/configs
GET    /api/configs/{key}
DELETE /api/configs/{key}

Versions

Every save is a version.

GET  /api/configs/{key}/versions
POST /api/configs/{key}/upload-yaml
GET  /api/configs/{key}/yml

Uploading YAML creates a new version rather than overwriting: rolling back is switching the active version, not restoring a backup.

Specialised sources

POST /api/configs/dynamodb
POST /api/configs/stitched

See DynamoDB and stitched connections.

Customize and migrate

POST /api/configs/{key}/customize
POST /api/configs/{key}/migrate-to-org

customize forks a shared read-only config (the platform sample) into a copy you own. migrate-to-org moves a personal config to an organization so teammates can use it.

On this page