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.

Authorizations

• OAuth2PasswordBearer

Request Body ^required

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

string

<= 5000 characters

null

null

visibility

Visibility

Dataset visibility level.

string

default: private

Allowed values: private restricted internal public

Responses

201

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"
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}