SHOW API ENDPOINTS

Lists all API endpoint definitions, optionally filtered by owning rest_api connection and/or a LIKE pattern on the endpoint name.

Category: api-endpointPrivilege: adminDeltaForge extension

Syntax

SHOW API ENDPOINTS [IN CONNECTION <connection>] [LIKE '<pattern>']

Description

## Overview SHOW API ENDPOINTS returns one row per endpoint definition, mirroring what the GUI Connections → API Endpoints view shows. Columns include the three-part name, owning connection, URL, response format, pagination strategy, current watermark, and last-run timestamp. ## Behavior - With no filter, returns every endpoint the caller is authorised to see across all rest_api connections. - IN CONNECTION <connection> narrows to a specific connection, useful when a single API source owns many endpoints. - LIKE filters the leaf endpoint name only (not the three-part qualified name). Use '%' / '_' as the usual wildcards. - Sensitive option values (anything keyed under the secret-reject list, which should not be there anyway) are masked in the output. ## Access Control Requires the admin role. ## Compatibility DeltaForge extension.

Parameters

NameTypeDescription
connectionTwo-part <zone>.<api> name of a rest_api connection. Restricts the listing to endpoints bound to that connection.
like_patternStandard SQL LIKE filter applied to the endpoint leaf name.

Examples

SHOW API ENDPOINTS;
SHOW API ENDPOINTS IN CONNECTION landing.github;
SHOW API ENDPOINTS IN CONNECTION landing.github LIKE 'iss%';

Pitfalls

See Also

Open in interactive docs →   DeltaForge home →