BroadSQL BroadSQL Downloads
Documentation / Commands / CONFIG API

CONFIG API

Core command

Opens the API Configuration window: manage APIs, environments (base URL, variables), authentication (Inherit/None/Basic/Bearer/API Key/OAuth2 Client Credentials), variables and headers, folders and endpoints (every HTTP method, plus an optional BroadSQL alias reserved for future script usage), and Bruno YAML import/export, all without hand-editing SQL or the underlying metadata tables. This GUI only configures APIs; it never executes a request (see RUN for that). Same Windows-only, $CDF-only gate as CONFIG.

Arguments

None.

Examples

CONFIG API;

Notes

Opens the API configuration GUI: CONFIG API (SPRINT XT02 sub-sprint 5, see the "SPRINT XT02-sub sprint 5: API Configuration GUI + Bruno YAML Round-trip" design doc under docs/).

Mirrors CommandConfig's gate exactly: Windows only, and only while connected to $CDF (the encrypted Connections Definition File), the same physical file and master password an ApiDefinitionsVault reuses for its own API* tables (see that class's own javadoc), so both CONFIG and CONFIG API require exactly the same connection state.

Configures BroadSQL's Universal API Client catalog end to end: APIs, environments (including the prominent Base URL field, always saved through the mandatory setEnvironmentBaseUrl dual-write path), variables, headers, authentication (Inherit/None/Basic/Bearer/API Key/OAuth2 Client Credentials, plus read-only display of an imported-but-unsupported type), folders and endpoints (every HTTP method, not just the ones this release can execute), and each endpoint's optional BroadSQL alias (see the "Amendment: Endpoint Aliases and Future Scriptability" design doc under docs/), a stable name reserved for a future CALL-style script statement, never itself executable yet. Also provides Import Bruno YAML and Export Bruno YAML for the same bundled OpenCollection format IMPORT API BRUNO already reads; export omits secret values by default (opt-in, with an explicit confirmation, to include them) and never writes an endpoint's alias, which is BroadSQL-owned local metadata with no OpenCollection equivalent.

This GUI only configures APIs; it never executes a request. Execution remains RUN (API Quality and UX Consolidation sprint, formerly EXECUTE API ENDPOINT); every GET/ HEAD/POST/PUT/PATCH/DELETE endpoint can execute, regardless of what other methods are configured here.

Changes made here take effect immediately for the CLI (the same ApiDefinitionsVault instance is shared), and anything imported via IMPORT API BRUNO appears here immediately on next selection, with no restart required.

Last modified in release 5.2.5.

← All commands