BroadSQL BroadSQL Downloads
Documentation / Commands / SHOW ENDPOINT

SHOW ENDPOINT

Core command ENDPOINT SHEND

Shows one endpoint's full detail as a vertical view (the same collection => table, single object => detail-view convention as SHOW CONNECTION): ID, owning API, folder, name, alias, method, and the composed effective URL (base path plus enabled query parameters plus fragment, the same composition the CONFIG API endpoint editor and RUN's request builder use). Then, where present: query parameters and path parameters (name, value, enabled/disabled; a value flagged secret is masked), headers (same masking rule), the request body (mode and full content), and an authentication summary (type only, or 'Inherited', never a resolved credential value). The argument accepts a numeric id (global, unique across every API, no active session needed), an alias, or a name (both scoped to the active CONNECT API session's API). A name matching more than one endpoint is reported as an ambiguous-candidates table instead of being guessed at; use the id or alias in that case.

Arguments

<id|alias|name> (mandatory): a numeric endpoint id (SHOW ENDPOINTS to find it, no session required), or an alias/name (requires an active CONNECT API session)

Examples

SHOW ENDPOINT 17;
SHOW ENDPOINT PINGMAIL;
SHOW ENDPOINT findAll;

Notes

SHOW ENDPOINT <id|alias|name>;: the single-object detail view for one endpoint, following the same collection => table, single object => vertical detail view convention as SHOW CONNECTION (whose hand-rolled "LABEL : value" idiom this class matches; no shared detail-renderer exists yet in this codebase).

SPRINT XT02B, section 6: the token is resolved via the shared ApiEndpointReferenceResolver, where a numeric token is a plain, global API_ENDPOINT.ID lookup (unique across every API, so this still needs no active CONNECT API session for that case, exactly like before this sprint); a non-numeric token is tried as an alias, then as a name, both scoped to the active session's API (so a session is required for that case). A name that matches more than one endpoint is reported as an ambiguous-candidates table (ID/METHOD/FOLDER/NAME/ALIAS/PATH) rather than guessed at.

The displayed URL is the composed effective URL: base path plus enabled query parameters plus fragment, via compose, the same helper the endpoint editor GUI and the request builder use, so all three surfaces agree on what "the URL" is. A query/ path parameter or header value is masked (******) when its isSecret() flag is set, the same, already-established secret convention JApiAttributeTablePanel's "Secret" column and toString() use; this command does not invent a new classification scheme, and does not detect a hardcoded secret that was never flagged as one. Authentication is summarized by type only (inherited, or which type is configured), never a resolved credential value.

Last modified in release 5.2.6.

← All commands