LAlance-format
Namespace
Metadata

Check if a namespace exists

Changed on

Check if namespace id exists.

This operation must behave exactly like the DescribeNamespace API, except it does not contain a response body.

REST NAMESPACE ONLY REST namespace conveys the result through the HTTP status code with no response body. The REST response maps to the NamespaceExistsResponse model as follows:

  • a 200 response means the namespace exists; a 404 response means it does not
  • response headers map to context via the header. prefix (see the Context schema)
post/v1/namespace/{id}/exists

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[]

Example request

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

Response

Success, no content

Changes

  • 591cd95574b0Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 83f8516f0507Revision changes
    • info

      added the new optional request property