Connectors
Messaging & Event Streaming
Apache Pulsar Admin
Pulsar administration: tenants, namespaces, topics, subscriptions, functions, and connectors
- Signs in with
- API token
- Runs on
- Cloud or On-Prem Worker
- Operations
- 597
- Ready-made triggers
- 0
Connect Apache Pulsar Admin
- In Neblex open Connect › Connections and click New Connection.
- Search for Apache Pulsar Admin and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| ProtocolRequired | HTTPS for an admin endpoint with TLS. Plain HTTP is only reachable from an On-Prem Worker inside your network. |
| Admin hostRequired | Host and port of your Pulsar admin endpoint (the broker or proxy web service), for example pulsar-admin.example.com:8443. |
| TokenRequiredSecret | A Pulsar authentication token (JWT) for a role with the admin permissions your flows need. |
Use it in a flow
- Open a flow, open the node library and search for Apache Pulsar Admin.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from Apache Pulsar Admin without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Apache Pulsar Admin can send webhooks, a Webhook trigger receives them at its own URL.
Operations
597 operations in 19 groups. Each one is a step you can add to a flow.
Bookies5
Gets raw information for all the bookies in the clustergetAllBookies | GET | Gets raw information for all the bookies in the cluster |
Gets the rack placement information for a specific bookie in the clustergetBookieRackInfo | GET | Gets the rack placement information for a specific bookie in the cluster |
Gets the rack placement information for all the bookies in the clustergetBookiesRackInfo | GET | Gets the rack placement information for all the bookies in the cluster |
Removed the rack placement information for a specific bookie in the clusterdeleteBookieRackInfo | DELETE | Removed the rack placement information for a specific bookie in the cluster |
Updates the rack placement information for a specific bookie in the cluster (noteupdateBookieRackInfo | POST | Updates the rack placement information for a specific bookie in the cluster (note. |
Broker stats7
Broker availability reportgetBrokerResourceAvailability | GET | Broker availability report This API gives the current broker availability in percent, each resource percentage usage is calculated and thensum of all of the resource usage percent is... |
Get all the mbean details of this broker JVMgetMBeans | GET | Get all the mbean details of this broker JVM |
Get all the topic stats by namespacegetTopics2 | GET | Get all the topic stats by namespace |
Get Load for this brokergetLoadReport | GET | Get Load for this broker consists of topics stats & systemResourceUsage |
Get pending bookie client op stats by namespacegetPendingBookieOpsStats | GET | Get pending bookie client op stats by namespace Returns a nested map structure which Swagger does not fully support for display. |
Get the stats for the Netty allocatorgetAllocatorStats | GET | Get the stats for the Netty allocator. |
Gets the metrics for Monitoring (Broker stats get metrics)brokerStatsGetMetrics | GET | Gets the metrics for Monitoring Requested should be executed by Monitoring agent on each broker to fetch the metrics |
Brokers15
An REST endpoint to trigger backlogQuotaCheckbacklogQuotaCheck | GET | An REST endpoint to trigger backlogQuotaCheck |
Check if the broker is fully initializedisReady | GET | Check if the broker is fully initialized |
Delete dynamic ServiceConfiguration into metadata onlydeleteDynamicConfiguration | DELETE | Delete dynamic ServiceConfiguration into metadata only. |
Get all runtime configurationsgetRuntimeConfiguration | GET | Get all runtime configurations. |
Get all updatable dynamic configurations's namegetDynamicConfigurationName | GET | Get all updatable dynamic configurations's name |
Get the information of the leader brokergetLeaderBroker | GET | Get the information of the leader broker. |
Get the internal configuration datagetInternalConfigurationData | GET | Get the internal configuration data |
Get the list of active brokers (broker ids) in the cluster.If authorization is notgetActiveBrokersByCluster | GET | Get the list of active brokers (broker ids) in the cluster.If authorization is not enabled, any cluster name is valid. |
Get the list of active brokers (broker ids) in the local cluster.If authorization is notgetActiveBrokers | GET | Get the list of active brokers (broker ids) in the local cluster.If authorization is not enabled |
Get the list of namespaces served by the specific broker idgetOwnedNamespaces | GET | Get the list of namespaces served by the specific broker id |
Get value of all dynamic configurations' value overridden on local configgetAllDynamicConfigurations | GET | Get value of all dynamic configurations' value overridden on local config |
Get version of current brokerversion | GET | Get version of current broker |
Run a healthCheck against the brokerhealthCheck | GET | Run a healthCheck against the broker |
Shutdown broker gracefullyshutDownBrokerGracefully | POST | Shutdown broker gracefully. |
Update dynamic serviceconfiguration into zk onlyupdateDynamicConfiguration | POST | Update dynamic serviceconfiguration into zk only. |
Clusters19
Create a new clustercreateCluster | PUT | Create a new cluster. |
Delete an existing clusterdeleteCluster | DELETE | Delete an existing cluster. |
Delete namespace isolation policydeleteNamespaceIsolationPolicy | DELETE | Delete namespace isolation policy. |
Delete the failure domain of the clusterdeleteFailureDomain | DELETE | Delete the failure domain of the cluster This operation requires Pulsar superuser privileges. |
Get a broker with namespace-isolation policies attached to itgetBrokerWithNamespaceIsolationPolicy | GET | Get a broker with namespace-isolation policies attached to it. |
Get a domain in a clustergetDomain | GET | Get a domain in a cluster This operation requires Pulsar superuser privileges. |
Get list of brokers with namespace-isolation policies attached to themgetBrokersWithNamespaceIsolationPolicy | GET | Get list of brokers with namespace-isolation policies attached to them. |
Get the cluster failure domainsgetFailureDomains | GET | Get the cluster failure domains. |
Get the cluster migration configuration for the specified clustergetClusterMigration | GET | Get the cluster migration configuration for the specified cluster. |
Get the configuration for the specified clusterclustersGetCluster | GET | Get the configuration for the specified cluster. |
Get the list of all the Pulsar clustersgetClusters | GET | Get the list of all the Pulsar clusters. |
Get the namespace isolation policies assigned to the clustergetNamespaceIsolationPolicies | GET | Get the namespace isolation policies assigned to the cluster. |
Get the peer-cluster data for the specified clustergetPeerCluster | GET | Get the peer-cluster data for the specified cluster. |
Get the single namespace isolation policy assigned to the clustergetNamespaceIsolationPolicy | GET | Get the single namespace isolation policy assigned to the cluster. |
Set namespace isolation policysetNamespaceIsolationPolicy | POST | Set namespace isolation policy. |
Set the failure domain of the clustersetFailureDomain | POST | Set the failure domain of the cluster. |
Update peer-cluster-list for a clustersetPeerClusterNames | POST | Update peer-cluster-list for a cluster. |
Update the configuration for a clusterupdateCluster | POST | Update the configuration for a cluster. |
Update the configuration for a cluster migrationupdateClusterMigration | POST | Update the configuration for a cluster migration. |
Functions21
Creates a new Pulsar Function in cluster moderegisterFunction | POST | Creates a new Pulsar Function in cluster mode Files stream from their file references. |
Deletes a Pulsar Function currently running in cluster modederegisterFunction | DELETE | Deletes a Pulsar Function currently running in cluster mode |
Displays the stats of a Pulsar FunctiongetFunctionStats | GET | Displays the stats of a Pulsar Function |
Displays the stats of a Pulsar Function instancegetFunctionInstanceStats | GET | Displays the stats of a Pulsar Function instance |
Displays the status of a Pulsar FunctiongetFunctionStatus | GET | Displays the status of a Pulsar Function |
Displays the status of a Pulsar Function instancegetFunctionInstanceStatus | GET | Displays the status of a Pulsar Function instance |
Fetch the current state associated with a Pulsar FunctiongetFunctionState | GET | Fetch the current state associated with a Pulsar Function |
Fetches a list of supported Pulsar IO connectors currently running in cluster mode (Functions get connectors list)functionsGetConnectorsList | GET | Fetches a list of supported Pulsar IO connectors currently running in cluster mode |
Fetches information about a Pulsar Function currently running in cluster modegetFunctionInfo | GET | Fetches information about a Pulsar Function currently running in cluster mode |
Fetches the list of built-in Pulsar functionsgetBuiltinFunction | GET | Fetches the list of built-in Pulsar functions |
Lists all Pulsar Functions currently deployed in a given namespacelistFunctions | GET | Lists all Pulsar Functions currently deployed in a given namespace |
Put the state associated with a Pulsar FunctionputFunctionState | POST | Put the state associated with a Pulsar Function Files stream from their file references. |
Reload the built-in FunctionsreloadBuiltinFunctions | POST | Reload the built-in Functions |
Restart all instances of a Pulsar FunctionrestartFunction | POST | Restart all instances of a Pulsar Function |
Restart an instance of a Pulsar FunctionrestartFunctionByInstanceId | POST | Restart an instance of a Pulsar Function |
Start all instances of a Pulsar FunctionstartFunction | POST | Start all instances of a Pulsar Function |
Start an instance of a Pulsar FunctionstartFunctionByInstanceId | POST | Start an instance of a Pulsar Function |
Stop all instances of a Pulsar FunctionstopFunction | POST | Stop all instances of a Pulsar Function |
Stop an instance of a Pulsar FunctionstopFunctionByInstanceId | POST | Stop an instance of a Pulsar Function |
Triggers a Pulsar Function with a user-specified value or file datatriggerFunction | POST | Triggers a Pulsar Function with a user-specified value or file data Files stream from their file references. |
Updates a Pulsar Function currently running in cluster modeupdateFunction | PUT | Updates a Pulsar Function currently running in cluster mode Files stream from their file references. |
Functions worker10
Checks if this node is the leader and is ready to service requestsisLeaderReady | GET | Checks if this node is the leader and is ready to service requests |
Drains the specified worker, i.e., moves its work-assignments to other workersdrainAtLeader | PUT | Drains the specified worker, i.e., moves its work-assignments to other workers |
Drains this worker, i.e., moves its work-assignments to other workersdrain | PUT | Drains this worker, i.e., moves its work-assignments to other workers |
Fetches a list of supported Pulsar IO connectors currently running in cluster mode (Worker get connectors list)workerGetConnectorsList | GET | Fetches a list of supported Pulsar IO connectors currently running in cluster mode |
Fetches info about the leader node of the Pulsar cluster running Pulsar FunctionsgetClusterLeader | GET | Fetches info about the leader node of the Pulsar cluster running Pulsar Functions |
Fetches information about the Pulsar cluster running Pulsar FunctionsworkerGetCluster | GET | Fetches information about the Pulsar cluster running Pulsar Functions |
Fetches information about which Pulsar Functions are assigned to which Pulsar clustersgetAssignments | GET | Fetches information about which Pulsar Functions are assigned to which Pulsar clusters Returns a nested map structure which Swagger does not fully support for display.Structure: Map . |
Get the status of any ongoing drain operation at the specified workergetDrainStatusFromLeader | GET | Get the status of any ongoing drain operation at the specified worker |
Get the status of any ongoing drain operation at this workergetDrainStatus | GET | Get the status of any ongoing drain operation at this worker |
Triggers a rebalance of functions to workersrebalance | PUT | Triggers a rebalance of functions to workers |
Functions worker stats2
Get metrics for all functions owned by workergetStats | GET | Get metrics for all functions owned by worker Requested should be executed by Monitoring agent on each worker to fetch the metrics |
Gets the metrics for Monitoring (Worker stats get metrics)workerStatsGetMetrics | GET | Gets the metrics for Monitoring Request should be executed by Monitoring agent on each worker to fetch the worker-metrics |
Namespaces146
Clear backlog for a given subscription on all topics on a namespaceclearNamespaceBacklogForSubscription | POST | Clear backlog for a given subscription on all topics on a namespace. |
Clear backlog for a given subscription on all topics on a namespace bundleclearNamespaceBundleBacklogForSubscription | POST | Clear backlog for a given subscription on all topics on a namespace bundle. |
Clear backlog for all topics on a namespaceclearNamespaceBacklog | POST | Clear backlog for all topics on a namespace. |
Clear backlog for all topics on a namespace bundleclearNamespaceBundleBacklog | POST | Clear backlog for all topics on a namespace bundle. |
Clear properties on a given namespaceclearProperties | DELETE | Clear properties on a given namespace. |
Clear the namespace configured offload deletion lagclearOffloadDeletionLag | DELETE | Clear the namespace configured offload deletion lag. |
Creates a new namespace with the specified policiescreateNamespace | PUT | Creates a new namespace with the specified policies |
Delete a namespace and all the topics under itdeleteNamespace | DELETE | Delete a namespace and all the topics under it. |
Delete a namespace bundle and all the topics under itdeleteNamespaceBundle | DELETE | Delete a namespace bundle and all the topics under it. |
Delete delayed delivery messages config on a namespaceremoveDelayedDeliveryPolicies | DELETE | Delete delayed delivery messages config on a namespace. |
Delete dispatch-rate throttling for all topics of the namespacedeleteDispatchRate | DELETE | Delete dispatch-rate throttling for all topics of the namespace |
Delete maximum number of uncompacted bytes in a topic before compaction is triggereddeleteCompactionThreshold | DELETE | Delete maximum number of uncompacted bytes in a topic before compaction is triggered. |
Delete resourcegroup for a namespaceremoveNamespaceResourceGroup | DELETE | Delete resourcegroup for a namespace |
Delete subscribe-rate throttling for all topics of the namespacedeleteSubscribeRate | DELETE | Delete subscribe-rate throttling for all topics of the namespace |
Delete Subscription dispatch-rate throttling for all topics of the namespacedeleteSubscriptionDispatchRate | DELETE | Delete Subscription dispatch-rate throttling for all topics of the namespace |
Delete the bookie-affinity-group from namespace-local policydeleteBookieAffinityGroup | DELETE | Delete the bookie-affinity-group from namespace-local policy. |
Delete the persistence configuration for all topics on a namespacedeletePersistence | DELETE | Delete the persistence configuration for all topics on a namespace |
Enable or disable broker side deduplication for all topics in a namespacemodifyDeduplication | POST | Enable or disable broker side deduplication for all topics in a namespace |
Get all namespaces that are grouped by given anti-affinity group in a given clustergetAntiAffinityNamespaces | GET | Get all namespaces that are grouped by given anti-affinity group in a given cluster. |
Get allowed topic property keys for metrics for a namespacegetAllowedTopicPropertyKeysForMetrics | GET | Get allowed topic property keys for metrics for a namespace. |
Get anti-affinity group of a namespacegetNamespaceAntiAffinityGroup | GET | Get anti-affinity group of a namespace. |
Get autoSubscriptionCreation info in a namespacegetAutoSubscriptionCreation | GET | Get autoSubscriptionCreation info in a namespace |
Get autoTopicCreation info in a namespacegetAutoTopicCreation | GET | Get autoTopicCreation info in a namespace |
Get backlog quota map on a namespacegetBacklogQuotaMap | GET | Get backlog quota map on a namespace. |
Get broker side deduplication for all topics in a namespacegetDeduplication | GET | Get broker side deduplication for all topics in a namespace |
Get deduplicationSnapshotInterval config on a namespacegetDeduplicationSnapshotInterval | GET | Get deduplicationSnapshotInterval config on a namespace. |
Get delayed delivery messages config on a namespacegetDelayedDeliveryPolicies | GET | Get delayed delivery messages config on a namespace. |
Get dispatch-rate configured for the namespace, null means dispatch-rate not configuredgetDispatchRate | GET | Get dispatch-rate configured for the namespace, null means dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet |
Get dispatcher pause on ack state persistent config on a namespacegetDispatcherPauseOnAckStatePersistent | GET | Get dispatcher pause on ack state persistent config on a namespace. |
Get hash positions for topicsgetTopicHashPositions | GET | Get hash positions for topics |
Get inactive topic policies config on a namespacegetInactiveTopicPolicies | GET | Get inactive topic policies config on a namespace. |
Get key value pair properties for a given namespacegetProperties | GET | Get key value pair properties for a given namespace. |
Get maxConsumersPerSubscription config on a namespace (Get entry filters per topic)getEntryFiltersPerTopic | GET | Get maxConsumersPerSubscription config on a namespace. |
Get maxConsumersPerSubscription config on a namespace (Get max consumers per subscription)getMaxConsumersPerSubscription | GET | Get maxConsumersPerSubscription config on a namespace. |
Get maxConsumersPerTopic config on a namespacegetMaxConsumersPerTopic | GET | Get maxConsumersPerTopic config on a namespace. |
Get maxProducersPerTopic config on a namespacegetMaxProducersPerTopic | GET | Get maxProducersPerTopic config on a namespace. |
Get maxSubscriptionsPerTopic config on a namespacegetMaxSubscriptionsPerTopic | GET | Get maxSubscriptionsPerTopic config on a namespace. |
Get maxTopicsPerNamespace config on a namespacegetMaxTopicsPerNamespace | GET | Get maxTopicsPerNamespace config on a namespace. |
Get maxUnackedMessagesPerConsumer config on a namespacegetMaxUnackedMessagesPerConsumer | GET | Get maxUnackedMessagesPerConsumer config on a namespace. |
Get maxUnackedMessagesPerSubscription config on a namespacegetMaxUnackedmessagesPerSubscription | GET | Get maxUnackedMessagesPerSubscription config on a namespace. |
Get message encryption required status in a namespacegetEncryptionRequired | GET | Get message encryption required status in a namespace |
Get offload configuration on a namespacegetOffloadPolicies | GET | Get offload configuration on a namespace. |
Get property value for a given key on a namespacegetProperty | GET | Get property value for a given key on a namespace. |
Get replicator dispatch-rate configured for the namespace, null means replicatorgetReplicatorDispatchRate | GET | Get replicator dispatch-rate configured for the namespace, null means replicator dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in... |
Get retention config on a namespacegetRetention | GET | Get retention config on a namespace. |
Get schema validation enforced flag for namespacegetSchemaValidtionEnforced | GET | Get schema validation enforced flag for namespace. |
Get subscribe-rate configured for the namespacegetSubscribeRate | GET | Get subscribe-rate configured for the namespace |
Get subscription auth mode in a namespacegetSubscriptionAuthMode | GET | Get subscription auth mode in a namespace |
Get subscription dispatch-rate configured for the namespace, null means subscriptiongetSubscriptionDispatchRate | GET | Get subscription dispatch-rate configured for the namespace, null means subscription dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in... |
Get the allowed clusters for a namespacegetNamespaceAllowedClusters | GET | Get the allowed clusters for a namespace. |
Get the bookie-affinity-group from namespace-local policygetBookieAffinityGroup | GET | Get the bookie-affinity-group from namespace-local policy. |
Get the bundles split datagetBundlesData | GET | Get the bundles split data. |
Get the dump all the policies specified for a namespacegetPolicies | GET | Get the dump all the policies specified for a namespace. |
Get the list of all the namespaces for a certain tenantgetTenantNamespaces | GET | Get the list of all the namespaces for a certain tenant. |
Get the list of all the topics under a certain namespacegetTopics | GET | Get the list of all the topics under a certain namespace. |
Get the message TTL for the namespacegetNamespaceMessageTTL | GET | Get the message TTL for the namespace |
Get the persistence configuration for a namespacegetPersistence | GET | Get the persistence configuration for a namespace. |
Get the replication clusters for a namespacegetNamespaceReplicationClusters | GET | Get the replication clusters for a namespace. |
Get the resource group attached to the namespacegetNamespaceResourceGroup | GET | Get the resource group attached to the namespace |
Get the subscription expiration time for the namespacegetSubscriptionExpirationTime | GET | Get the subscription expiration time for the namespace |
Grant a new permission to a role on a namespacegrantPermissionOnNamespace | POST | Grant a new permission to a role on a namespace. |
Grant new permissions to a role on multi-topicsgrantPermissionsOnTopics | POST | Grant new permissions to a role on multi-topics. |
Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will (Get offload threshold in seconds)getOffloadThresholdInSeconds | GET | Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage A negative value disables automatic offloading |
Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will (Get offload threshold)getOffloadThreshold | GET | Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage A negative value disables automatic offloading |
Maximum number of uncompacted bytes in topics before compaction is triggeredgetCompactionThreshold | GET | Maximum number of uncompacted bytes in topics before compaction is triggered. |
Message encryption is required or not for all topics in a namespacemodifyEncryptionRequired | POST | Message encryption is required or not for all topics in a namespace |
Number of milliseconds to wait before deleting a ledger segment which has been offloadedgetOffloadDeletionLag | GET | Number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper) A negative value denotes that deletion... |
Override broker's allowAutoSubscriptionCreation setting for a namespacesetAutoSubscriptionCreation | POST | Override broker's allowAutoSubscriptionCreation setting for a namespace |
Override broker's allowAutoTopicCreation setting for a namespacesetAutoTopicCreation | POST | Override broker's allowAutoTopicCreation setting for a namespace |
Put a key value pair property on a namespacesetProperty | PUT | Put a key value pair property on a namespace. |
Put key value pairs property on a namespacesetProperties | PUT | Put key value pairs property on a namespace. |
Remove a backlog quota policy from a namespaceremoveBacklogQuota | DELETE | Remove a backlog quota policy from a namespace. |
Remove allowed topic property keys for metrics on a namespaceremoveAllowedTopicPropertyKeysForMetrics | DELETE | Remove allowed topic property keys for metrics on a namespace. |
Remove anti-affinity group of a namespaceremoveNamespaceAntiAffinityGroup | DELETE | Remove anti-affinity group of a namespace. |
Remove broker side deduplication for all topics in a namespaceremoveDeduplication | DELETE | Remove broker side deduplication for all topics in a namespace |
Remove dispatcher pause on ack state persistent configuration for specified namespaceremoveDispatcherPauseOnAckStatePersistent | DELETE | Remove dispatcher pause on ack state persistent configuration for specified namespace. |
Remove entry filters for namespaceremoveNamespaceEntryFilters | DELETE | Remove entry filters for namespace |
Remove inactive topic policies from a namespaceremoveInactiveTopicPolicies | DELETE | Remove inactive topic policies from a namespace. |
Remove maxConsumersPerTopic configuration on a namespaceremoveMaxConsumersPerTopic | DELETE | Remove maxConsumersPerTopic configuration on a namespace. |
Remove maxProducersPerTopic configuration on a namespaceremoveMaxProducersPerTopic | DELETE | Remove maxProducersPerTopic configuration on a namespace. |
Remove maxSubscriptionsPerTopic configuration on a namespaceremoveMaxSubscriptionsPerTopic | DELETE | Remove maxSubscriptionsPerTopic configuration on a namespace. |
Remove maxTopicsPerNamespace config on a namespaceremoveMaxTopicsPerNamespace | DELETE | Remove maxTopicsPerNamespace config on a namespace. |
Remove maxUnackedMessagesPerConsumer config on a namespaceremoveMaxUnackedmessagesPerConsumer | DELETE | Remove maxUnackedMessagesPerConsumer config on a namespace. |
Remove maxUnackedMessagesPerSubscription config on a namespaceremoveMaxUnackedmessagesPerSubscription | DELETE | Remove maxUnackedMessagesPerSubscription config on a namespace. |
Remove message TTL in seconds for namespaceremoveNamespaceMessageTTL | DELETE | Remove message TTL in seconds for namespace |
Remove override of broker's allowAutoSubscriptionCreation in a namespaceremoveAutoSubscriptionCreation | DELETE | Remove override of broker's allowAutoSubscriptionCreation in a namespace |
Remove override of broker's allowAutoTopicCreation in a namespaceremoveAutoTopicCreation | DELETE | Remove override of broker's allowAutoTopicCreation in a namespace |
Remove property value for a given key on a namespaceremoveProperty | DELETE | Remove property value for a given key on a namespace. |
Remove replicator dispatch-rate throttling for all topics of the namespaceremoveReplicatorDispatchRate | DELETE | Remove replicator dispatch-rate throttling for all topics of the namespace |
Remove retention configuration on a namespaceremoveRetention | DELETE | Remove retention configuration on a namespace. |
Remove subscription expiration time for namespaceremoveSubscriptionExpirationTime | DELETE | Remove subscription expiration time for namespace |
Remove subscription types enabled on a namespaceremoveSubscriptionTypesEnabled | DELETE | Remove subscription types enabled on a namespace. |
Retrieve the permissions for a namespacegetPermissions | GET | Retrieve the permissions for a namespace. |
Retrieve the permissions for a subscriptiongetPermissionOnSubscription | GET | Retrieve the permissions for a subscription. |
Revoke all permissions to a role on a namespacerevokePermissionsOnNamespace | DELETE | Revoke all permissions to a role on a namespace. |
Revoke new permissions to a role on multi-topicsrevokePermissionsOnTopics | POST | Revoke new permissions to a role on multi-topics. |
Set a backlog quota for all the topics on a namespacesetBacklogQuota | POST | Set a backlog quota for all the topics on a namespace. |
Set a subscription auth mode for all the topics on a namespacesetSubscriptionAuthMode | POST | Set a subscription auth mode for all the topics on a namespace. |
Set allowed topic property keys for metrics for a namespacesetAllowedTopicPropertyKeysForMetrics | POST | Set allowed topic property keys for metrics for a namespace |
Set anti-affinity group for a namespacesetNamespaceAntiAffinityGroup | POST | Set anti-affinity group for a namespace |
Set deduplicationSnapshotInterval config on a namespacesetDeduplicationSnapshotInterval | POST | Set deduplicationSnapshotInterval config on a namespace. |
Set delayed delivery messages config on a namespacesetDelayedDeliveryPolicies | POST | Set delayed delivery messages config on a namespace. |
Set dispatch-rate throttling for all topics of the namespacesetDispatchRate | POST | Set dispatch-rate throttling for all topics of the namespace |
Set dispatcher pause on ack state persistent configuration for specified namespacesetDispatcherPauseOnAckStatePersistent | POST | Set dispatcher pause on ack state persistent configuration for specified namespace. |
Set entry filters for namespacesetEntryFiltersPerTopic | POST | Set entry filters for namespace |
Set inactive topic policies config on a namespacesetInactiveTopicPolicies | POST | Set inactive topic policies config on a namespace. |
Set maxConsumersPerSubscription configuration on a namespace (Remove max consumers per subscription)removeMaxConsumersPerSubscription | DELETE | Set maxConsumersPerSubscription configuration on a namespace. |
Set maxConsumersPerSubscription configuration on a namespace (Set max consumers per subscription)setMaxConsumersPerSubscription | POST | Set maxConsumersPerSubscription configuration on a namespace. |
Set maxConsumersPerTopic configuration on a namespace (Set max consumers per topic)setMaxConsumersPerTopic | POST | Set maxConsumersPerTopic configuration on a namespace. |
Set maxConsumersPerTopic configuration on a namespace (Set max unacked messages per consumer)setMaxUnackedMessagesPerConsumer | POST | Set maxConsumersPerTopic configuration on a namespace. |
Set maximum number of bytes stored on the pulsar cluster for a topic, before the brokersetOffloadThreshold | PUT | Set maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage -1 will revert to using the cluster default. |
Set maximum number of seconds stored on the pulsar cluster for a topic, before the brokersetOffloadThresholdInSeconds | PUT | Set maximum number of seconds stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage A negative value disables automatic offloading |
Set maximum number of uncompacted bytes in a topic before compaction is triggeredsetCompactionThreshold | PUT | Set maximum number of uncompacted bytes in a topic before compaction is triggered. |
Set maxProducersPerTopic configuration on a namespacesetMaxProducersPerTopic | POST | Set maxProducersPerTopic configuration on a namespace. |
Set maxSubscriptionsPerTopic configuration on a namespacesetMaxSubscriptionsPerTopic | POST | Set maxSubscriptionsPerTopic configuration on a namespace. |
Set maxTopicsPerNamespace config on a namespacesetMaxTopicsPerNamespace | POST | Set maxTopicsPerNamespace config on a namespace. |
Set maxUnackedMessagesPerSubscription configuration on a namespacesetMaxUnackedMessagesPerSubscription | POST | Set maxUnackedMessagesPerSubscription configuration on a namespace. |
Set message TTL in seconds for namespacesetNamespaceMessageTTL | POST | Set message TTL in seconds for namespace |
Set number of milliseconds to wait before deleting a ledger segment which has beensetOffloadDeletionLag | PUT | Set number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper) A negative value disables the... |
Set offload configuration on a namespace (Remove offload policies)removeOffloadPolicies | DELETE | Set offload configuration on a namespace. |
Set offload configuration on a namespace (Set offload policies)setOffloadPolicies | POST | Set offload configuration on a namespace. |
Set replicator dispatch-rate throttling for all topics of the namespacesetReplicatorDispatchRate | POST | Set replicator dispatch-rate throttling for all topics of the namespace |
Set resourcegroup for a namespacesetNamespaceResourceGroup | POST | Set resourcegroup for a namespace |
Set retention configuration on a namespacesetRetention | POST | Set retention configuration on a namespace. |
Set schema validation enforced flag on namespacesetSchemaValidationEnforced | POST | Set schema validation enforced flag on namespace. |
Set subscribe-rate throttling for all topics of the namespacesetSubscribeRate | POST | Set subscribe-rate throttling for all topics of the namespace |
Set Subscription dispatch-rate throttling for all topics of the namespacesetSubscriptionDispatchRate | POST | Set Subscription dispatch-rate throttling for all topics of the namespace |
Set subscription expiration time in minutes for namespacesetSubscriptionExpirationTime | POST | Set subscription expiration time in minutes for namespace |
Set the allowed clusters for a namespacesetNamespaceAllowedClusters | POST | Set the allowed clusters for a namespace. |
Set the bookie-affinity-group to namespace-persistent policysetBookieAffinityGroup | POST | Set the bookie-affinity-group to namespace-persistent policy. |
Set the persistence configuration for all the topics on a namespacesetPersistence | POST | Set the persistence configuration for all the topics on a namespace. |
Set the replication clusters for a namespacesetNamespaceReplicationClusters | POST | Set the replication clusters for a namespace. |
Split a namespace bundlesplitNamespaceBundle | PUT | Split a namespace bundle |
The flag of whether allow auto update schemagetIsAllowAutoUpdateSchema | GET | The flag of whether allow auto update schema |
The set of whether allow subscription typesgetSubscriptionTypesEnabled | GET | The set of whether allow subscription types |
The strategy of the namespace schema compatibilitygetSchemaCompatibilityStrategy | GET | The strategy of the namespace schema compatibility |
The strategy used to check the compatibility of new schemas, provided by producers, beforegetSchemaAutoUpdateCompatibilityStrategy | GET | The strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema The value AutoUpdateDisabled prevents producers from updating... |
Trigger the scan of offloaded Ledgers on the LedgerOffloader for the given namespacescanOffloadedLedgers | GET | Trigger the scan of offloaded Ledgers on the LedgerOffloader for the given namespace |
Unload a namespace bundleunloadNamespaceBundle | PUT | Unload a namespace bundle |
Unload namespaceunloadNamespace | PUT | Unload namespace Unload an active namespace from the current broker serving it. |
Unsubscribes the given subscription on all topics on a namespaceunsubscribeNamespace | POST | Unsubscribes the given subscription on all topics on a namespace. |
Unsubscribes the given subscription on all topics on a namespace bundleunsubscribeNamespaceBundle | POST | Unsubscribes the given subscription on all topics on a namespace bundle. |
Update flag of whether allow auto update schemasetIsAllowAutoUpdateSchema | POST | Update flag of whether allow auto update schema |
Update set of whether allow share sub typesetSubscriptionTypesEnabled | POST | Update set of whether allow share sub type |
Update the strategy used to check the compatibility of new schemasetSchemaCompatibilityStrategy | PUT | Update the strategy used to check the compatibility of new schema |
Update the strategy used to check the compatibility of new schemas, provided by producerssetSchemaAutoUpdateCompatibilityStrategy | PUT | Update the strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema The value AutoUpdateDisabled prevents producers from... |
Non-persistent topics148
Analyse a subscription, by scanning all the unprocessed messages (non-persistent topic)nonPersistentAnalyzeSubscriptionBacklog | POST | Analyse a subscription, by scanning all the unprocessed messages |
Calculate backlog size by a message ID (in bytes) (non-persistent topic)nonPersistentGetBacklogSizeByMessageId | PUT | Calculate backlog size by a message ID (in bytes). |
Create a non-partitioned topic (non-persistent topic)nonPersistentCreateNonPartitionedTopic | PUT | Create a non-partitioned topic. |
Create a partitioned topic (non-persistent topic)nonPersistentCreatePartitionedTopic | PUT | Create a partitioned topic. |
Create a subscription on the topic (non-persistent topic)nonPersistentCreateSubscription | PUT | Create a subscription on the topic. |
Create missed partitions of an existing partitioned topic (non-persistent topic)nonPersistentCreateMissedPartitions | POST | Create missed partitions of an existing partitioned topic. |
Delete a partitioned topic (non-persistent topic)nonPersistentDeletePartitionedTopic | DELETE | Delete a partitioned topic. |
Delete a subscription (non-persistent topic)nonPersistentDeleteSubscription | DELETE | Delete a subscription. |
Delete a topic (non-persistent topic)nonPersistentDeleteTopic | DELETE | Delete a topic. |
Delete deduplicationSnapshotInterval config on a topic (non-persistent topic)nonPersistentDeleteDeduplicationSnapshotInterval | DELETE | Delete deduplicationSnapshotInterval config on a topic. |
Delete inactive topic policies on a topic (non-persistent topic)nonPersistentDeleteInactiveTopicPolicies | DELETE | Delete inactive topic policies on a topic. |
Delete max unacked messages per consumer config on a topic (non-persistent topic)nonPersistentDeleteMaxUnackedMessagesOnConsumer | DELETE | Delete max unacked messages per consumer config on a topic. |
Delete max unacked messages per subscription config on a topic (non-persistent topic)nonPersistentDeleteMaxUnackedMessagesOnSubscription | DELETE | Delete max unacked messages per subscription config on a topic. |
Delete offload policies on a topic (non-persistent topic)nonPersistentRemoveOffloadPolicies | DELETE | Delete offload policies on a topic. |
Delete policies for a topic (non-persistent topic)nonPersistentDeleteTopicPolicies | DELETE | Delete policies for a topic. |
Delete shadow topics for a topic (non-persistent topic)nonPersistentDeleteShadowTopics | DELETE | Delete shadow topics for a topic |
Enable or disable a replicated subscription on a topic (non-persistent topic)nonPersistentSetReplicatedSubscriptionStatus | POST | Enable or disable a replicated subscription on a topic. |
Examine a specific message on a topic by position relative to the earliest or the latest (non-persistent topic)nonPersistentExamineMessage | GET | Examine a specific message on a topic by position relative to the earliest or the latest message. |
Expiry messages on a topic subscription (non-persistent topic) (Non persistent expire topic messages by expire time in seconds)nonPersistentExpireTopicMessagesByExpireTimeInSeconds | POST | Expiry messages on a topic subscription. |
Expiry messages on a topic subscription (non-persistent topic) (Non persistent expire topic messages)nonPersistentExpireTopicMessages | POST | Expiry messages on a topic subscription. |
Expiry messages on all subscriptions of topic (non-persistent topic)nonPersistentExpireMessagesForAllSubscriptions | POST | Expiry messages on all subscriptions of topic. |
Get autoSubscriptionCreation info in a topic (non-persistent topic)nonPersistentGetAutoSubscriptionCreation | GET | Get autoSubscriptionCreation info in a topic |
Get backlog quota map on a topic (non-persistent topic)nonPersistentGetBacklogQuotaMap | GET | Get backlog quota map on a topic. |
Get compaction threshold configuration for specified topic (non-persistent topic)nonPersistentGetCompactionThreshold | GET | Get compaction threshold configuration for specified topic. |
Get configuration of persistence policies for specified topic (non-persistent topic)nonPersistentGetPersistence | GET | Get configuration of persistence policies for specified topic. |
Get deduplication configuration of a topic (non-persistent topic)nonPersistentGetDeduplication | GET | Get deduplication configuration of a topic. |
Get deduplicationSnapshotInterval config on a topic (non-persistent topic)nonPersistentGetDeduplicationSnapshotInterval | GET | Get deduplicationSnapshotInterval config on a topic. |
Get delayed delivery messages config on a topic (non-persistent topic)nonPersistentGetDelayedDeliveryPolicies | GET | Get delayed delivery messages config on a topic. |
Get dispatch rate configuration for specified topic (non-persistent topic)nonPersistentGetDispatchRate | GET | Get dispatch rate configuration for specified topic. |
Get dispatcher pause on ack state persistent config on a topic (non-persistent topic)nonPersistentGetDispatcherPauseOnAckStatePersistent | GET | Get dispatcher pause on ack state persistent config on a topic. |
Get entry filters for a topic (non-persistent topic)nonPersistentGetEntryFilters | GET | Get entry filters for a topic. |
Get estimated backlog for offline topic (non-persistent topic)nonPersistentGetBacklog | GET | Get estimated backlog for offline topic. |
Get inactive topic policies on a topic (non-persistent topic)nonPersistentGetInactiveTopicPolicies | GET | Get inactive topic policies on a topic. |
Get is enable sub type fors specified topic (non-persistent topic)nonPersistentGetSubscriptionTypesEnabled | GET | Get is enable sub type fors specified topic. |
Get max consumers per subscription configuration for specified topic (non-persistent topic)nonPersistentGetMaxConsumersPerSubscription | GET | Get max consumers per subscription configuration for specified topic. |
Get max unacked messages per consumer config on a topic (non-persistent topic)nonPersistentGetMaxUnackedMessagesOnConsumer | GET | Get max unacked messages per consumer config on a topic. |
Get max unacked messages per subscription config on a topic (non-persistent topic)nonPersistentGetMaxUnackedMessagesOnSubscription | GET | Get max unacked messages per subscription config on a topic. |
Get maxConsumers config for specified topic (non-persistent topic)nonPersistentGetMaxConsumers | GET | Get maxConsumers config for specified topic. |
Get maxMessageSize config for specified topic (non-persistent topic)nonPersistentGetMaxMessageSize | GET | Get maxMessageSize config for specified topic. |
Get maxProducers config for specified topic (non-persistent topic)nonPersistentGetMaxProducers | GET | Get maxProducers config for specified topic. |
Get maxSubscriptionsPerTopic config for specified topic (non-persistent topic)nonPersistentGetMaxSubscriptionsPerTopic | GET | Get maxSubscriptionsPerTopic config for specified topic. |
Get message by its messageId (non-persistent topic)nonPersistentGetMessageById | GET | Get message by its messageId. |
Get message dispatch rate configuration for specified subscription (non-persistent topic)nonPersistentGetSubscriptionLevelDispatchRate | GET | Get message dispatch rate configuration for specified subscription. |
Get message ID published at or just after this absolute timestamp (in ms) (non-persistent topic)nonPersistentGetMessageIdByTimestamp | GET | Get message ID published at or just after this absolute timestamp (in ms). |
Get message TTL in seconds for a topic (non-persistent topic)nonPersistentGetMessageTTL | GET | Get message TTL in seconds for a topic |
Get offload policies on a topic (non-persistent topic)nonPersistentGetOffloadPolicies | GET | Get offload policies on a topic. |
Get partitioned topic metadata (non-persistent topic)nonPersistentGetPartitionedMetadata | GET | Get partitioned topic metadata. |
Get permissions on a topic (non-persistent topic)nonPersistentGetPermissionsOnTopic | GET | Get permissions on a topic. |
Get publish rate configuration for specified topic (non-persistent topic)nonPersistentGetPublishRate | GET | Get publish rate configuration for specified topic. |
Get replicated subscription status on a topic (non-persistent topic)nonPersistentGetReplicatedSubscriptionStatus | GET | Get replicated subscription status on a topic. |
Get replicatorDispatchRate config for specified topic (non-persistent topic)nonPersistentGetReplicatorDispatchRate | GET | Get replicatorDispatchRate config for specified topic. |
Get retention configuration for specified topic (non-persistent topic)nonPersistentGetRetention | GET | Get retention configuration for specified topic. |
Get schema compatibility strategy on a topic (non-persistent topic)nonPersistentGetSchemaCompatibilityStrategy | GET | Get schema compatibility strategy on a topic |
Get schema validation enforced flag for topic (non-persistent topic)nonPersistentGetSchemaValidationEnforced | GET | Get schema validation enforced flag for topic. |
Get subscribe rate configuration for specified topic (non-persistent topic)nonPersistentGetSubscribeRate | GET | Get subscribe rate configuration for specified topic. |
Get subscription expiration time in minutes for a topic (non-persistent topic)nonPersistentGetSubscriptionExpirationTime | GET | Get subscription expiration time in minutes for a topic |
Get subscription message dispatch rate configuration for specified topic (non-persistent topic)nonPersistentGetSubscriptionDispatchRate | GET | Get subscription message dispatch rate configuration for specified topic. |
Get the internal stats for the topic (non-persistent topic)nonPersistentGetInternalStats | GET | Get the internal stats for the topic. |
Get the list of non-persistent topics under a namespacenonPersistentGetList | GET | Get the list of non-persistent topics under a namespace. |
Get the list of non-persistent topics under a namespace bundlenonPersistentGetListFromBundle | GET | Get the list of non-persistent topics under a namespace bundle. |
Get the list of partitioned topics under a namespace (non-persistent topic)nonPersistentGetPartitionedTopicList | GET | Get the list of partitioned topics under a namespace. |
Get the list of persistent subscriptions for a given topic (non-persistent topic)nonPersistentGetSubscriptions | GET | Get the list of persistent subscriptions for a given topic. |
Get the replication clusters for a topic (non-persistent topic)nonPersistentGetReplicationClusters | GET | Get the replication clusters for a topic |
Get the shadow topic list for a topic (non-persistent topic)nonPersistentGetShadowTopics | GET | Get the shadow topic list for a topic |
Get the stats for the partitioned topic (non-persistent topic)nonPersistentGetPartitionedStats | GET | Get the stats for the partitioned topic. |
Get the stats for the topic (non-persistent topic)nonPersistentGetStats | GET | Get the stats for the topic. |
Get the stats-internal for the partitioned topic (non-persistent topic)nonPersistentGetPartitionedStatsInternal | GET | Get the stats-internal for the partitioned topic. |
Get the status of a compaction operation for a topic (non-persistent topic)nonPersistentCompactionStatus | GET | Get the status of a compaction operation for a topic. |
Get the stored topic metadata (non-persistent topic)nonPersistentGetManagedLedgerInfo | GET | Get the stored topic metadata. |
Get topic properties (non-persistent topic)nonPersistentGetProperties | GET | Get topic properties. |
Grant a new permission to a role on a single topic (non-persistent topic)nonPersistentGrantPermissionsOnTopic | POST | Grant a new permission to a role on a single topic. |
Increment partitions of an existing partitioned topic (non-persistent topic)nonPersistentUpdatePartitionedTopic | POST | Increment partitions of an existing partitioned topic. |
Offload a prefix of a topic to long term storage (non-persistent topic) (Non persistent offload status)nonPersistentOffloadStatus | GET | Offload a prefix of a topic to long term storage |
Offload a prefix of a topic to long term storage (non-persistent topic) (Non persistent trigger offload)nonPersistentTriggerOffload | PUT | Offload a prefix of a topic to long term storage |
Override namespace's allowAutoSubscriptionCreation setting for a topic (non-persistent topic)nonPersistentSetAutoSubscriptionCreation | POST | Override namespace's allowAutoSubscriptionCreation setting for a topic |
Peek nth message on a topic subscription (non-persistent topic)nonPersistentPeekNthMessage | GET | Peek nth message on a topic subscription. |
Remove a backlog quota policy from a topic (non-persistent topic)nonPersistentRemoveBacklogQuota | DELETE | Remove a backlog quota policy from a topic. |
Remove autoSubscriptionCreation ina a topic (non-persistent topic)nonPersistentRemoveAutoSubscriptionCreation | DELETE | Remove autoSubscriptionCreation ina a topic. |
Remove compaction threshold configuration for specified topic (non-persistent topic)nonPersistentRemoveCompactionThreshold | DELETE | Remove compaction threshold configuration for specified topic. |
Remove configuration of persistence policies for specified topic (non-persistent topic)nonPersistentRemovePersistence | DELETE | Remove configuration of persistence policies for specified topic. |
Remove deduplication configuration for specified topic (non-persistent topic)nonPersistentRemoveDeduplication | DELETE | Remove deduplication configuration for specified topic. |
Remove dispatcher pause on ack state persistent configuration for specified topic (non-persistent topic)nonPersistentRemoveDispatcherPauseOnAckStatePersistent | DELETE | Remove dispatcher pause on ack state persistent configuration for specified topic. |
Remove entry filters for specified topic (non-persistent topic)nonPersistentRemoveEntryFilters | DELETE | Remove entry filters for specified topic. |
Remove max consumers per subscription configuration for specified topic (non-persistent topic)nonPersistentRemoveMaxConsumersPerSubscription | DELETE | Remove max consumers per subscription configuration for specified topic. |
Remove maxConsumers config for specified topic (non-persistent topic)nonPersistentRemoveMaxConsumers | DELETE | Remove maxConsumers config for specified topic. |
Remove maxMessageSize config for specified topic (non-persistent topic)nonPersistentRemoveMaxMessageSize | DELETE | Remove maxMessageSize config for specified topic. |
Remove maxProducers config for specified topic (non-persistent topic)nonPersistentRemoveMaxProducers | DELETE | Remove maxProducers config for specified topic. |
Remove maxSubscriptionsPerTopic config for specified topic (non-persistent topic)nonPersistentRemoveMaxSubscriptionsPerTopic | DELETE | Remove maxSubscriptionsPerTopic config for specified topic. |
Remove message dispatch rate configuration for specified subscription (non-persistent topic)nonPersistentRemoveSubscriptionLevelDispatchRate | DELETE | Remove message dispatch rate configuration for specified subscription. |
Remove message dispatch rate configuration for specified topic (non-persistent topic)nonPersistentRemoveDispatchRate | DELETE | Remove message dispatch rate configuration for specified topic. |
Remove message publish rate configuration for specified topic (non-persistent topic)nonPersistentRemovePublishRate | DELETE | Remove message publish rate configuration for specified topic. |
Remove message TTL in seconds for a topic (non-persistent topic)nonPersistentRemoveMessageTTL | DELETE | Remove message TTL in seconds for a topic |
Remove replicatorDispatchRate config for specified topic (non-persistent topic)nonPersistentRemoveReplicatorDispatchRate | DELETE | Remove replicatorDispatchRate config for specified topic. |
Remove retention configuration for specified topic (non-persistent topic)nonPersistentRemoveRetention | DELETE | Remove retention configuration for specified topic. |
Remove schema compatibility strategy on a topic (non-persistent topic)nonPersistentRemoveSchemaCompatibilityStrategy | DELETE | Remove schema compatibility strategy on a topic |
Remove subscribe rate configuration for specified topic (non-persistent topic)nonPersistentRemoveSubscribeRate | DELETE | Remove subscribe rate configuration for specified topic. |
Remove subscription expiration time for a topic (non-persistent topic)nonPersistentRemoveSubscriptionExpirationTime | DELETE | Remove subscription expiration time for a topic |
Remove subscription message dispatch rate configuration for specified topic (non-persistent topic)nonPersistentRemoveSubscriptionDispatchRate | DELETE | Remove subscription message dispatch rate configuration for specified topic. |
Remove subscription types enabled for specified topic (non-persistent topic)nonPersistentRemoveSubscriptionTypesEnabled | DELETE | Remove subscription types enabled for specified topic. |
Remove the key in properties on the given topic (non-persistent topic)nonPersistentRemoveProperties | DELETE | Remove the key in properties on the given topic. |
Remove the replication clusters from a topic (non-persistent topic)nonPersistentRemoveReplicationClusters | DELETE | Remove the replication clusters from a topic. |
Replace all the properties on the given subscription (non-persistent topic)nonPersistentUpdateSubscriptionProperties | PUT | Replace all the properties on the given subscription |
Reset subscription to message position closest to absolute timestamp (in ms) (non-persistent topic)nonPersistentResetCursor | POST | Reset subscription to message position closest to absolute timestamp (in ms). |
Reset subscription to message position closest to given position (non-persistent topic)nonPersistentResetCursorOnPosition | POST | Reset subscription to message position closest to given position. |
Return all the properties on the given subscription (non-persistent topic)nonPersistentGetSubscriptionProperties | GET | Return all the properties on the given subscription |
Return the last commit message id of topic (non-persistent topic)nonPersistentGetLastMessageId | GET | Return the last commit message id of topic |
Revoke permissions on a topic (non-persistent topic)nonPersistentRevokePermissionsOnTopic | DELETE | Revoke permissions on a topic. |
Set a backlog quota for a topic (non-persistent topic)nonPersistentSetBacklogQuota | POST | Set a backlog quota for a topic. |
Set compaction threshold configuration for specified topic (non-persistent topic)nonPersistentSetCompactionThreshold | POST | Set compaction threshold configuration for specified topic. |
Set configuration of persistence policies for specified topic (non-persistent topic)nonPersistentSetPersistence | POST | Set configuration of persistence policies for specified topic. |
Set deduplication enabled on a topic (non-persistent topic)nonPersistentSetDeduplication | POST | Set deduplication enabled on a topic. |
Set deduplicationSnapshotInterval config on a topic (non-persistent topic)nonPersistentSetDeduplicationSnapshotInterval | POST | Set deduplicationSnapshotInterval config on a topic. |
Set delayed delivery messages config on a topic (non-persistent topic) (Non persistent delete delayed delivery policies)nonPersistentDeleteDelayedDeliveryPolicies | DELETE | Set delayed delivery messages config on a topic. |
Set delayed delivery messages config on a topic (non-persistent topic) (Non persistent set delayed delivery policies)nonPersistentSetDelayedDeliveryPolicies | POST | Set delayed delivery messages config on a topic. |
Set dispatcher pause on ack state persistent configuration for specified topic (non-persistent topic)nonPersistentSetDispatcherPauseOnAckStatePersistent | POST | Set dispatcher pause on ack state persistent configuration for specified topic. |
Set entry filters for specified topic (non-persistent topic)nonPersistentSetEntryFilters | POST | Set entry filters for specified topic |
Set inactive topic policies on a topic (non-persistent topic)nonPersistentSetInactiveTopicPolicies | POST | Set inactive topic policies on a topic. |
Set is enable sub types for specified topic (non-persistent topic)nonPersistentSetSubscriptionTypesEnabled | POST | Set is enable sub types for specified topic |
Set max consumers per subscription configuration for specified topic (non-persistent topic)nonPersistentSetMaxConsumersPerSubscription | POST | Set max consumers per subscription configuration for specified topic. |
Set max unacked messages per consumer config on a topic (non-persistent topic)nonPersistentSetMaxUnackedMessagesOnConsumer | POST | Set max unacked messages per consumer config on a topic. |
Set max unacked messages per subscription config on a topic (non-persistent topic)nonPersistentSetMaxUnackedMessagesOnSubscription | POST | Set max unacked messages per subscription config on a topic. |
Set maxConsumers config for specified topic (non-persistent topic)nonPersistentSetMaxConsumers | POST | Set maxConsumers config for specified topic. |
Set maxMessageSize config for specified topic (non-persistent topic)nonPersistentSetMaxMessageSize | POST | Set maxMessageSize config for specified topic. |
Set maxProducers config for specified topic (non-persistent topic)nonPersistentSetMaxProducers | POST | Set maxProducers config for specified topic. |
Set maxSubscriptionsPerTopic config for specified topic (non-persistent topic)nonPersistentSetMaxSubscriptionsPerTopic | POST | Set maxSubscriptionsPerTopic config for specified topic. |
Set message dispatch rate configuration for specified subscription (non-persistent topic)nonPersistentSetSubscriptionLevelDispatchRate | POST | Set message dispatch rate configuration for specified subscription. |
Set message dispatch rate configuration for specified topic (non-persistent topic)nonPersistentSetDispatchRate | POST | Set message dispatch rate configuration for specified topic. |
Set message publish rate configuration for specified topic (non-persistent topic)nonPersistentSetPublishRate | POST | Set message publish rate configuration for specified topic. |
Set message TTL in seconds for a topic (non-persistent topic)nonPersistentSetMessageTTL | POST | Set message TTL in seconds for a topic |
Set offload policies on a topic (non-persistent topic)nonPersistentSetOffloadPolicies | POST | Set offload policies on a topic. |
Set replicatorDispatchRate config for specified topic (non-persistent topic)nonPersistentSetReplicatorDispatchRate | POST | Set replicatorDispatchRate config for specified topic. |
Set retention configuration for specified topic (non-persistent topic)nonPersistentSetRetention | POST | Set retention configuration for specified topic. |
Set schema compatibility strategy on a topic (non-persistent topic)nonPersistentSetSchemaCompatibilityStrategy | PUT | Set schema compatibility strategy on a topic |
Set schema validation enforced flag on topic (non-persistent topic)nonPersistentSetSchemaValidationEnforced | POST | Set schema validation enforced flag on topic. |
Set shadow topic list for a topic (non-persistent topic)nonPersistentSetShadowTopics | PUT | Set shadow topic list for a topic |
Set subscribe rate configuration for specified topic (non-persistent topic)nonPersistentSetSubscribeRate | POST | Set subscribe rate configuration for specified topic. |
Set subscription expiration time in minutes for a topic (non-persistent topic)nonPersistentSetSubscriptionExpirationTime | POST | Set subscription expiration time in minutes for a topic |
Set subscription message dispatch rate configuration for specified topic (non-persistent topic)nonPersistentSetSubscriptionDispatchRate | POST | Set subscription message dispatch rate configuration for specified topic. |
Set the replication clusters for a topic (non-persistent topic)nonPersistentSetReplicationClusters | POST | Set the replication clusters for a topic. |
Skip all messages on a topic subscription (non-persistent topic)nonPersistentSkipAllMessages | POST | Skip all messages on a topic subscription. |
Skipping messages on a topic subscription (non-persistent topic)nonPersistentSkipMessages | POST | Skipping messages on a topic subscription. |
Terminate a topic (non-persistent topic)nonPersistentTerminate | POST | Terminate a topic. |
Terminate all partitioned topic (non-persistent topic)nonPersistentTerminatePartitionedTopic | POST | Terminate all partitioned topic. |
Trigger a compaction operation on a topic (non-persistent topic)nonPersistentCompact | PUT | Trigger a compaction operation on a topic. |
Trim a topic (non-persistent topic)nonPersistentTrimTopic | POST | Trim a topic |
Truncate a topic (non-persistent topic)nonPersistentTruncateTopic | DELETE | Truncate a topic. |
Unload a topic (non-persistent topic)nonPersistentUnloadTopic | PUT | Unload a topic |
Update the properties on the given topic (non-persistent topic)nonPersistentUpdateProperties | PUT | Update the properties on the given topic. |
Packages7
Delete a package with the package namedeletePackage | DELETE | Delete a package with the package name. |
Download a package with the package namedownloadPackage | GET | Download a package with the package name. |
Get all the specified type packages in a namespacelistPackages | GET | Get all the specified type packages in a namespace. |
Get all the versions of a packagelistPackageVersion | GET | Get all the versions of a package. |
Get the metadata of a packagegetPackageMetadata | GET | Get the metadata of a package. |
Update the metadata of a packageupdatePackageMetadata | PUT | Update the metadata of a package. |
Upload a packageuploadPackage | POST | Upload a package. |
Persistent topics147
Analyse a subscription, by scanning all the unprocessed messages (persistent topic)persistentAnalyzeSubscriptionBacklog | POST | Analyse a subscription, by scanning all the unprocessed messages |
Calculate backlog size by a message ID (in bytes) (persistent topic)persistentGetBacklogSizeByMessageId | PUT | Calculate backlog size by a message ID (in bytes). |
Create a non-partitioned topic (persistent topic)persistentCreateNonPartitionedTopic | PUT | Create a non-partitioned topic. |
Create a partitioned topic (persistent topic)persistentCreatePartitionedTopic | PUT | Create a partitioned topic. |
Create a subscription on the topic (persistent topic)persistentCreateSubscription | PUT | Create a subscription on the topic. |
Create missed partitions of an existing partitioned topic (persistent topic)persistentCreateMissedPartitions | POST | Create missed partitions of an existing partitioned topic. |
Delete a partitioned topic (persistent topic)persistentDeletePartitionedTopic | DELETE | Delete a partitioned topic. |
Delete a subscription (persistent topic)persistentDeleteSubscription | DELETE | Delete a subscription. |
Delete a topic (persistent topic)persistentDeleteTopic | DELETE | Delete a topic. |
Delete deduplicationSnapshotInterval config on a topic (persistent topic)persistentDeleteDeduplicationSnapshotInterval | DELETE | Delete deduplicationSnapshotInterval config on a topic. |
Delete inactive topic policies on a topic (persistent topic)persistentDeleteInactiveTopicPolicies | DELETE | Delete inactive topic policies on a topic. |
Delete max unacked messages per consumer config on a topic (persistent topic)persistentDeleteMaxUnackedMessagesOnConsumer | DELETE | Delete max unacked messages per consumer config on a topic. |
Delete max unacked messages per subscription config on a topic (persistent topic)persistentDeleteMaxUnackedMessagesOnSubscription | DELETE | Delete max unacked messages per subscription config on a topic. |
Delete offload policies on a topic (persistent topic)persistentRemoveOffloadPolicies | DELETE | Delete offload policies on a topic. |
Delete policies for a topic (persistent topic)persistentDeleteTopicPolicies | DELETE | Delete policies for a topic. |
Delete shadow topics for a topic (persistent topic)persistentDeleteShadowTopics | DELETE | Delete shadow topics for a topic |
Enable or disable a replicated subscription on a topic (persistent topic)persistentSetReplicatedSubscriptionStatus | POST | Enable or disable a replicated subscription on a topic. |
Examine a specific message on a topic by position relative to the earliest or the latest (persistent topic)persistentExamineMessage | GET | Examine a specific message on a topic by position relative to the earliest or the latest message. |
Expiry messages on a topic subscription (persistent topic) (Persistent expire topic messages by expire time in seconds)persistentExpireTopicMessagesByExpireTimeInSeconds | POST | Expiry messages on a topic subscription. |
Expiry messages on a topic subscription (persistent topic) (Persistent expire topic messages)persistentExpireTopicMessages | POST | Expiry messages on a topic subscription. |
Expiry messages on all subscriptions of topic (persistent topic)persistentExpireMessagesForAllSubscriptions | POST | Expiry messages on all subscriptions of topic. |
Get autoSubscriptionCreation info in a topic (persistent topic)persistentGetAutoSubscriptionCreation | GET | Get autoSubscriptionCreation info in a topic |
Get backlog quota map on a topic (persistent topic)persistentGetBacklogQuotaMap | GET | Get backlog quota map on a topic. |
Get compaction threshold configuration for specified topic (persistent topic)persistentGetCompactionThreshold | GET | Get compaction threshold configuration for specified topic. |
Get configuration of persistence policies for specified topic (persistent topic)persistentGetPersistence | GET | Get configuration of persistence policies for specified topic. |
Get deduplication configuration of a topic (persistent topic)persistentGetDeduplication | GET | Get deduplication configuration of a topic. |
Get deduplicationSnapshotInterval config on a topic (persistent topic)persistentGetDeduplicationSnapshotInterval | GET | Get deduplicationSnapshotInterval config on a topic. |
Get delayed delivery messages config on a topic (persistent topic)persistentGetDelayedDeliveryPolicies | GET | Get delayed delivery messages config on a topic. |
Get dispatch rate configuration for specified topic (persistent topic)persistentGetDispatchRate | GET | Get dispatch rate configuration for specified topic. |
Get dispatcher pause on ack state persistent config on a topic (persistent topic)persistentGetDispatcherPauseOnAckStatePersistent | GET | Get dispatcher pause on ack state persistent config on a topic. |
Get entry filters for a topic (persistent topic)persistentGetEntryFilters | GET | Get entry filters for a topic. |
Get estimated backlog for offline topic (persistent topic)persistentGetBacklog | GET | Get estimated backlog for offline topic. |
Get inactive topic policies on a topic (persistent topic)persistentGetInactiveTopicPolicies | GET | Get inactive topic policies on a topic. |
Get is enable sub type fors specified topic (persistent topic)persistentGetSubscriptionTypesEnabled | GET | Get is enable sub type fors specified topic. |
Get max consumers per subscription configuration for specified topic (persistent topic)persistentGetMaxConsumersPerSubscription | GET | Get max consumers per subscription configuration for specified topic. |
Get max unacked messages per consumer config on a topic (persistent topic)persistentGetMaxUnackedMessagesOnConsumer | GET | Get max unacked messages per consumer config on a topic. |
Get max unacked messages per subscription config on a topic (persistent topic)persistentGetMaxUnackedMessagesOnSubscription | GET | Get max unacked messages per subscription config on a topic. |
Get maxConsumers config for specified topic (persistent topic)persistentGetMaxConsumers | GET | Get maxConsumers config for specified topic. |
Get maxMessageSize config for specified topic (persistent topic)persistentGetMaxMessageSize | GET | Get maxMessageSize config for specified topic. |
Get maxProducers config for specified topic (persistent topic)persistentGetMaxProducers | GET | Get maxProducers config for specified topic. |
Get maxSubscriptionsPerTopic config for specified topic (persistent topic)persistentGetMaxSubscriptionsPerTopic | GET | Get maxSubscriptionsPerTopic config for specified topic. |
Get message by its messageId (persistent topic)persistentGetMessageById | GET | Get message by its messageId. |
Get message dispatch rate configuration for specified subscription (persistent topic)persistentGetSubscriptionLevelDispatchRate | GET | Get message dispatch rate configuration for specified subscription. |
Get message ID published at or just after this absolute timestamp (in ms) (persistent topic)persistentGetMessageIdByTimestamp | GET | Get message ID published at or just after this absolute timestamp (in ms). |
Get message TTL in seconds for a topic (persistent topic)persistentGetMessageTTL | GET | Get message TTL in seconds for a topic |
Get offload policies on a topic (persistent topic)persistentGetOffloadPolicies | GET | Get offload policies on a topic. |
Get partitioned topic metadata (persistent topic)persistentGetPartitionedMetadata | GET | Get partitioned topic metadata. |
Get permissions on a topic (persistent topic)persistentGetPermissionsOnTopic | GET | Get permissions on a topic. |
Get publish rate configuration for specified topic (persistent topic)persistentGetPublishRate | GET | Get publish rate configuration for specified topic. |
Get replicated subscription status on a topic (persistent topic)persistentGetReplicatedSubscriptionStatus | GET | Get replicated subscription status on a topic. |
Get replicatorDispatchRate config for specified topic (persistent topic)persistentGetReplicatorDispatchRate | GET | Get replicatorDispatchRate config for specified topic. |
Get retention configuration for specified topic (persistent topic)persistentGetRetention | GET | Get retention configuration for specified topic. |
Get schema compatibility strategy on a topic (persistent topic)persistentGetSchemaCompatibilityStrategy | GET | Get schema compatibility strategy on a topic |
Get schema validation enforced flag for topic (persistent topic)persistentGetSchemaValidationEnforced | GET | Get schema validation enforced flag for topic. |
Get subscribe rate configuration for specified topic (persistent topic)persistentGetSubscribeRate | GET | Get subscribe rate configuration for specified topic. |
Get subscription expiration time in minutes for a topic (persistent topic)persistentGetSubscriptionExpirationTime | GET | Get subscription expiration time in minutes for a topic |
Get subscription message dispatch rate configuration for specified topic (persistent topic)persistentGetSubscriptionDispatchRate | GET | Get subscription message dispatch rate configuration for specified topic. |
Get the internal stats for the topic (persistent topic)persistentGetInternalStats | GET | Get the internal stats for the topic. |
Get the list of partitioned topics under a namespace (persistent topic)persistentGetPartitionedTopicList | GET | Get the list of partitioned topics under a namespace. |
Get the list of persistent subscriptions for a given topic (persistent topic)persistentGetSubscriptions | GET | Get the list of persistent subscriptions for a given topic. |
Get the list of topics under a namespacepersistentGetList | GET | Get the list of topics under a namespace. |
Get the replication clusters for a topic (persistent topic)persistentGetReplicationClusters | GET | Get the replication clusters for a topic |
Get the shadow topic list for a topic (persistent topic)persistentGetShadowTopics | GET | Get the shadow topic list for a topic |
Get the stats for the partitioned topic (persistent topic)persistentGetPartitionedStats | GET | Get the stats for the partitioned topic. |
Get the stats for the topic (persistent topic)persistentGetStats | GET | Get the stats for the topic. |
Get the stats-internal for the partitioned topic (persistent topic)persistentGetPartitionedStatsInternal | GET | Get the stats-internal for the partitioned topic. |
Get the status of a compaction operation for a topic (persistent topic)persistentCompactionStatus | GET | Get the status of a compaction operation for a topic. |
Get the stored topic metadata (persistent topic)persistentGetManagedLedgerInfo | GET | Get the stored topic metadata. |
Get topic properties (persistent topic)persistentGetProperties | GET | Get topic properties. |
Grant a new permission to a role on a single topic (persistent topic)persistentGrantPermissionsOnTopic | POST | Grant a new permission to a role on a single topic. |
Increment partitions of an existing partitioned topic (persistent topic)persistentUpdatePartitionedTopic | POST | Increment partitions of an existing partitioned topic. |
Offload a prefix of a topic to long term storage (persistent topic) (Persistent offload status)persistentOffloadStatus | GET | Offload a prefix of a topic to long term storage |
Offload a prefix of a topic to long term storage (persistent topic) (Persistent trigger offload)persistentTriggerOffload | PUT | Offload a prefix of a topic to long term storage |
Override namespace's allowAutoSubscriptionCreation setting for a topic (persistent topic)persistentSetAutoSubscriptionCreation | POST | Override namespace's allowAutoSubscriptionCreation setting for a topic |
Peek nth message on a topic subscription (persistent topic)persistentPeekNthMessage | GET | Peek nth message on a topic subscription. |
Remove a backlog quota policy from a topic (persistent topic)persistentRemoveBacklogQuota | DELETE | Remove a backlog quota policy from a topic. |
Remove autoSubscriptionCreation ina a topic (persistent topic)persistentRemoveAutoSubscriptionCreation | DELETE | Remove autoSubscriptionCreation ina a topic. |
Remove compaction threshold configuration for specified topic (persistent topic)persistentRemoveCompactionThreshold | DELETE | Remove compaction threshold configuration for specified topic. |
Remove configuration of persistence policies for specified topic (persistent topic)persistentRemovePersistence | DELETE | Remove configuration of persistence policies for specified topic. |
Remove deduplication configuration for specified topic (persistent topic)persistentRemoveDeduplication | DELETE | Remove deduplication configuration for specified topic. |
Remove dispatcher pause on ack state persistent configuration for specified topic (persistent topic)persistentRemoveDispatcherPauseOnAckStatePersistent | DELETE | Remove dispatcher pause on ack state persistent configuration for specified topic. |
Remove entry filters for specified topic (persistent topic)persistentRemoveEntryFilters | DELETE | Remove entry filters for specified topic. |
Remove max consumers per subscription configuration for specified topic (persistent topic)persistentRemoveMaxConsumersPerSubscription | DELETE | Remove max consumers per subscription configuration for specified topic. |
Remove maxConsumers config for specified topic (persistent topic)persistentRemoveMaxConsumers | DELETE | Remove maxConsumers config for specified topic. |
Remove maxMessageSize config for specified topic (persistent topic)persistentRemoveMaxMessageSize | DELETE | Remove maxMessageSize config for specified topic. |
Remove maxProducers config for specified topic (persistent topic)persistentRemoveMaxProducers | DELETE | Remove maxProducers config for specified topic. |
Remove maxSubscriptionsPerTopic config for specified topic (persistent topic)persistentRemoveMaxSubscriptionsPerTopic | DELETE | Remove maxSubscriptionsPerTopic config for specified topic. |
Remove message dispatch rate configuration for specified subscription (persistent topic)persistentRemoveSubscriptionLevelDispatchRate | DELETE | Remove message dispatch rate configuration for specified subscription. |
Remove message dispatch rate configuration for specified topic (persistent topic)persistentRemoveDispatchRate | DELETE | Remove message dispatch rate configuration for specified topic. |
Remove message publish rate configuration for specified topic (persistent topic)persistentRemovePublishRate | DELETE | Remove message publish rate configuration for specified topic. |
Remove message TTL in seconds for a topic (persistent topic)persistentRemoveMessageTTL | DELETE | Remove message TTL in seconds for a topic |
Remove replicatorDispatchRate config for specified topic (persistent topic)persistentRemoveReplicatorDispatchRate | DELETE | Remove replicatorDispatchRate config for specified topic. |
Remove retention configuration for specified topic (persistent topic)persistentRemoveRetention | DELETE | Remove retention configuration for specified topic. |
Remove schema compatibility strategy on a topic (persistent topic)persistentRemoveSchemaCompatibilityStrategy | DELETE | Remove schema compatibility strategy on a topic |
Remove subscribe rate configuration for specified topic (persistent topic)persistentRemoveSubscribeRate | DELETE | Remove subscribe rate configuration for specified topic. |
Remove subscription expiration time for a topic (persistent topic)persistentRemoveSubscriptionExpirationTime | DELETE | Remove subscription expiration time for a topic |
Remove subscription message dispatch rate configuration for specified topic (persistent topic)persistentRemoveSubscriptionDispatchRate | DELETE | Remove subscription message dispatch rate configuration for specified topic. |
Remove subscription types enabled for specified topic (persistent topic)persistentRemoveSubscriptionTypesEnabled | DELETE | Remove subscription types enabled for specified topic. |
Remove the key in properties on the given topic (persistent topic)persistentRemoveProperties | DELETE | Remove the key in properties on the given topic. |
Remove the replication clusters from a topic (persistent topic)persistentRemoveReplicationClusters | DELETE | Remove the replication clusters from a topic. |
Replace all the properties on the given subscription (persistent topic)persistentUpdateSubscriptionProperties | PUT | Replace all the properties on the given subscription |
Reset subscription to message position closest to absolute timestamp (in ms) (persistent topic)persistentResetCursor | POST | Reset subscription to message position closest to absolute timestamp (in ms). |
Reset subscription to message position closest to given position (persistent topic)persistentResetCursorOnPosition | POST | Reset subscription to message position closest to given position. |
Return all the properties on the given subscription (persistent topic)persistentGetSubscriptionProperties | GET | Return all the properties on the given subscription |
Return the last commit message id of topic (persistent topic)persistentGetLastMessageId | GET | Return the last commit message id of topic |
Revoke permissions on a topic (persistent topic)persistentRevokePermissionsOnTopic | DELETE | Revoke permissions on a topic. |
Set a backlog quota for a topic (persistent topic)persistentSetBacklogQuota | POST | Set a backlog quota for a topic. |
Set compaction threshold configuration for specified topic (persistent topic)persistentSetCompactionThreshold | POST | Set compaction threshold configuration for specified topic. |
Set configuration of persistence policies for specified topic (persistent topic)persistentSetPersistence | POST | Set configuration of persistence policies for specified topic. |
Set deduplication enabled on a topic (persistent topic)persistentSetDeduplication | POST | Set deduplication enabled on a topic. |
Set deduplicationSnapshotInterval config on a topic (persistent topic)persistentSetDeduplicationSnapshotInterval | POST | Set deduplicationSnapshotInterval config on a topic. |
Set delayed delivery messages config on a topic (persistent topic) (Persistent delete delayed delivery policies)persistentDeleteDelayedDeliveryPolicies | DELETE | Set delayed delivery messages config on a topic. |
Set delayed delivery messages config on a topic (persistent topic) (Persistent set delayed delivery policies)persistentSetDelayedDeliveryPolicies | POST | Set delayed delivery messages config on a topic. |
Set dispatcher pause on ack state persistent configuration for specified topic (persistent topic)persistentSetDispatcherPauseOnAckStatePersistent | POST | Set dispatcher pause on ack state persistent configuration for specified topic. |
Set entry filters for specified topic (persistent topic)persistentSetEntryFilters | POST | Set entry filters for specified topic |
Set inactive topic policies on a topic (persistent topic)persistentSetInactiveTopicPolicies | POST | Set inactive topic policies on a topic. |
Set is enable sub types for specified topic (persistent topic)persistentSetSubscriptionTypesEnabled | POST | Set is enable sub types for specified topic |
Set max consumers per subscription configuration for specified topic (persistent topic)persistentSetMaxConsumersPerSubscription | POST | Set max consumers per subscription configuration for specified topic. |
Set max unacked messages per consumer config on a topic (persistent topic)persistentSetMaxUnackedMessagesOnConsumer | POST | Set max unacked messages per consumer config on a topic. |
Set max unacked messages per subscription config on a topic (persistent topic)persistentSetMaxUnackedMessagesOnSubscription | POST | Set max unacked messages per subscription config on a topic. |
Set maxConsumers config for specified topic (persistent topic)persistentSetMaxConsumers | POST | Set maxConsumers config for specified topic. |
Set maxMessageSize config for specified topic (persistent topic)persistentSetMaxMessageSize | POST | Set maxMessageSize config for specified topic. |
Set maxProducers config for specified topic (persistent topic)persistentSetMaxProducers | POST | Set maxProducers config for specified topic. |
Set maxSubscriptionsPerTopic config for specified topic (persistent topic)persistentSetMaxSubscriptionsPerTopic | POST | Set maxSubscriptionsPerTopic config for specified topic. |
Set message dispatch rate configuration for specified subscription (persistent topic)persistentSetSubscriptionLevelDispatchRate | POST | Set message dispatch rate configuration for specified subscription. |
Set message dispatch rate configuration for specified topic (persistent topic)persistentSetDispatchRate | POST | Set message dispatch rate configuration for specified topic. |
Set message publish rate configuration for specified topic (persistent topic)persistentSetPublishRate | POST | Set message publish rate configuration for specified topic. |
Set message TTL in seconds for a topic (persistent topic)persistentSetMessageTTL | POST | Set message TTL in seconds for a topic |
Set offload policies on a topic (persistent topic)persistentSetOffloadPolicies | POST | Set offload policies on a topic. |
Set replicatorDispatchRate config for specified topic (persistent topic)persistentSetReplicatorDispatchRate | POST | Set replicatorDispatchRate config for specified topic. |
Set retention configuration for specified topic (persistent topic)persistentSetRetention | POST | Set retention configuration for specified topic. |
Set schema compatibility strategy on a topic (persistent topic)persistentSetSchemaCompatibilityStrategy | PUT | Set schema compatibility strategy on a topic |
Set schema validation enforced flag on topic (persistent topic)persistentSetSchemaValidationEnforced | POST | Set schema validation enforced flag on topic. |
Set shadow topic list for a topic (persistent topic)persistentSetShadowTopics | PUT | Set shadow topic list for a topic |
Set subscribe rate configuration for specified topic (persistent topic)persistentSetSubscribeRate | POST | Set subscribe rate configuration for specified topic. |
Set subscription expiration time in minutes for a topic (persistent topic)persistentSetSubscriptionExpirationTime | POST | Set subscription expiration time in minutes for a topic |
Set subscription message dispatch rate configuration for specified topic (persistent topic)persistentSetSubscriptionDispatchRate | POST | Set subscription message dispatch rate configuration for specified topic. |
Set the replication clusters for a topic (persistent topic)persistentSetReplicationClusters | POST | Set the replication clusters for a topic. |
Skip all messages on a topic subscription (persistent topic)persistentSkipAllMessages | POST | Skip all messages on a topic subscription. |
Skipping messages on a topic subscription (persistent topic)persistentSkipMessages | POST | Skipping messages on a topic subscription. |
Terminate a topic (persistent topic)persistentTerminate | POST | Terminate a topic. |
Terminate all partitioned topic (persistent topic)persistentTerminatePartitionedTopic | POST | Terminate all partitioned topic. |
Trigger a compaction operation on a topic (persistent topic)persistentCompact | PUT | Trigger a compaction operation on a topic. |
Trim a topic (persistent topic)persistentTrimTopic | POST | Trim a topic |
Truncate a topic (persistent topic)persistentTruncateTopic | DELETE | Truncate a topic. |
Unload a topic (persistent topic)persistentUnloadTopic | PUT | Unload a topic |
Update the properties on the given topic (persistent topic)persistentUpdateProperties | PUT | Update the properties on the given topic. |
Resource groups4
Creates a new resourcegroup with the specified rate limiterscreateOrUpdateResourceGroup | PUT | Creates a new resourcegroup with the specified rate limiters |
Delete a resourcegroupdeleteResourceGroup | DELETE | Delete a resourcegroup. |
Get the list of all the resourcegroupsgetResourceGroups | GET | Get the list of all the resourcegroups. |
Get the rate limiters specified for a resourcegroupgetResourceGroup | GET | Get the rate limiters specified for a resourcegroup. |
Resource quotas5
Get resource quota of a namespace bundlegetNamespaceBundleResourceQuota | GET | Get resource quota of a namespace bundle. |
Get the default quotagetDefaultResourceQuota | GET | Get the default quota |
Remove resource quota for a namespaceremoveNamespaceBundleResourceQuota | DELETE | Remove resource quota for a namespace. |
Set resource quota on a namespacesetNamespaceBundleResourceQuota | POST | Set resource quota on a namespace. |
Set the default quotasetDefaultResourceQuota | POST | Set the default quota |
Schemas8
Delete all versions schema of a topicdeleteSchema | DELETE | Delete all versions schema of a topic |
Get the all schemas of a topicgetAllSchemas | GET | Get the all schemas of a topic |
Get the schema metadata of a topicgetSchemaMetadata | GET | Get the schema metadata of a topic |
Get the schema of a topicgetSchema | GET | Get the schema of a topic |
Get the schema of a topic at a given versiongetSchemaByVersion | GET | Get the schema of a topic at a given version |
Get the version of the schemagetVersionBySchema | POST | get the version of the schema |
Test the schema compatibilitytestCompatibility | POST | test the schema compatibility |
Update the schema of a topicpostSchema | POST | Update the schema of a topic |
Sinks16
Creates a new Pulsar Sink in cluster moderegisterSink | POST | Creates a new Pulsar Sink in cluster mode Files stream from their file references. |
Deletes a Pulsar Sink currently running in cluster modederegisterSink | DELETE | Deletes a Pulsar Sink currently running in cluster mode |
Displays the status of a Pulsar Sink instancegetSinkInstanceStatus | GET | Displays the status of a Pulsar Sink instance |
Displays the status of a Pulsar Sink running in cluster modegetSinkStatus | GET | Displays the status of a Pulsar Sink running in cluster mode |
Fetches information about a Pulsar Sink currently running in cluster modegetSinkInfo | GET | Fetches information about a Pulsar Sink currently running in cluster mode |
Fetches information about config fields associated with the specified builtin sinkgetSinkConfigDefinition | GET | Fetches information about config fields associated with the specified builtin sink |
Fetches the list of built-in Pulsar IO sinksgetSinkList | GET | Fetches the list of built-in Pulsar IO sinks |
Lists all Pulsar Sinks currently deployed in a given namespacelistSinks | GET | Lists all Pulsar Sinks currently deployed in a given namespace |
Reload the built-in connectors, including Sources and Sinks (Reload sinks)reloadSinks | POST | Reload the built-in connectors, including Sources and Sinks |
Restart all instances of a Pulsar SinkrestartSink | POST | Restart all instances of a Pulsar Sink |
Restart an instance of a Pulsar SinkrestartSinkByInstanceId | POST | Restart an instance of a Pulsar Sink |
Start all instances of a Pulsar SinkstartSink | POST | Start all instances of a Pulsar Sink |
Start an instance of a Pulsar SinkstartSinkByInstanceId | POST | Start an instance of a Pulsar Sink |
Stop all instances of a Pulsar SinkstopSink | POST | Stop all instances of a Pulsar Sink |
Stop an instance of a Pulsar SinkstopSinkByInstanceId | POST | Stop an instance of a Pulsar Sink |
Updates a Pulsar Sink currently running in cluster modeupdateSink | PUT | Updates a Pulsar Sink currently running in cluster mode Files stream from their file references. |
Sources16
Creates a new Pulsar Source in cluster moderegisterSource | POST | Creates a new Pulsar Source in cluster mode Files stream from their file references. |
Deletes a Pulsar Source currently running in cluster modederegisterSource | DELETE | Deletes a Pulsar Source currently running in cluster mode |
Displays the status of a Pulsar Source instancegetSourceInstanceStatus | GET | Displays the status of a Pulsar Source instance |
Displays the status of a Pulsar Source running in cluster modegetSourceStatus | GET | Displays the status of a Pulsar Source running in cluster mode |
Fetches information about a Pulsar Source currently running in cluster modegetSourceInfo | GET | Fetches information about a Pulsar Source currently running in cluster mode |
Fetches information about config fields associated with the specified builtin sourcegetSourceConfigDefinition | GET | Fetches information about config fields associated with the specified builtin source |
Fetches the list of built-in Pulsar IO sourcesgetSourceList | GET | Fetches the list of built-in Pulsar IO sources |
Lists all Pulsar Sources currently deployed in a given namespacelistSources | GET | Lists all Pulsar Sources currently deployed in a given namespace |
Reload the built-in connectors, including Sources and Sinks (Reload sources)reloadSources | POST | Reload the built-in connectors, including Sources and Sinks |
Restart all instances of a Pulsar SourcerestartSource | POST | Restart all instances of a Pulsar Source |
Restart an instance of a Pulsar SourcerestartSourceByInstanceId | POST | Restart an instance of a Pulsar Source |
Start all instances of a Pulsar SourcestartSource | POST | Start all instances of a Pulsar Source |
Start an instance of a Pulsar SourcestartSourceByInstanceId | POST | Start an instance of a Pulsar Source |
Stop all instances of a Pulsar SourcestopSource | POST | Stop all instances of a Pulsar Source |
Stop instance of a Pulsar SourcestopSourceByInstanceId | POST | Stop instance of a Pulsar Source |
Updates a Pulsar Source currently running in cluster modeupdateSource | PUT | Updates a Pulsar Source currently running in cluster mode Files stream from their file references. |
Tenants5
Create a new tenantcreateTenant | PUT | Create a new tenant. |
Delete a tenant and all namespaces and topics under itdeleteTenant | DELETE | Delete a tenant and all namespaces and topics under it. |
Get the admin configuration for a given tenantgetTenantAdmin | GET | Get the admin configuration for a given tenant. |
Get the list of existing tenantsgetTenants | GET | Get the list of existing tenants. |
Update the admins for a tenantupdateTenant | POST | Update the admins for a tenant. |
Topic lookup2
Get the namespace bundle which the given topic belongsgetNamespaceBundle | GET | Get the namespace bundle which the given topic belongs to. |
Get the owner broker of the given topiclookupTopicAsync | GET | Get the owner broker of the given topic. |
Transactions14
Abort transactionabortTransaction | POST | Abort transaction |
Get coordinator internal statsgetCoordinatorInternalStats | GET | Get coordinator internal stats. |
Get position stats in pending ackgetPositionStatsInPendingAck | GET | Get position stats in pending ack. |
Get slow transactionsgetSlowTransactions | GET | Get slow transactions. |
Get transaction buffer internal statsgetTransactionBufferInternalStats | GET | Get transaction buffer internal stats. |
Get transaction buffer stats in topicgetTransactionBufferStats | GET | Get transaction buffer stats in topic. |
Get transaction coordinator statsgetCoordinatorStats | GET | Get transaction coordinator stats. |
Get transaction metadatagetTransactionMetadata | GET | Get transaction metadata |
Get transaction pending ack internal statsgetPendingAckInternalStats | GET | Get transaction pending ack internal stats. |
Get transaction pending ack stats in topicgetPendingAckStats | GET | Get transaction pending ack stats in topic. |
Get transaction state in pending ackgetTransactionInPendingAckStats | GET | Get transaction state in pending ack. |
Get transaction state in transaction buffergetTransactionInBufferStats | GET | Get transaction state in transaction buffer. |
List transaction coordinatorslistCoordinators | GET | List transaction coordinators. |
Scale transaction coordinatorsscaleTransactionCoordinators | POST | scaleTransactionCoordinators |