Under the hood, both the pulsar-admin CLI tool and the Java client both use the REST API. If you’d like to implement your own admin interface client, you should use the REST API as well. Full documentation can be found here.

In this document, examples from each of the three available interfaces will be shown.

Admin setup

pulsar-admin

If you have authentication enabled, you will need to provide an auth configuration to use the pulsar-admin tool. By default, the configuration for the pulsar-admin tool is found in the conf/client.conf file. Here are the available parameters:

Name

Description

Default

webServiceUrl

The web URL for the cluster.

http://localhost:8080/

brokerServiceUrl

The Pulsar protocol URL for the cluster.

pulsar://localhost:6650/

authPlugin

The authentication plugin.

authParams

The authentication parameters for the cluster, as a comma-separated string.