Skip to content

Stable API tag

console

Console admin operations (secrets, sources, connectors, SSO, license)

14 paths · 24 operations

/v1/console/bus

get

Event-bus subscriber, saturation, loss, and optional bridge snapshot

Operation ID
getBusSnapshot
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/config/effective

get

Live effective configuration with secret-bearing values redacted

Operation ID
getEffectiveConfig
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/connectors

get

List available connector types with their configuration fields

Operation ID
listConnectorCatalog
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

put

Onboard or update a connector instance

Operation ID
putConnector
Authentication
Bearer token
Request body
Present · required

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

delete

Remove a connector instance

Operation ID
deleteConnector
Authentication
Bearer token
Request body
Present · required

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/connectors/test

post

Test connectivity for a connector configuration

Operation ID
testConnector
Authentication
Bearer token
Request body
Present · required

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/health-summary

get

Operational health summary for the console dashboard

Operation ID
getHealthSummary
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/keys

get

Non-secret signing-key and sealer custody inventory

Operation ID
getKeyCustody
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/license

get

Current license status and entitlements

Operation ID
getLicenseStatus
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

post

Install a commercial license

Operation ID
installLicense
Authentication
Bearer token
Request body
Present · required

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

delete

Remove the installed license (revert to community)

Operation ID
uninstallLicense
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

204 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/secrets

get

List sealed secrets (names and hints, never values)

Operation ID
listSecrets
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

put

Create or update a sealed secret

Operation ID
putSecret
Authentication
Bearer token
Request body
Present · required

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

delete

Delete a sealed secret

Operation ID
deleteSecret
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

204 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/setup-status

get

First-run setup wizard progress

Operation ID
getSetupStatus
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/sources

get

List configured source connectors and their status

Operation ID
listSources
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

put

Create or update a source connector

Operation ID
putSource
Authentication
Bearer token
Request body
Present · required

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

delete

Remove a source connector

Operation ID
deleteSource
Authentication
Bearer token
Request body
Present · required

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/sso

get

Current SSO/IdP configuration

Operation ID
getSSOConfig
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

put

Create or update SSO/IdP configuration

Operation ID
putSSOConfig
Authentication
Bearer token
Request body
Present · required

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

delete

Remove SSO/IdP configuration

Operation ID
deleteSSOConfig
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

204 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/sso/test

post

Test SSO/IdP connectivity

Operation ID
testSSOConfig
Authentication
Bearer token
Request body
Present · required

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/support-bundle

post

Build and download a redacted support bundle (AAL3 step-up)

Operation ID
createSupportBundle
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429

/v1/console/update-check

post

Check the configured signed update channel now

Operation ID
refreshUpdateStatus
Authentication
Bearer token
Request body
None

Parameters: none declared.

Response codes

200 · 400 · 401 · 403 · 404 · 409 · 429