Sign in
Datasets

Register Table

Register an existing PostGIS table as a dataset.

Verifies the table exists, extracts metadata, and creates a catalog entry. Administrators only.

post/ingest/register/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Request body

table_namestring required

PostgreSQL table name in the data schema (max 63 chars per PostgreSQL identifier limit).

titlestring required

Human-readable dataset title shown in the catalog.

summarystring nullable

Optional dataset description.

visibility'private' | 'restricted' | 'internal' | 'public'

Dataset visibility level.

Response

Successful Response

dataset_idstring uuid required

Identifier of the newly registered dataset.

titlestring required

Title of the registered dataset.

table_namestring required

Source PostgreSQL table that was registered.

Changes

No recorded changes to this operation across all 50 revisions of this API.