Skip to content
getgeolens.com

Register Table

POST
/ingest/register/
curl --request POST \
--url https://example.com/api/ingest/register/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "table_name": "example", "title": "example", "summary": "example", "visibility": "private" }'

Register an existing PostGIS table as a dataset.

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

Media type application/json
RegisterRequest
object
table_name
required
Table Name

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

string
>= 1 characters <= 63 characters
title
required
Title

Human-readable dataset title shown in the catalog.

string
<= 500 characters
summary
Any of:
string
<= 5000 characters
visibility
Visibility

Dataset visibility level.

string
default: private
Allowed values: private restricted internal public

Successful Response

Media type application/json
TableRegisterResponse
object
dataset_id
required
Dataset Id

Identifier of the newly registered dataset.

string format: uuid
title
required
Title

Title of the registered dataset.

string
table_name
required
Table Name

Source PostgreSQL table that was registered.

string
Example generated
{
"dataset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"title": "example",
"table_name": "example"
}

Bad request — invalid payload

Unauthorized — missing or invalid credentials

Forbidden — caller lacks write access

Not found

Conflict — resource state prevents the operation

Validation error

Internal server error