Register a table to a namespace

Changed on Jul 1, 2026

post/v1/table/{id}/register

Request

Base URL
http://localhost:2333
Auth
- OAuth 2
  Client credentials
  Token URL: /oauth/token
- or HTTP bearer
- or API key in header x-api-key

Path parameters

idstring required

string identifier of an object in a namespace, following the Lance Namespace spec. When the value is equal to the delimiter, it represents the root namespace. For example, v1/namespace/$/list performs a ListNamespace on the root namespace.

Query parameters

delimiterstring

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

Request body

contextunknown

idstring[]

locationstring required

modestring

There are two modes when trying to register a table, to differentiate the behavior when a table of the same name already exists. Case insensitive, supports both PascalCase and snake_case. Valid values are:

Create (default): the operation fails with 409.
Overwrite: the existing table registration is replaced with the new registration.

propertiesunknown

Example request

{
  "mode": "mode",
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "location": "location",
  "id": [
    "id",
    "id"
  ],
  "properties": {
    "key": "properties"
  }
}

Response

Table properties result when registering a table

contextunknown

transaction_idstring

Optional transaction identifier

locationstring