The Pulsar admin interface

The Pulsar admin interface enables you to manage all of the important entities in a Pulsar instance, such as properties, topics, and namespaces.

You can currently interact with the admin interface via:

  1. Making HTTP calls against the admin REST API provided by Pulsar brokers.
  2. The pulsar-admin CLI tool, which is available in the bin folder of your Pulsar installation:

     $ bin/pulsar-admin

    Full documentation for this tool can be found in the Pulsar command-line tools doc.

  3. A Java client interface.

The REST API is the admin interface

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

Each of Pulsar’s three admin interfaces—the pulsar-admin CLI tool, the Java admin API, and the REST API—requires some special setup if you have authentication enabled in your Pulsar instance.


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.
useTls Whether or not TLS authentication will be enforced in the cluster. false


You can find documentation for the REST API exposed by Pulsar brokers in this reference document.

Java admin client

To use the Java admin API, instantiate a PulsarAdmin object, specifying a URL for a Pulsar broker and a ClientConfiguration. Here’s a minimal example using localhost:

URL url = new URL("http://localhost:8080");
String authPluginClassName = ""; //Pass auth-plugin class fully-qualified name if Pulsar-security enabled
String authParams = "param1=value1";//Pass auth-param if auth-plugin class requires it
boolean useTls = false;
boolean tlsAllowInsecureConnection = false;
String tlsTrustCertsFilePath = null;

ClientConfiguration config = new ClientConfiguration();
config.setAuthentication(authPluginClassName, authParams);

PulsarAdmin admin = new PulsarAdmin(url, config);