Skip to main content

Endpoints

The endpoints list

The list shows every endpoint in the workspace. Download OpenAPI exports an OpenAPI description of the published endpoints, and + Endpoint creates one.

Create an endpoint​

New endpoint

A new endpoint needs only a few fields. Everything else (parameters, output shape, cache, limits) is configured on the endpoint once it exists.

FieldMeaning
NameA label, for example Daily report.
PathThe URL path, for example reports/daily.
DescriptionOptional: what it returns and who it is for.
MethodThe HTTP method, GET by default.
DatabaseThe database connection the query runs on.
SQLThe query to publish.

Press Create endpoint when the form is complete.