Skip to main content

Pulsar REST APIs

A REST API (also known as RESTful API, REpresentational State Transfer Application Programming Interface) is a set of definitions and protocols for building and integrating application software, using HTTP requests to GET, PUT, POST, and DELETE data following the REST standards. In essence, REST API is a set of remote calls using standard methods to request and return data in a specific format between two systems.

Pulsar provides a variety of REST APIs that enable you to interact with Pulsar to retrieve information or perform an action.

REST API categoryDescription
AdminREST APIs for administrative operations.
FunctionsREST APIs for function-specific operations.
SourcesREST APIs for source-specific operations.
SinksREST APIs for sink-specific operations.
PackagesREST APIs for package-specific operations. A package can be a group of functions, sources, and sinks.
TransactionsREST APIs for transaction-specific operations.
LookupREST APIs for lookup-specific operations, such as getting the owner broker of a topic, getting the namespace bundle that a topic belongs to, and so on.