API Reference

Complete REST API documentation for Bingsan, compliant with the Apache Iceberg REST Catalog specification.

Base URL

http://localhost:8181/v1

Authentication

When authentication is enabled, include the bearer token in requests:

curl -H "Authorization: Bearer <token>" http://localhost:8181/v1/namespaces

See Authentication Configuration for details.

Content Type

All requests with a body should use:

Content-Type: application/json

API Sections

Core Operations

• Namespaces - Namespace CRUD operations
• Tables - Table management and commits
• Views - View management

Error Responses

All error responses follow this format:

{
  "error": {
    "message": "Error description",
    "type": "ErrorType",
    "code": 400
  }
}

Common Error Types

Catalog Prefix

Bingsan supports prefixed API paths for multi-catalog deployments:

/v1/{prefix}/namespaces
/v1/{prefix}/namespaces/{namespace}/tables

Example:

curl http://localhost:8181/v1/my-catalog/namespaces