Currently available routes
/admin/broker-stats/allocator-stats/:allocator
GET
Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache'
URL parameters
Name |
In |
Required |
Type |
allocator |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
/admin/broker-stats/bookieops
GET
Get pending bookie client op stats by namesapce
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
/admin/broker-stats/broker-resource-availability/:property/:cluster/:namespace
GET
Broker availability report
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
409 |
Load-manager doesn't support operation |
/admin/broker-stats/destinations
GET
Get all the destination stats by namesapce
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
/admin/broker-stats/load-report
GET
Get Load for this broker
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
/admin/broker-stats/mbeans
GET
Get all the mbean details of this broker JVM
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
/admin/broker-stats/metrics
GET
Gets the metrics for Monitoring
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
/admin/brokers/configuration
GET
Get all updatable dynamic configurations's name
Responses
Code |
Description |
200 |
successful operation |
/admin/brokers/configuration/values
GET
Get value of all dynamic configurations' value overridden on local config
Responses
Code |
Description |
200 |
successful operation |
404 |
Configuration not found |
/admin/brokers/configuration/:configName/:configValue
POST
Update dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.
URL parameters
Name |
In |
Required |
Type |
configName |
path |
true |
string |
configValue |
path |
true |
string |
Responses
Code |
Description |
204 |
Service configuration updated successfully |
403 |
You don't have admin permission to update service-configuration |
404 |
Configuration not found |
412 |
Configuration can't be updated dynamically |
/admin/brokers/:cluster
GET
Get the list of active brokers (web service addresses) in the cluster.
URL parameters
Name |
In |
Required |
Type |
cluster |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Cluster doesn't exist |
/admin/brokers/:cluster/:broker/ownedNamespaces
GET
Get the list of namespaces served by the specific broker
URL parameters
Name |
In |
Required |
Type |
cluster |
path |
true |
string |
broker |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Cluster doesn't exist |
/admin/clusters
GET
Get the list of all the Pulsar clusters.
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
/admin/clusters/:cluster
GET
Get the configuration data for the specified cluster.
URL parameters
Name |
In |
Required |
Type |
cluster |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Cluster doesn't exist |
POST
Update the configuration for a cluster.
URL parameters
Name |
In |
Required |
Type |
cluster |
path |
true |
string |
Responses
Code |
Description |
204 |
Cluster has been updated |
403 |
Don't have admin permission |
404 |
Cluster doesn't exist |
PUT
Provisions a new cluster. This operation requires Pulsar super-user privileges.
URL parameters
Name |
In |
Required |
Type |
cluster |
path |
true |
string |
Responses
Code |
Description |
204 |
Cluster has been created |
403 |
You don't have admin permission to create the cluster |
409 |
Cluster already exists |
412 |
Cluster name is not valid |
DELETE
Delete an existing cluster
URL parameters
Name |
In |
Required |
Type |
cluster |
path |
true |
string |
Responses
Code |
Description |
204 |
Cluster has been updated |
403 |
Don't have admin permission |
404 |
Cluster doesn't exist |
412 |
Cluster is not empty |
/admin/clusters/:cluster/namespaceIsolationPolicies
GET
Get the namespace isolation policies assigned in the cluster
URL parameters
Name |
In |
Required |
Type |
cluster |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Cluster doesn't exist |
/admin/clusters/:cluster/namespaceIsolationPolicies/:policyName
GET
Get a single namespace isolation policy assigned in the cluster
URL parameters
Name |
In |
Required |
Type |
cluster |
path |
true |
string |
policyName |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Policy doesn't exist |
412 |
Cluster doesn't exist |
POST
Set namespace isolation policy
URL parameters
Name |
In |
Required |
Type |
cluster |
path |
true |
string |
policyName |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission or plicy is read only |
412 |
Cluster doesn't exist |
DELETE
Delete namespace isolation policy
URL parameters
Name |
In |
Required |
Type |
cluster |
path |
true |
string |
policyName |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission or plicy is read only |
412 |
Cluster doesn't exist |
/admin/clusters/:cluster/peers
POST
Update peer-cluster-list for a cluster.
URL parameters
Name |
In |
Required |
Type |
cluster |
path |
true |
string |
Responses
Code |
Description |
204 |
Cluster has been updated |
403 |
Don't have admin permission |
404 |
Cluster doesn't exist |
412 |
Peer cluster doesn't exist |
/admin/namespaces/:property
GET
Get the list of all the namespaces for a certain property.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Property doesn't exist |
/admin/namespaces/:property/:cluster
GET
Get the list of all the namespaces for a certain property on single cluster.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Property or cluster doesn't exist |
/admin/namespaces/:property/:cluster/:namespace
GET
Get the dump all the policies specified for a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
PUT
Creates a new empty namespace with no policies attached.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
409 |
Namespace already exists |
412 |
Namespace name is not valid |
DELETE
Delete a namespace and all the destinations under it.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
409 |
Namespace is not empty |
/admin/namespaces/:property/:cluster/:namespace/backlogQuota
POST
Set a backlog quota for all the destinations on a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
backlogQuotaType |
query |
false |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
409 |
Concurrent modification |
412 |
Specified backlog quota exceeds retention quota. Increase retention quota and retry request |
DELETE
Remove a backlog quota policy from a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
backlogQuotaType |
query |
false |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
409 |
Concurrent modification |
/admin/namespaces/:property/:cluster/:namespace/backlogQuotaMap
GET
Get backlog quota map on a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
/admin/namespaces/:property/:cluster/:namespace/bundles
GET
Get the bundles split data.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
412 |
Namespace is not setup to split in bundles |
/admin/namespaces/:property/:cluster/:namespace/clearBacklog
POST
Clear backlog for all destinations on a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
/admin/namespaces/:property/:cluster/:namespace/clearBacklog/:subscription
POST
Clear backlog for a given subscription on all destinations on a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
subscription |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
/admin/namespaces/:property/:cluster/:namespace/deduplication
POST
Enable or disable broker side deduplication for all topics in a namespace
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
/admin/namespaces/:property/:cluster/:namespace/destinations
GET
Get the list of all the destinations under a certain namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
/admin/namespaces/:property/:cluster/:namespace/dispatchRate
GET
Get dispatch-rate configured for the namespace, -1 represents not configured yet
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
POST
Set dispatch-rate throttling for all topics of the namespace
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
/admin/namespaces/:property/:cluster/:namespace/messageTTL
GET
Get the message TTL for the namespace
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
POST
Set message TTL in seconds for namespace
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
412 |
Invalid TTL |
/admin/namespaces/:property/:cluster/:namespace/permissions
GET
Retrieve the permissions for a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
409 |
Namespace is not empty |
/admin/namespaces/:property/:cluster/:namespace/permissions/:role
POST
Grant a new permission to a role on a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
role |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
409 |
Concurrent modification |
DELETE
Revoke all permissions to a role on a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
role |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
/admin/namespaces/:property/:cluster/:namespace/persistence
GET
Get the persistence configuration for a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
409 |
Concurrent modification |
POST
Set the persistence configuration for all the destinations on a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
400 |
Invalid persistence policies |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
409 |
Concurrent modification |
/admin/namespaces/:property/:cluster/:namespace/replication
GET
Get the replication clusters for a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
412 |
Namespace is not global |
POST
Set the replication clusters for a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
409 |
Peer-cluster can't be part of replication-cluster |
412 |
Namespace is not global or invalid cluster ids |
/admin/namespaces/:property/:cluster/:namespace/retention
GET
Get retention config on a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
POST
Set retention configuration on a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
409 |
Concurrent modification |
412 |
Retention Quota must exceed backlog quota |
/admin/namespaces/:property/:cluster/:namespace/unload
PUT
Unload namespace
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
412 |
Namespace is already unloaded or Namespace has bundles activated |
/admin/namespaces/:property/:cluster/:namespace/unsubscribe/:subscription
POST
Unsubscribes the given subscription on all destinations on a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
subscription |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
/admin/namespaces/:property/:cluster/:namespace/:bundle
DELETE
Delete a namespace bundle and all the destinations under it.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
bundle |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Property or cluster or namespace doesn't exist |
409 |
Namespace bundle is not empty |
/admin/namespaces/:property/:cluster/:namespace/:bundle/clearBacklog
POST
Clear backlog for all destinations on a namespace bundle.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
bundle |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
/admin/namespaces/:property/:cluster/:namespace/:bundle/clearBacklog/:subscription
POST
Clear backlog for a given subscription on all destinations on a namespace bundle.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
subscription |
path |
true |
string |
bundle |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
/admin/namespaces/:property/:cluster/:namespace/:bundle/split
PUT
Split a namespace bundle
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
bundle |
path |
true |
string |
authoritative |
query |
false |
boolean |
unload |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
/admin/namespaces/:property/:cluster/:namespace/:bundle/unload
PUT
Unload a namespace bundle
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
bundle |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
/admin/namespaces/:property/:cluster/:namespace/:bundle/unsubscribe/:subscription
POST
Unsubscribes the given subscription on all destinations on a namespace bundle.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
subscription |
path |
true |
string |
bundle |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
/admin/non-persistent/:property/:cluster/:namespace
GET
Get the list of destinations under a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace doesn't exist |
/admin/non-persistent/:property/:cluster/:namespace/partitioned
GET
Get the list of partitioned topics under a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace doesn't exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination
DELETE
Delete a topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic does not exist |
412 |
Topic has active producers/subscriptions |
/admin/non-persistent/:property/:cluster/:namespace/:destination/all_subscription/expireMessages/:expireTimeInSeconds
POST
Expire messages on all subscriptions of topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
expireTimeInSeconds |
path |
true |
integer |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic or subscription does not exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/backlog
GET
Get estimated backlog for offline topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/internal-info
GET
Get the internal stats for the topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic does not exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/internalStats
GET
Get the internal stats for the topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Topic does not exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/partitioned-stats
GET
Get the stats for the partitioned topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Topic does not exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/partitions
GET
Get partitioned topic metadata.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
POST
Increment partitons of an existing partitioned topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
409 |
Partitioned topic does not exist |
PUT
Create a partitioned topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
409 |
Partitioned topic already exist |
DELETE
Delete a partitioned topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Partitioned topic does not exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/permissions
GET
Get permissions on a destination.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace doesn't exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/permissions/:role
POST
Grant a new permission to a role on a single destination.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
role |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace doesn't exist |
409 |
Concurrent modification |
DELETE
Revoke permissions on a destination.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
role |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace doesn't exist |
412 |
Permissions are not set at the destination level |
/admin/non-persistent/:property/:cluster/:namespace/:destination/stats
GET
Get the stats for the topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Topic does not exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/subscription/:subName
DELETE
Delete a subscription.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic does not exist |
412 |
Subscription has active consumers |
/admin/non-persistent/:property/:cluster/:namespace/:destination/subscription/:subName/expireMessages/:expireTimeInSeconds
POST
Expire messages on a topic subscription.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
expireTimeInSeconds |
path |
true |
integer |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic or subscription does not exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/subscription/:subName/position/:messagePosition
GET
Peek nth message on a topic subscription.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
messagePosition |
path |
true |
integer |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic, subscription or the message position does not exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/subscription/:subName/resetcursor
POST
Reset subscription to message position closest to given position.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic/Subscription does not exist |
405 |
Not supported for partitioned topics |
/admin/non-persistent/:property/:cluster/:namespace/:destination/subscription/:subName/resetcursor/:timestamp
POST
Reset subscription to message position closest to absolute timestamp (in ms).
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
timestamp |
path |
true |
integer |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic/Subscription does not exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/subscription/:subName/skip/:numMessages
POST
Skip messages on a topic subscription.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
numMessages |
path |
true |
integer |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic or subscription does not exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/subscription/:subName/skip_all
POST
Skip all messages on a topic subscription.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic or subscription does not exist |
405 |
Operation not allowed on non-persistent topic |
/admin/non-persistent/:property/:cluster/:namespace/:destination/subscriptions
GET
Get the list of persistent subscriptions for a given topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Topic does not exist |
/admin/non-persistent/:property/:cluster/:namespace/:destination/terminate
POST
Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Topic does not exist |
405 |
Operation not allowed on non-persistent topic |
/admin/non-persistent/:property/:cluster/:namespace/:destination/unload
PUT
Unload a topic
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic does not exist |
/admin/persistent/:property/:cluster/:namespace
GET
Get the list of destinations under a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace doesn't exist |
/admin/persistent/:property/:cluster/:namespace/partitioned
GET
Get the list of partitioned topics under a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace doesn't exist |
/admin/persistent/:property/:cluster/:namespace/:destination
DELETE
Delete a topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic does not exist |
412 |
Topic has active producers/subscriptions |
/admin/persistent/:property/:cluster/:namespace/:destination/all_subscription/expireMessages/:expireTimeInSeconds
POST
Expire messages on all subscriptions of topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
expireTimeInSeconds |
path |
true |
integer |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic or subscription does not exist |
/admin/persistent/:property/:cluster/:namespace/:destination/backlog
GET
Get estimated backlog for offline topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
/admin/persistent/:property/:cluster/:namespace/:destination/internal-info
GET
Get the internal stats for the topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic does not exist |
/admin/persistent/:property/:cluster/:namespace/:destination/internalStats
GET
Get the internal stats for the topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Topic does not exist |
/admin/persistent/:property/:cluster/:namespace/:destination/partitioned-stats
GET
Get the stats for the partitioned topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Topic does not exist |
/admin/persistent/:property/:cluster/:namespace/:destination/partitions
GET
Get partitioned topic metadata.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
POST
Increment partitons of an existing partitioned topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
409 |
Partitioned topic does not exist |
PUT
Create a partitioned topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
409 |
Partitioned topic already exist |
DELETE
Delete a partitioned topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Partitioned topic does not exist |
/admin/persistent/:property/:cluster/:namespace/:destination/permissions
GET
Get permissions on a destination.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace doesn't exist |
/admin/persistent/:property/:cluster/:namespace/:destination/permissions/:role
POST
Grant a new permission to a role on a single destination.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
role |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace doesn't exist |
409 |
Concurrent modification |
DELETE
Revoke permissions on a destination.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
role |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Namespace doesn't exist |
412 |
Permissions are not set at the destination level |
/admin/persistent/:property/:cluster/:namespace/:destination/stats
GET
Get the stats for the topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Topic does not exist |
/admin/persistent/:property/:cluster/:namespace/:destination/subscription/:subName
DELETE
Delete a subscription.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic does not exist |
412 |
Subscription has active consumers |
/admin/persistent/:property/:cluster/:namespace/:destination/subscription/:subName/expireMessages/:expireTimeInSeconds
POST
Expire messages on a topic subscription.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
expireTimeInSeconds |
path |
true |
integer |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic or subscription does not exist |
/admin/persistent/:property/:cluster/:namespace/:destination/subscription/:subName/position/:messagePosition
GET
Peek nth message on a topic subscription.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
messagePosition |
path |
true |
integer |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic, subscription or the message position does not exist |
/admin/persistent/:property/:cluster/:namespace/:destination/subscription/:subName/resetcursor
POST
Reset subscription to message position closest to given position.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic/Subscription does not exist |
405 |
Not supported for partitioned topics |
/admin/persistent/:property/:cluster/:namespace/:destination/subscription/:subName/resetcursor/:timestamp
POST
Reset subscription to message position closest to absolute timestamp (in ms).
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
timestamp |
path |
true |
integer |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic/Subscription does not exist |
/admin/persistent/:property/:cluster/:namespace/:destination/subscription/:subName/skip/:numMessages
POST
Skip messages on a topic subscription.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
numMessages |
path |
true |
integer |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic or subscription does not exist |
/admin/persistent/:property/:cluster/:namespace/:destination/subscription/:subName/skip_all
POST
Skip all messages on a topic subscription.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
subName |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic or subscription does not exist |
405 |
Operation not allowed on non-persistent topic |
/admin/persistent/:property/:cluster/:namespace/:destination/subscriptions
GET
Get the list of persistent subscriptions for a given topic.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Topic does not exist |
/admin/persistent/:property/:cluster/:namespace/:destination/terminate
POST
Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Topic does not exist |
405 |
Operation not allowed on non-persistent topic |
/admin/persistent/:property/:cluster/:namespace/:destination/unload
PUT
Unload a topic
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
destination |
path |
true |
string |
authoritative |
query |
false |
boolean |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Topic does not exist |
/admin/properties
GET
Get the list of properties.
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Property doesn't exist |
/admin/properties/:property
GET
Get the admin configuration for a given property.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Property doesn't exist |
POST
Update the admins for a property.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Property does not exist |
409 |
Property already exist |
PUT
Create a new property.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
409 |
Property already exist |
412 |
Property name is not valid |
DELETE
elete a property and all namespaces and destinations under it.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
404 |
Property does not exist |
409 |
The property still has active namespaces |
/admin/resource-quotas
GET
Get the default quota
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
POST
Set the default quota
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
/admin/resource-quotas/:property/:cluster/:namespace/:bundle
GET
Get resource quota of a namespace bundle.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
bundle |
path |
true |
string |
Responses
Code |
Description |
200 |
successful operation |
403 |
Don't have admin permission |
404 |
Namespace does not exist |
POST
Set resource quota on a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
bundle |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
409 |
Concurrent modification |
DELETE
Remove resource quota for a namespace.
URL parameters
Name |
In |
Required |
Type |
property |
path |
true |
string |
cluster |
path |
true |
string |
namespace |
path |
true |
string |
bundle |
path |
true |
string |
Responses
Code |
Description |
403 |
Don't have admin permission |
409 |
Concurrent modification |