Update table schema metadata

Changed on Jul 1, 2026

Replace the schema metadata for table id with the provided key-value pairs.

REST NAMESPACE ONLY REST namespace uses a direct object (map of string to string) as both request and response body instead of the wrapped UpdateTableSchemaMetadataRequest and UpdateTableSchemaMetadataResponse.

post/v1/table/{id}/schema_metadata/update

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.

branchstring

Optional branch to target. When not specified, the main branch is used. Used by branch-scoped operations that cannot carry a branch field in their request body (Arrow IPC stream and bodyless operations). Operations with a JSON request body carry branch as a body field instead.

Request body

unknown required

Response

Schema metadata update result