SHOW ENDPOINT

Core command ENDPOINT SHEND

Shows one endpoint in detail: URL, parameters, headers, body and authentication type.

Syntax

SHOW ENDPOINT <endpoint>

Arguments

Argument	Required	Values	Default
`<endpoint>`	Yes	A numeric id (no session needed), or an alias or name of the connected API	None

Examples

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

Details

Finding the endpoint

A numeric id is unique across every API, so it needs no CONNECT API session.
Any other text is tried as an alias, then as a name, in the API of the session, which is then required.

A name that matches several endpoints shows the candidates in a table (ID, method, folder, name, alias, path) instead of choosing one: use the id or the alias then.

What is shown

One endpoint, field by field, as SHOW CONNECTION shows a connection: ID, API, folder, name, alias, method and the effective URL (base path, enabled query parameters and fragment, as the CONFIG API editor and RUN build it). Then, when present:

the query and path parameters (name, value, enabled or not) and the headers; a value flagged as secret is shown as ******;
the request body (mode and full content);
the authentication, by type only (Inherited, or the configured type), never a credential.

Only values flagged as secret are masked: a secret typed into a value that was never flagged is not detected.

SHOW ENDPOINTS
SYNTAX, how to call it
RUN

Last modified in release 5.5.0.

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