Skip to main content
POST
/
v1
/
namespace
/
{id}
/
describe
Describe a namespace
curl --request POST \
  --url {scheme}://{host}:{port}/{basePath}/v1/namespace/{id}/describe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": [
    "<string>"
  ]
}
'
{
  "properties": {
    "owner": "Ralph",
    "created_at": "1452120468"
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
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

​
delimiter
string

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

Body

application/json
​
id
string[]

Response

Returns a namespace, as well as any properties stored on the namespace if namespace properties are supported by the server.

​
properties
object

Properties stored on the namespace, if supported by the server. If the server does not support namespace properties, it should return null for this field. If namespace properties are supported, but none are set, it should return an empty object.

Example:
{
  "owner": "Ralph",
  "created_at": "1452120468"
}