Introduction

Query Data

preview

Lists all tables in cluster

Delete tables partitions

Ingest a file

Ingest from the given URI

Get the instance partitions

Create/update the instance partitions

Remove the instance partitions

Replace an instance in the instance partitions

Assign server instances to a table

Pause consumption of a realtime table

Resume consumption of a realtime table

Get status for a submitted force commit operation

Returns state of pauseless table

Return pause status of a realtime table

Force commit the current consuming segments

Returns state of consuming segments

List table instances

List tables to live brokers mappings

List the brokers serving a table

Recommend config

Lists the table configs

Updates table config for a table

Deletes a table

Validate table config for a table

Rebalances a table (reassign instances and segments for a table)

Cancel all rebalance jobs for the given table, and noop if no rebalance is running

Gets detailed stats of a rebalance operation

table status

Get current table state

Enable/disable a table

table stats

Lists all tables in cluster

Adds a table

Get the aggregate validDocIds metadata of all segments for a table

Get the aggregate metadata of all segments for a table

Get the aggregate index details of all segments for a table

Get list of controller jobs for this table

Set hybrid table query time boundary based on offline segments' metadata

Delete hybrid table query time boundary

Rebuild broker resource for table

Validate the TableConfigs

Lists all TableConfigs in cluster

Add the TableConfigs using the tableConfigsStr json

Get the TableConfigs for a given raw tableName

Update the TableConfigs provided by the tableConfigsStr json

Delete the TableConfigs

Read table sizes

Get segment names to segment status map

Get table ideal state

Get table external view

Get the list of servers to restart in sequence

Get cached cluster health details for all pinot entities

Enable / disable the periodic cluster health check task. Note that this setting isn't persisted across controller restarts and /cluster/configs should be used to disable it permanently

Get all available cluster health checks and their details

Get cluster properties if deployed in AZ aware mode

browse

Update consistentPush state

Add metadata location of a new dedup snapshot

Delete dedup snapshot and its metadata

Get dedup snapshot metadata by the snapshot name

Add metadata of a new dedup snapshot

Get all dedup snapshot names for the table

Get latest dedup snapshot names for all partitions

Get perf advisor recommendations given a query

Update rate limiter configs

Mark the start of data ingestion to upload multiple segments

Get Segment to rows factor from customMap of progress metadata

Delete the minion task metadata

Mark the end of data ingestion to upload multiple segments

Restream data from a stream to a new table. Then replace the table

Gets detailed stats of a restream operation

DEBUG ONLY: Process the next stage of the restream workflow.

Cancel a restream operation

Apply tuner(s) to a table

Apply specific tuner to a table

Get progress and estimated completion time for the task

Add metadata of a new upsert snapshot

Delete upsert snapshot metadata

Get all upsert snapshot names for the table

Get latest upsert snapshot names for all partitions

Add metadata location of a new upsert snapshot

Delete upsert snapshot and its metadata

Get upsert snapshot metadata by the snapshot name

Get debug information for table.

Get debug information for segment.

Get the configuration for Groovy Static analysis

Update Groovy static analysis configuration

Get cluster Info

List cluster configurations

Update cluster configuration

Delete cluster configuration

Get the default configuration for Groovy Static analysis

List all uses in cluster

Add a user

Get an user in cluster

Update user config for a user

Delete a user

Get application qps quota

Update application quota

Get all application qps quotas

List tenants to brokers mappings

List tables to brokers mappings

List tenants to brokers mappings

List tables to brokers mappings

Enable/disable the query rate limiting for a broker instance

List tenants and tables to brokers mappings

List brokers for a given tenant

List brokers for a given tenant

List brokers for a given table

List brokers for a given table

List tenants and tables to brokers mappings

Get appconfigs

Retrieve auth workflow info

Check whether authentication is enabled

Check controller health

Check controller health

Get controller uptime

Get controller start time

Collect log files from a given instance

Collect log files from all the instances

Download a log file from a given instance

Download a log file

Get all local log files

Get logger configs

Set logger level

Get all the loggers

Run periodic task against table. If table name is missing, task will run against all tables.

Get comma-delimited list of all available periodic task names.

Delete all tables in given database name

List all database names

Get database quota configs

Update database quotas

Enable/disable an instance

Enable/disable/drop an instance

Check if it's safe to update the tags of the given instances. If not list all the reasons.

List all instances

Create a new instance

List all live instances

Update the tables served by the specified broker instance in the broker resource

Get instance information

Update the specified instance

Drop an instance

Update the tags of the specified instance

Check if it's safe to drop the given instances. If not list all the reasons why its not safe.

Gets leaders for all tables

Gets leader for a given table

Cancel a query as identified by the clientQueryId

Get running queries from all brokers

Cancel a query as identified by the clientQueryId

Cancel a query as identified by the queryId

List all schema names

Add a new schema

List all schemas info with count of field specs

Get fieldSpec metadata

Get a schema

Update a schema

Delete a schema

Validate schema

Get table schema

Get the metadata for a segment

List all segments. An optional 'excludeReplacedSegments' parameter is used to get the list of segments which has not yet been replaced (determined by segment lineage entries) and can be queried from the table. The value is false by default.

Delete the list of segments provided in the queryParam else all segments

Delete selected segments. An optional 'excludeReplacedSegments' parameter is used to get the list of segments which has not yet been replaced (determined by segment lineage entries) and can be queried from the table. The value is false by default.

Get a map from segment to CRC of the segment (only apply to OFFLINE table)

Get status for a submitted reload operation

Get the server metadata for all table segments

Get the zookeeper metadata for all table segments

Get storage tiers for the given segment

Get selected segments timestamps

Update the start and end time of the segments based on latest schema

Get storage tier for all segments in the given table

Gets the metadata of reload segments check from servers hosting the table

Gets a list of segments that are stale from servers hosting the table

Download a segment

Delete a segment

Reload a segment

Delete the segments in the JSON array payload

Reload all segments

List segment lineage

Get a map from server to segments hosted by the server

Resets a segment by first disabling it, waiting for external view to stabilize, and finally enabling it again

Resets all segments (when errorSegmentsOnly = false) or segments with Error state (when errorSegmentsOnly = true) of the table, by first disabling them, waiting for external view to stabilize, and finally enabling them

Upload a segment

Upload a segment

Reingest a realtime segment

Upload a batch of segments

Start to replace segments

End to replace segments

Revert segments replacement

Fetch cron scheduler job keys

Get the task config (a list of child task configs) for the given task

Get task metadata for the given task type and table

Delete task metadata for the given task type and table

List all task types

Count of all tasks for the given task type

Clean up finished tasks (COMPLETED, FAILED) for the given task type

Stop all running/pending tasks (as well as the task queue) for the given task type

Resume all stopped tasks (as well as the task queue) for the given task type

Delete all tasks (as well as the task queue) for the given task type

Fetch task generation information for the recent runs of the given task for the given table

Fetch cron scheduler information

Fetch job details for table tasks

Execute a task on minion

List all tasks for the given task type

Get the states of all the sub tasks for the given task

Get the configs of specified sub tasks for the given task

Get progress of specified sub tasks for the given task tracked by minion worker in memory

List all tasks for the given task type

Fetch information for all the tasks for the given task type

Fetch information for all the tasks for the given task type and table

Fetch information for the given task name

Get progress of all subtasks with specified state tracked by minion worker in memory

Delete a single task given its task name

Fetch count of sub-tasks for each of the tasks for the given task type

Get the task state for the given task

Schedule tasks and return a map from task type to task name scheduled. If task type is missing, schedules all tasks. If table name is missing, schedules tasks for all tables in the database. If database is missing in headers, uses default.

Get a map from task to task state for the given task type

Get the state (task queue state) for the given task type

Get the task runtime config for the given task

Get the instance partitions of a tenant

Update an instance partition for a server type in a tenant

Gets detailed stats of a tenant rebalance operation

List all tenants

Update a tenant

Create a tenant

List instance for a tenant

enable/disable a tenant

Delete a tenant

List tables on a server or broker tenant

Get tenant information

Change tenant state

Rebalances all the tables that are part of the tenant

Estimate memory usage for an upsert table

Get version number of Pinot components

List the child znodes along with Stats

Update the content of multiple znRecord node under the same path

Update the content of the node

Delete the znode at this path

List the child znodes

Get all child znodes

Get content of the znode

Create a node at a given path