Documentation / Commands / SHOW ENDPOINTS

SHOW ENDPOINTS

Core command ENDPOINTS ALL ENDPOINTS SHENDS

Lists endpoints as a table (ID, VERB, FOLDER, NAME, ALIAS). With API <apiId>, targets that API directly: no active session required. Without it, lists the active CONNECT API session's API, revalidating its status on every call (a session can outlive the API it points at being deactivated via CONFIG API in the meantime). A bare HTTP method (e.g. GET) filters on that exact, case-insensitive verb, the canonical form; the legacy VERB <verb> form is still accepted for backward compatibility. MATCH <keyword> filters on a case-insensitive substring over folder, name, and alias combined; both filters may be combined, in either order, after API <apiId> (or first, when API is omitted). The numeric ID or an assigned alias is what SHOW ENDPOINT/SYNTAX/HELP take to select an endpoint unambiguously, since duplicate endpoint names across different folders are normal. See also SHOW ENDPOINT <id> for a single endpoint's full detail (URL, headers, parameters, body).

Arguments

API <apiId> (optional, targets that API directly, no active session required); <method> (optional, e.g. GET, canonical form; VERB <verb> also accepted); MATCH <keyword> (optional, either order)

Examples

SHOW ENDPOINTS; SHOW ENDPOINTS GET; SHOW ENDPOINTS GET MATCH mail; SHOW ENDPOINTS API DEMO; SHOW ENDPOINTS API DEMO GET MATCH mail;

Notes

SHOW ENDPOINTS [API <apiId>] [VERB <verb>] [MATCH <keyword>];: API Quality and UX Consolidation sprint, the single canonical endpoint-listing command, replacing the former SHOW API ENDPOINTS <apiId>/SHOW ENDPOINTS duplication.

API <apiId> makes the command self-contained: it targets that API directly and does not require an active CONNECT API session (this is what SHOW API ENDPOINTS used to do alone). Omitting it falls back to the active session context (what plain SHOW ENDPOINTS used to do alone). Both forms share the same listing/filtering/rendering logic via ApiEndpointListingBuilder, so they can never drift apart. VERB/ MATCH apply identically either way, and may appear in either order after `API <apiId> (or first, when API` is omitted).

Columns: ID, VERB, FOLDER, NAME, ALIAS: a compact catalog/navigation view (URL and executability were removed; see SHOW ENDPOINT <id> for the full detail view of one endpoint).

Last modified in release 5.2.6.