Keboola SUPER - UI Management API
Manage UI applications and their deployed versions.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/keboola-super-ui-management-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API 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. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Keboola Connection Management SUPER - UI Management API
description: 'The Keboola Connection Management API covers all tasks required for managing
projects, plus super-admin features for controlling and monitoring Keboola Connection.
## Projects management
* Create, modify and delete maintainers, organizations and projects
* Move projects between organizations
* Define project limits
* Provision storage backends
* Access project management activity log
## Projects monitoring
* Monitoring of projects across organizations and maintainers
## Super user control and monitoring
* UI release and deployment
* Components management
* Final project delete
* Workers start/shutdown, etc.
## Authentication
The API authenticates with a personal access token sent in the `X-KBC-ManageApiToken`
header. Tokens can be created in
[Account Settings](https://connection.keboola.com/admin/account/change-password)
in Keboola Connection. A token is tied to an administrator and inherits that
administrator''s permissions; when the administrator is disabled or deleted, all
their tokens become invalid.
```
curl -H "X-KBC-ManageApiToken: USER_TOKEN" https://connection.keboola.com/manage/tokens/verify
```
## Token types
| Type | Tied to a user | Token string visible only on create | Description |
| ----- | -------------- | ----------------------------------- | ----------- |
| user | Yes | Yes | Full access to maintainers, organizations and projects the user can see. |
| super | No | Yes | KBC management. Scopes such as `super_ui_deploy`, `super_monitoring` etc. can be limited per-token. |
Legacy Apiary reference: see the
[Manage API blueprint](https://github.com/keboola/connection/blob/master/Package/ManageApiPhpClient/apiary.apib)
for the historical document this OpenAPI spec is migrating from.
'
version: '1.0'
servers:
- url: https://connection.keboola.com
description: AWS US East
- url: https://connection.eu-central-1.keboola.com
description: AWS EU Central
- url: https://connection.north-europe.azure.keboola.com
description: Azure North Europe
- url: https://connection.east-us-2.azure.keboola-testing.com
description: Azure Testing
security:
- StorageKey: []
- ManageKey: []
- BearerAuth: []
tags:
- name: SUPER - UI Management
description: Manage UI applications and their deployed versions.
paths:
/manage/ui-apps/{id}/activate/{version}:
post:
tags:
- SUPER - UI Management
summary: Activate UI application version
description: Activates a specific version of a UI application.
operationId: post_/manage/ui-apps/{id}/activate/{version}::UiAppsActivateVersionAction
parameters:
- name: id
in: path
description: String ID of the UI application.
required: true
schema:
type: string
example: kbc.manageApps
- name: version
in: path
description: Version of the UI application to activate.
required: true
schema:
type: string
example: 0.0.3-33-ga6bc947
responses:
'201':
description: UI application version has been successfully activated.
'404':
description: Returned when the UI application or version does not exist.
/manage/ui-apps/{id}:
delete:
tags:
- SUPER - UI Management
summary: Delete Application
description: Deletes application and its versions.
operationId: delete_/manage/ui-apps/{id}::UiAppsDeleteAction
parameters:
- name: id
in: path
description: stringId/name of application.
required: true
schema:
type: string
example: kbc.manageApps
responses:
'204':
description: UI application has been successfully deleted.
'401':
description: Returned when the Manage token is missing or invalid.
'403':
description: Returned when the Manage token is not a super token with the `connection:ui-manage` scope.
'404':
description: Returned when the UI application does not exist.
/manage/ui-apps:
get:
tags:
- SUPER - UI Management
summary: List Applications
description: Returns active applications. This resource doesn't require authentication.
operationId: get_/manage/ui-apps::UiAppsListAction
responses:
'200':
description: List of UI applications with their active version.
content:
application/json:
schema:
$ref: '#/components/schemas/UiAppsListResponse'
example:
- name: kbc.manageApps
version: 0.0.3-33-ga6bc947
basePath: https://kbc-uis.s3.amazonaws.com/kbc.manageApps/0.0.3-33-ga6bc947/
type: text/javascript
scripts:
- https://kbc-uis.s3.amazonaws.com/kbc.manageApps/0.0.3-33-ga6bc947/scripts/libs.js
- https://kbc-uis.s3.amazonaws.com/kbc.manageApps/0.0.3-33-ga6bc947/scripts/scripts.js
styles:
- https://kbc-uis.s3.amazonaws.com/kbc.manageApps/0.0.3-33-ga6bc947/styles/libs.css
- https://kbc-uis.s3.amazonaws.com/kbc.manageApps/0.0.3-33-ga6bc947/styles/select2.png
isCritical: false
commitSha: a6bc947f1e2d3c4b5a6bc947f1e2d3c4b5a6bc94
security: []
post:
tags:
- SUPER - UI Management
summary: Register New Application/Version
description: Registers a new UI application or a new version of an existing application from its manifest URL. Optionally activates the registered version.
operationId: post_/manage/ui-apps::UiAppsRegistrationAction
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RegistrationRequest'
responses:
'201':
description: UI application has been successfully registered.
content:
application/json:
schema:
$ref: '#/components/schemas/UiAppsRegistrationResponse'
example:
app:
id: '41'
stringId: kbc
name: kbc
created: '2015-02-12 11:10:09'
version:
id: '1646'
version: 0.1.21-17-g3cae4c0
isActive: true
isCritical: false
commitSha: a6bc947f1e2d3c4b5a6bc947f1e2d3c4b5a6bc94
'400':
description: Returned when the request body fails validation or the manifest cannot be fetched/parsed (missing `name`, `basePath`, `version`, `scripts`, `styles`, or an invalid `type`/`isCritical`/`commitSha`).
'401':
description: Returned when the Manage token is missing or invalid.
'403':
description: Returned when the Manage token is not a super token with the `connection:ui-manage` scope.
components:
schemas:
UiAppResponse:
required:
- name
- version
- basePath
- type
- scripts
- styles
- isCritical
properties:
name:
description: Application name.
type: string
version:
description: Active version identifier.
type: string
basePath:
description: Base path for the UI application.
type: string
type:
description: Application script MIME type.
type: string
scripts:
description: List of script URLs.
type: array
items:
type: string
styles:
description: List of style URLs.
type: array
items:
type: string
isCritical:
description: Whether the application is marked as critical.
type: boolean
commitSha:
description: Git commit SHA that produced this build.
type:
- string
- 'null'
type: object
UiAppsListResponse:
type: array
items:
$ref: '#/components/schemas/UiAppResponse'
UiAppsRegistrationResponse:
required:
- app
- version
properties:
app:
properties:
id:
description: Application identifier.
type: string
stringId:
description: Unique application string identifier.
type: string
name:
description: Application name.
type: string
created:
description: Application creation time. Formatted as `YYYY-MM-DD HH:MM:SS` (no timezone).
type: string
example: '2024-04-21 13:42:11'
type: object
version:
properties:
id:
description: Version identifier.
type: string
version:
description: Version number.
type: string
isActive:
description: Flag indicating whether the version is active.
type: boolean
isCritical:
description: Whether the version is marked as critical.
type: boolean
commitSha:
description: Git commit SHA that produced this build.
type:
- string
- 'null'
type: object
type: object
RegistrationRequest:
description: UI application registration request — manifest URL of the build to register.
required:
- manifestUrl
properties:
manifestUrl:
description: URL of manifest describing UI build.
type: string
example: https://kbc-uis.s3.amazonaws.com/kbc.manageApps/0.0.3-33-ga6bc947/manifest.json
activate:
description: Activate version after registration.
type:
- boolean
- 'null'
example: true
type: object
securitySchemes:
StorageKey:
type: apiKey
name: X-StorageApi-Token
in: header
ManageKey:
type: apiKey
name: X-KBC-ManageApiToken
in: header
BearerAuth:
type: http
bearerFormat: Access Token (kbc_at_...)
scheme: bearer