Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Service APIs

  • reference

The Service APIs let a client application run requests and manage the service using simple HTTP methods. A catalog of available REST resources and requests is provided below.

You can call the Service APIs on any node in the cluster. By default, they listen on port 8095, or 18095 for secure access.

For the APIs that manage the cluster itself, such as nodes, rebalance, security, and service settings, see Cluster Management APIs.

APIs in this Section

For a list of the methods and URIs covered in these pages, see the tables below.

Request API

HTTP Method URI Documented at

POST

/api/v1/request

Request Service

GET

/api/v1/request

Read-Only Request Service

GET

/api/v1/request/status/{request_id}/{job_id}

Request Status

GET

/api/v1/request/result/{request_id}/{job_id}

Retrieve Request Result

DELETE

/api/v1/request/result/{request_id}/{job_id}

Discard Request Result

Administration API

HTTP Method URI Documented at

GET

/api/v1/active_requests

Active Requests

DELETE

/api/v1/active_requests

Request Cancellation

GET

/api/v1/completed_requests

Completed Requests

GET

/api/v1/open_requests

Open Requests

GET

/api/v1/status/service

Service Status

POST

/api/v1/service/restart

Service Restart

POST

/api/v1/node/restart

Node Restart

GET

/api/v1/status/ingestion

Ingestion Status

GET

/api/v1/health

Health Check

Configuration API

HTTP Method URI Documented at

GET

/api/v1/config/service

View Service-Level Parameters

PUT

/api/v1/config/service

Modify Service-Level Parameters

GET

/api/v1/config/node

View Node-Specific Parameters

PUT

/api/v1/config/node

Modify Node-Specific Parameters
HTTP Method URI Documented at

POST

/api/v1/link/{name}

Create Link

GET

/api/v1/link/{name}

Query Link

PUT

/api/v1/link/{name}

Edit Link

DELETE

/api/v1/link/{name}

Delete Link

GET

/api/v1/link

Query All Links

Iceberg API

HTTP Method URI Documented at

GET

/api/v1/iceberg/catalog

List Catalogs

GET

/api/v1/iceberg/catalog/{catalogName}/namespace

List Namespaces

GET

/api/v1/iceberg/catalog/{catalogName}/namespace/{namespace}/table

List Tables

GET

/api/v1/iceberg/snapshot/{databaseName}/{scopeName}/{collectionName}

List Snapshots

Logging API

HTTP Method URI Documented at

GET

/api/v1/cluster/logging

View Configured Loggers

PUT

/api/v1/cluster/logging

Modify Logger Levels

DELETE

/api/v1/cluster/logging

Reset All Loggers

GET

/api/v1/cluster/logging/all

List Available Loggers

GET

/api/v1/cluster/logging/{logger}

View Logger Level

PUT

/api/v1/cluster/logging/{logger}

Modify Logger Level

DELETE

/api/v1/cluster/logging/{logger}

Reset Logger Level