Skip to main content
Version: Next

Pulsar admin interfaces

Pulsar admin APIs enable you to administer clusters programmatically. For example, you can create, update, delete, and manage all the entities within Pulsar instances (such as clusters, namespaces, tenants, topics, schemas, connectors, functions, and so on), and set various policies for data, resources, and security.

Admin APIs - Definition

You can interact with the admin interface via:

  • The pulsar-admin CLI tool, which is available in the bin folder of your Pulsar installation:

    bin/pulsar-admin
    tip

    For the latest and complete information about Pulsar admin, including commands, flags, descriptions, and more information, see Pulsar admin doc.

    Pulsar Shell extends pulsar-admin with an improved user experience for more flexibility and easier navigation between multiple clusters.

  • HTTP calls, which are made against the admin REST API provided by Pulsar brokers. For some RESTful APIs, they might be redirected to the owner brokers for serving with 307 Temporary Redirect, hence the HTTP callers should handle 307 Temporary Redirect. If you use curl commands, you should specify -L to handle redirections.

    tip

    For the latest and complete information about REST API, including parameters, responses, samples, and more, see REST API doc.

  • A Java client interface.

    tip

    For the latest and complete information about Java admin API, including classes, methods, descriptions, and more, see Java admin API doc.

The REST API is the admin interface. Both the pulsar-admin CLI tool and the Java client use the REST API. If you implement your own admin interface client, you should use the REST API.