SHOW ENDPOINTS

Core command ENDPOINTS ALL ENDPOINTS SHENDS

Lists the endpoints of the connected API, or of a given API, filtered by method or text.

Syntax

SHOW ENDPOINTS [API <api>] [<method>] [MATCH <text>]

Arguments

Argument	Required	Values	Default
`API <api>`	No	The ID of an API; no `CONNECT API` session is needed then	The API of the session
`<method>`	No	An HTTP method, such as `GET`; `VERB <method>` works too	Every method
`MATCH <text>`	No	Text the folder, name or alias contains, ignoring case	No filter

Examples

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

Details

Which API

With API <api>, the command lists that API and needs no CONNECT API session. Without it, it lists the API of the session, checking each time that the API is still active, since it may have been deactivated in CONFIG API meanwhile.

Filters

An HTTP method, such as GET, keeps the endpoints of exactly that method, ignoring case. The older form VERB <method> still works.
MATCH <text> keeps the endpoints whose folder, name or alias contains the text, ignoring case.

The two filters can be combined, in either order, after API <api>, or first when it is omitted.

Output

A table with ID, VERB, FOLDER, NAME and ALIAS. Since two folders often hold endpoints of the same name, use the numeric ID or an alias with SHOW ENDPOINT and SYNTAX. SHOW ENDPOINT <id> shows the full detail of one endpoint.

SHOW ENDPOINT, one endpoint in detail
SYNTAX
RUN
SHOW ALL APIS

Last modified in release 5.5.0.

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