Catalog API REST Endpoints

Sort by

Task Path Method

Catalog API

The operations from the Catalog API category.

Check if a namespace exists

Method: head

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}

Check if a table exists

Method: head

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/tables/{table}

Check if a view exists

Method: head

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/views/{view}

Commit updates to a table

Method: post

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/tables/{table}

Commit updates to multiple tables in an atomic operation

Method: post

Path: {scheme}://{host}/{basePath}/v1/{prefix}/transactions/commit

Create a namespace

Method: post

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces

Create a table in the given namespace

Method: post

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/tables

Create a view in the given namespace

Method: post

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/views

Drop a namespace from the catalog. Namespace must be empty.

Method: delete

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}

Drop a table from the catalog

Method: delete

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/tables/{table}

Drop a view from the catalog

Method: delete

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/views/{view}

List all table identifiers underneath a given namespace

Method: get

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/tables

List all view identifiers underneath a given namespace

Method: get

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/views

List top-level namespaces

Method: get

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces

Load a table from the catalog

Method: get

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/tables/{table}

Load a view from the catalog

Method: get

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/views/{view}

Load the metadata properties for a namespace

Method: get

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}

Register a table in the given namespace using given metadata file location

Method: post

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/register

Rename a table from its current name to a new name

Method: post

Path: {scheme}://{host}/{basePath}/v1/{prefix}/tables/rename

Rename a view from its current name to a new name

Method: post

Path: {scheme}://{host}/{basePath}/v1/{prefix}/views/rename

Replace a view

Method: post

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/views/{view}

Send a metrics report to this endpoint to be processed by the backend

Method: post

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/tables/{table}/metrics

Set or remove properties on a namespace

Method: post

Path: {scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/properties