Shows the full stored definition of an API endpoint: URL template, response format, resolved option map, pagination strategy, current watermark, and landed-file layout hints. Sensitive option values are masked.
DESCRIBE API ENDPOINT [IF EXISTS] <name>## Overview DESCRIBE API ENDPOINT returns the catalog row for a single endpoint with all options flattened into a human-readable form. It is the definitive answer to 'what does this endpoint actually do when I INVOKE it'. Typical fields: qualified_name, connection, url, response_format, path_params (map), query_params (map), headers (map), pagination (strategy + config), watermark_column, watermark_value, max_pages, write options, created_at, updated_at, last_run_status. ## Behavior - Option values are shown as stored, no evaluation happens. If the engine needs the resolved URL for a specific INVOKE, it substitutes path_param.* at fetch time. - Secret-bearing keys (if any somehow slipped past the parser's reject list) are masked as '***'. - The watermark_value is the value that will be filtered on during the next incremental INVOKE. FULL REFRESH ignores this value but does not change it until the new run completes. ## Access Control Requires the admin role. ## Compatibility DeltaForge extension.
| Name | Type | Description |
|---|---|---|
name | Target endpoint as <zone>.<api>.<name>. | |
if_exists | When true, silently no-op if the endpoint does not exist. |
DESCRIBE API ENDPOINT landing.github.issues;DESCRIBE API ENDPOINT IF EXISTS landing.crm.accounts;