BroadSQL Download
On this page
Documentation / Commands / CONFIG API

CONFIG API

Core command

Opens the window that configures APIs, environments, authentication, folders and endpoints (Windows only).

Syntax

CONFIG API

Examples

CONFIG API;

Details

Availability

The same conditions as CONFIG: Windows only, from any connection state (BroadSQL>, an ordinary connection or CDF maintenance). The API catalog is kept in the BroadSQL configuration database (CDF), under the same master password; the window reads and saves it directly, never through the current database connection.

What it configures

The tabs General, Environments, Authentication, Variables & Headers and Endpoints cover the whole API catalog:

  • APIs and their environments, with each environment's Base URL;
  • variables and headers;
  • authentication: Inherit, None, Basic, Bearer, API Key or OAuth2 Client Credentials; an imported type that BroadSQL does not support is shown read only;
  • folders and endpoints, with every HTTP method, and each endpoint's optional BroadSQL alias, a stable name reserved for a future script statement and not executable yet.

Import Bruno YAML and Export Bruno YAML read and write the OpenCollection format that IMPORT API BRUNO reads. Export leaves out secret values unless you choose to include them and confirm, and never writes an endpoint's alias, which has no OpenCollection equivalent.

Running requests

The window only configures APIs; it never sends a request. RUN sends them: every GET, HEAD, POST, PUT, PATCH and DELETE endpoint can run. Changes made here apply at once to the command line, and an API imported with IMPORT API BRUNO appears here without a restart.

Last modified in release development.

← All commands

Found something wrong or unclear on this page? , with the page address.