DROP API ENDPOINT

Removes an API endpoint definition and its run-log entries. Landed files in the storage zone are not deleted.

Category: api-endpointPrivilege: adminDeltaForge extension

Syntax

DROP API ENDPOINT [IF EXISTS] <name>

Description

## Overview DROP API ENDPOINT removes the endpoint definition and its invocation history from the catalog. It is the inverse of CREATE API ENDPOINT. ## Behavior - The catalog row for the endpoint is deleted, along with associated run-log entries surfaced by SHOW API ENDPOINT RUNS. - Files already written to the storage zone by prior INVOKE runs are NOT deleted, those remain queryable via any external table already registered over them. Use a storage-side cleanup (or DROP EXTERNAL TABLE ... WITH FILES on the consuming external table) to reclaim space. - The rest_api CONNECTION that owned this endpoint is unaffected and may still own other endpoints. ## Access Control Requires the admin role. ## Compatibility DeltaForge extension.

Parameters

NameTypeDescription
nameTarget endpoint as <zone>.<api>.<name>.
if_existsWhen true, silently no-op if the endpoint does not exist.

Examples

DROP API ENDPOINT landing.github.issues;
DROP API ENDPOINT IF EXISTS landing.github.pulls;

Pitfalls

See Also

Open in interactive docs →   DeltaForge home →