diff --git a/modules/apis/attachments/devops.html b/modules/apis/attachments/devops.html index ef24ef8..f0a96dc 100644 --- a/modules/apis/attachments/devops.html +++ b/modules/apis/attachments/devops.html @@ -12,362 +12,362 @@ margin: 0; } - -
API docs by Redocly
API docs by Redocly

DataStax Astra Streaming DevOps API (2.10.5)

Download OpenAPI specification:Download

DataStax Astra Streaming DevOps API Reference

-

secrets

getSecretsForTenant

Gets a list of secrets for the given tenant

-
Authorizations:
Bearer
query Parameters
format
string

the format of the secret including keys

-

Responses

deleteSecretsForTenant

Deletes a secret for the given tenant

-
Authorizations:
Bearer

Responses

createSecretsForTenant

Creates a secret for the given tenant

-
Authorizations:
Bearer
query Parameters
format
string

the format of the secret including keys

-
Request Body schema: application/json

a secret in string format

-
Body
string

Responses

Request samples

Content type
application/json
{
  • "Body": "string"
}

pulsar-stats

getNamespaceStatsByTenant

Get namespace stats under the specified tenant

-
Authorizations:
Bearer

Responses

getNamespaceStatsByTenantNamespace

Get aggregated stats under the specified tenant and namespace

-
Authorizations:
Bearer

Responses

getTopicStatsByTenant

Get topics stats under the specified tenant

-
Authorizations:
Bearer

Responses

getTopicStatsByTenantNamespace

Get topics stats under the specified tenant and namespace

-
Authorizations:
Bearer

Responses

cdc

deleteCDCConfigForTenant

Delete CDC configuration for the tenant

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

-

Responses

getCDCConfigForTenant

Lists all CDC configurations for the tenant

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

-

Responses

createCDCConfigForTenant

Create new CDC configurations for the tenant

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

-
Request Body schema: application/json
required
databaseId
string
databaseName
string
keyspace
string
orgId
string
tableName
string
topicPartitions
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "databaseId": "string",
  • "databaseName": "string",
  • "keyspace": "string",
  • "orgId": "string",
  • "tableName": "string",
  • "topicPartitions": 0
}

connectors

createSinkJSON

Creates a new Sink using the given JSON config

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

-
namespace
required
string

pulsar namespace

-
Request Body schema: application/json

sink configuration, see pulsar docs for more details: https://pulsar.apache.org/sink-rest-api/?version=master#operation/registerSink

-
object

Responses

Request samples

Content type
application/json
{ }

updateSinkJSON

Update a Sink using the given JSON config

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

-
namespace
required
string

pulsar namespace

-
Request Body schema: application/json

sink configuration, see pulsar docs for more details: https://pulsar.apache.org/sink-rest-api/?version=master#operation/registerSink

-
object

Responses

Request samples

Content type
application/json
{ }

createSourceJSON

Creates a new Source using the given JSON config

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

-
namespace
required
string

pulsar namespace

-
Request Body schema: application/json

source configuration, see pulsar docs for more details: https://pulsar.apache.org/source-rest-api/?version=master#operation/registerSource

-
object

Responses

Request samples

Content type
application/json
{ }

updateSourceJSON

Update a source using the given JSON config

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

-
namespace
required
string

pulsar namespace

-
Request Body schema: application/json

source configuration, see pulsar docs for more details: https://pulsar.apache.org/source-rest-api/?version=master#operation/registerSource

-
object

Responses

Request samples

Content type
application/json
{ }

getCDCEnabledTablesByDatabaseID

Gets a list of tables' CDC config with CDC enabled under an Astra database

-
Authorizations:
Bearer
query Parameters
keyspace
string

the specified keyspace name

-

Responses

clusters

getPulsarClusters

Gets a list of Pulsar clusters under a Pulsar instance

-
Authorizations:
Bearer
query Parameters
provider
string

Cloud provider, for example, aws, gcp, azure, or digital+ocean

-
region
string

Cloud provider region, for example, us-east1, us-west1, toronto

-
feature
string

Query clusters that support the specified feature (i.e. cdc)

-
type
string

Query dedicated and BYOC clusters. The query param value is dedicated.

-

Responses

getOrgsPulsarClusters

Gets a list of Pulsar clusters with the specified cluster type

-
Authorizations:
Bearer
query Parameters
type
string

Query dedicated and BYOC clusters. The only supported query param value is dedicated.

-

Responses

getClusterCloudProviders

Returns all available providers and all regions under each provider

-
Authorizations:
Bearer

Responses

getClusterRegions

Returns all available serverless regions for each provider

-
Authorizations:
Bearer

Responses

tenants

getTenantsByOrgID

Lists all Pulsar tenants under the specified organization

-
Authorizations:
Bearer

Responses

getTenantByOrgIDTenantID

Lists the specified tenant under the specified organization

-
Authorizations:
Bearer

Responses

getPlanPolicy

Get the tenant plan policy

-
Authorizations:
Bearer

Responses

getTenantsByOrgInHeader

Lists all Pulsar tenants under the organization that is retrieved from the token in the authorization header

-
Authorizations:
Bearer

Responses

createAstraPulsarTenant

Creates a tenant, the default namespace, a plan policy, and a Pulsar JWT

-
Authorizations:
Bearer
query Parameters
topic
string

Deprecated, topic management should be handled via the pulsar topic endpoints

-
Request Body schema: application/json

Request body for tenant creation

-
cloudProvider
string
cloudRegion
string
orgID
string
orgName
string
tenantName
string
userEmail
string

Responses

Request samples

Content type
application/json
{
  • "cloudProvider": "string",
  • "cloudRegion": "string",
  • "orgID": "string",
  • "orgName": "string",
  • "tenantName": "string",
  • "userEmail": "string"
}

checkTenantReserved

Returns 200 if the tenant is reserved under the specified query parameters

-
Authorizations:
Bearer
query Parameters
provider
string

Cloud provider, for example, aws, gcp, azure; this is required to evaluate whether a tenant has been reserved by its org owner

-
region
string

Cloud provider region, for example, us-east1, us-west1; this is required to evaluate whether a tenant has been reserved by its org owner

-
pulsarinstance
string

Pulsar instance is the collection of Pulsar clusters. The default value is prod0, which is all the clusters in Astra Streaming's public cloud. This is required to evaluate whether a tenant has been reserved by the entire Pulsar instance.

-
cluster
string

This is required to evaluate whether a tenant has been reserved within the specified cluster. It can be used for the dedicated or BYOC cluster.

-

Responses

deleteTenantByTenantCluster

Deletes a tenant from a cluster

-
Authorizations:
Bearer
query Parameters
opt
string

Performs a soft delete that only marks the tenant as deleted in the database (opt=soft)

-

Responses

getTenantUsageLimits

For the specified tenant, returns the current number of namespaces and topics, and the limits for both

-
Authorizations:
Bearer

Responses

replications

getAllowedClusters

Gets a list of Pulsar allowed clusters for replication

-
Authorizations:
Bearer

Responses

removeNamespaceReplications

Remove replicated namespace within the Pulsar instance

-
Authorizations:
Bearer
Request Body schema: application/json

Request body to setup namespace replication

-
bidirection
boolean
destCluster
string
email
string
namespace
string
originCluster
string

Responses

Request samples

Content type
application/json
{
  • "bidirection": true,
  • "destCluster": "string",
  • "email": "string",
  • "namespace": "string",
  • "originCluster": "string"
}

getNamespaceReplications

Gets replicated namespace within the Pulsar instance

-
Authorizations:
Bearer

Responses

setupNamespaceReplications

Set up replicated namespace within the Pulsar instance

-
Authorizations:
Bearer
Request Body schema: application/json

Request body to setup namespace replication

-
bidirection
boolean
destCluster
string
email
string
namespace
string
originCluster
string

Responses

Request samples

Content type
application/json
{
  • "bidirection": true,
  • "destCluster": "string",
  • "email": "string",
  • "namespace": "string",
  • "originCluster": "string"
}

pulsar-tokens

List all pulsar tokens under the specified tenant

Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

-

Responses

Create new pulsar token for the given tenant.

Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

-
query Parameters
exp
required
string

Time to live of token in string format (e.g. 1h, 1d, 1w, 1m, 1y)

-

Responses

deletePulsarTokenByID

Delete the given token from the given tenant

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

-
tokenID
required
string

ID of the token to delete

-

Responses

getPulsarTokenByID

Get the given token from the given tenant

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

-
tokenID
required
string

ID of the token

-

Responses

Create new pulsar token for the given tenant with JSON response.

Returns a JSON response instead of the string returned by the v2 endpoint.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

-
Request Body schema: application/json
exp
string

Time duration before the token expires. Expects a string format with a number and unit. For example, '5m', '2h', '10d', etc.

-
role
string
type
string

Type of token to create. Can be 'admin' or 'non-admin'

-

Responses

Request samples

Content type
application/json
{
  • "exp": "string",
  • "role": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "rolename": "string",
  • "token": "string"
}
+ " fill="currentColor">

DataStax Astra Streaming DevOps API (2.10.5)

Download OpenAPI specification:Download

DataStax Astra Streaming DevOps API Reference

+

secrets

getSecretsForTenant

Gets a list of secrets for the given tenant

+
Authorizations:
Bearer
query Parameters
format
string

the format of the secret including keys

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

the Astra Org ID

+

Responses

deleteSecretsForTenant

Deletes a secret for the given tenant

+
Authorizations:
Bearer
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

the Astra Org ID

+

Responses

createSecretsForTenant

Creates a secret for the given tenant

+
Authorizations:
Bearer
query Parameters
format
string

the format of the secret including keys

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

the Astra Org ID

+
Request Body schema: application/json

a secret in string format

+
Body
string

Responses

Request samples

Content type
application/json
{
  • "Body": "string"
}

pulsar-stats

getNamespaceStatsByTenant

Get namespace stats under the specified tenant

+
Authorizations:
Bearer

Responses

getNamespaceStatsByTenantNamespace

Get aggregated stats under the specified tenant and namespace

+
Authorizations:
Bearer

Responses

getTopicStatsByTenant

Get topics stats under the specified tenant

+
Authorizations:
Bearer

Responses

getTopicStatsByTenantNamespace

Get topics stats under the specified tenant and namespace

+
Authorizations:
Bearer

Responses

cdc

deleteCDCConfigForTenant

Delete CDC configuration for the tenant

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

+
header Parameters
Authorization
required
string

Pulsar token or Astra token.

+
X-DataStax-Pulsar-Cluster
required
string

Astra Streaming Cluster Name.

+
Request Body schema: application/json
required
databaseId
string
databaseName
string
keyspace
string
orgId
string
tableName
string
topicPartitions
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "databaseId": "string",
  • "databaseName": "string",
  • "keyspace": "string",
  • "orgId": "string",
  • "tableName": "string",
  • "topicPartitions": 0
}

getCDCConfigForTenant

Lists all CDC configurations for the tenant

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

+
header Parameters
Authorization
required
string

Pulsar token or Astra token.

+
X-DataStax-Pulsar-Cluster
required
string

Astra Streaming Cluster Name.

+

Responses

createCDCConfigForTenant

Create new CDC configurations for the tenant

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

+
header Parameters
Authorization
required
string

Pulsar token or Astra token.

+
X-DataStax-Pulsar-Cluster
required
string

Astra Streaming Cluster Name.

+
Request Body schema: application/json
required
databaseId
string
databaseName
string
keyspace
string
orgId
string
tableName
string
topicPartitions
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "databaseId": "string",
  • "databaseName": "string",
  • "keyspace": "string",
  • "orgId": "string",
  • "tableName": "string",
  • "topicPartitions": 0
}

connectors

createSinkJSON

Creates a new Sink using the given JSON config

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

+
namespace
required
string

pulsar namespace

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

Astra Org ID.

+
X-DataStax-Pulsar-Cluster
required
string

Astra Streaming Cluster Name.

+
Request Body schema: application/json

sink configuration, see pulsar docs for more details: https://pulsar.apache.org/sink-rest-api/?version=master#operation/registerSink

+
object

Responses

Request samples

Content type
application/json
{ }

updateSinkJSON

Update a Sink using the given JSON config

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

+
namespace
required
string

pulsar namespace

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

Astra Org ID.

+
X-DataStax-Pulsar-Cluster
required
string

Astra Streaming Cluster Name.

+
Request Body schema: application/json

sink configuration, see pulsar docs for more details: https://pulsar.apache.org/sink-rest-api/?version=master#operation/registerSink

+
object

Responses

Request samples

Content type
application/json
{ }

createSourceJSON

Creates a new Source using the given JSON config

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

+
namespace
required
string

pulsar namespace

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

Astra Org ID.

+
X-DataStax-Pulsar-Cluster
required
string

Astra Streaming Cluster Name.

+
Request Body schema: application/json

source configuration, see pulsar docs for more details: https://pulsar.apache.org/source-rest-api/?version=master#operation/registerSource

+
object

Responses

Request samples

Content type
application/json
{ }

updateSourceJSON

Update a source using the given JSON config

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

+
namespace
required
string

pulsar namespace

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

Astra Org ID.

+
X-DataStax-Pulsar-Cluster
required
string

Astra Streaming Cluster Name.

+
Request Body schema: application/json

source configuration, see pulsar docs for more details: https://pulsar.apache.org/source-rest-api/?version=master#operation/registerSource

+
object

Responses

Request samples

Content type
application/json
{ }

getCDCEnabledTablesByDatabaseID

Gets a list of tables' CDC config with CDC enabled under an Astra database

+
Authorizations:
Bearer
query Parameters
keyspace
string

the specified keyspace name

+

Responses

clusters

getPulsarClusters

Gets a list of Pulsar clusters under a Pulsar instance

+
Authorizations:
Bearer
query Parameters
provider
string

Cloud provider, for example, aws, gcp, azure, or digital+ocean

+
region
string

Cloud provider region, for example, us-east1, us-west1, toronto

+
feature
string

Query clusters that support the specified feature (i.e. cdc)

+
type
string

Query dedicated and BYOC clusters. The query param value is dedicated.

+

Responses

getOrgsPulsarClusters

Gets a list of Pulsar clusters with the specified cluster type

+
Authorizations:
Bearer
query Parameters
type
string

Query dedicated and BYOC clusters. The only supported query param value is dedicated.

+

Responses

getClusterCloudProviders

Returns all available providers and all regions under each provider

+
Authorizations:
Bearer

Responses

getClusterRegions

Returns all available serverless regions for each provider

+
Authorizations:
Bearer

Responses

tenants

getTenantsByOrgID

Lists all Pulsar tenants under the specified organization

+
Authorizations:
Bearer

Responses

getTenantByOrgIDTenantID

Lists the specified tenant under the specified organization

+
Authorizations:
Bearer

Responses

getPlanPolicy

Get the tenant plan policy

+
Authorizations:
Bearer

Responses

getTenantsByOrgInHeader

Lists all Pulsar tenants under the organization that is retrieved from the token in the authorization header

+
Authorizations:
Bearer

Responses

createAstraPulsarTenant

Creates a tenant, the default namespace, a plan policy, and a Pulsar JWT

+
Authorizations:
Bearer
query Parameters
topic
string

Deprecated, topic management should be handled via the pulsar topic endpoints

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

Organization GUID

+
Request Body schema: application/json

Request body for tenant creation

+
cloudProvider
string
cloudRegion
string
orgID
string
orgName
string
tenantName
string
userEmail
string

Responses

Request samples

Content type
application/json
{
  • "cloudProvider": "string",
  • "cloudRegion": "string",
  • "orgID": "string",
  • "orgName": "string",
  • "tenantName": "string",
  • "userEmail": "string"
}

checkTenantReserved

Returns 200 if the tenant is reserved under the specified query parameters

+
Authorizations:
Bearer
query Parameters
provider
string

Cloud provider, for example, aws, gcp, azure; this is required to evaluate whether a tenant has been reserved by its org owner

+
region
string

Cloud provider region, for example, us-east1, us-west1; this is required to evaluate whether a tenant has been reserved by its org owner

+
pulsarinstance
string

Pulsar instance is the collection of Pulsar clusters. The default value is prod0, which is all the clusters in Astra Streaming's public cloud. This is required to evaluate whether a tenant has been reserved by the entire Pulsar instance.

+
cluster
string

This is required to evaluate whether a tenant has been reserved within the specified cluster. It can be used for the dedicated or BYOC cluster.

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

the Astra Org ID

+

Responses

deleteTenantByTenantCluster

Deletes a tenant from a cluster

+
Authorizations:
Bearer
query Parameters
opt
string

Performs a soft delete that only marks the tenant as deleted in the database (opt=soft)

+

Responses

getTenantUsageLimits

For the specified tenant, returns the current number of namespaces and topics, and the limits for both

+
Authorizations:
Bearer

Responses

replications

getAllowedClusters

Gets a list of Pulsar allowed clusters for replication

+
Authorizations:
Bearer
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

the Astra Org ID

+

Responses

removeNamespaceReplications

Remove replicated namespace within the Pulsar instance

+
Authorizations:
Bearer
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

the Astra Org ID

+
Request Body schema: application/json

Request body to setup namespace replication

+
bidirection
boolean
destCluster
string
email
string
namespace
string
originCluster
string

Responses

Request samples

Content type
application/json
{
  • "bidirection": true,
  • "destCluster": "string",
  • "email": "string",
  • "namespace": "string",
  • "originCluster": "string"
}

getNamespaceReplications

Gets replicated namespace within the Pulsar instance

+
Authorizations:
Bearer

Responses

setupNamespaceReplications

Set up replicated namespace within the Pulsar instance

+
Authorizations:
Bearer
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

the Astra Org ID

+
Request Body schema: application/json

Request body to setup namespace replication

+
bidirection
boolean
destCluster
string
email
string
namespace
string
originCluster
string

Responses

Request samples

Content type
application/json
{
  • "bidirection": true,
  • "destCluster": "string",
  • "email": "string",
  • "namespace": "string",
  • "originCluster": "string"
}

pulsar-tokens

List all pulsar tokens under the specified tenant

Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

Astra Org ID.

+
X-DataStax-Pulsar-Cluster
required
string

Astra Streaming Cluster Name.

+

Responses

Create new pulsar token for the given tenant.

Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

+
query Parameters
exp
required
string

Time to live of token in string format (e.g. 1h, 1d, 1w, 1m, 1y)

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

Astra Org ID.

+
X-DataStax-Pulsar-Cluster
required
string

Astra Streaming Cluster Name.

+

Responses

deletePulsarTokenByID

Delete the given token from the given tenant

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

+
tokenID
required
string

ID of the token to delete

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

Astra Org ID.

+
X-DataStax-Pulsar-Cluster
required
string

Astra Streaming Cluster Name.

+

Responses

getPulsarTokenByID

Get the given token from the given tenant

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

+
tokenID
required
string

ID of the token

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

Astra Org ID.

+
X-DataStax-Pulsar-Cluster
required
string

Astra Streaming Cluster Name.

+

Responses

Create new pulsar token for the given tenant with JSON response.

Returns a JSON response instead of the string returned by the v2 endpoint.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Name of the pulsar tenant

+
header Parameters
Authorization
required
X-DataStax-Current-Org
required
string

Astra Org ID.

+
X-DataStax-Pulsar-Cluster
required
string

Astra Streaming Cluster Name.

+
Request Body schema: application/json
exp
string

Time duration before the token expires. Expects a string format with a number and unit. For example, '5m', '2h', '10d', etc.

+
role
string
type
string

Type of token to create. Can be 'admin' or 'non-admin'

+

Responses

Request samples

Content type
application/json
{
  • "exp": "string",
  • "role": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "rolename": "string",
  • "token": "string"
}
-
API docs by Redocly
API docs by Redocly

DataStax Astra Pulsar Admin API - source (2.10.5)

Download OpenAPI specification:Download

Compatible source Pulsar Admin API endpoints on DataStax Astra Streaming

-

broker-stats

Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache'

Authorizations:
Bearer
path Parameters
allocator
required
string

Responses

Response samples

Content type
application/json
{
  • "directArenas": [
    ],
  • "heapArenas": [
    ],
  • "normalCacheSize": 0,
  • "numDirectArenas": 0,
  • "numHeapArenas": 0,
  • "numThreadLocalCaches": 0,
  • "smallCacheSize": 0
}

Get pending bookie client op stats by namesapce

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

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 called broker-resource-availability

THIS API IS ONLY FOR USE BY TESTING FOR CONFIRMING NAMESPACE ALLOCATION ALGORITHM

-
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get Load for this broker

consists of topics stats & systemResourceUsage

-
Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "allocatedBandwidthIn": 0.1,
  • "allocatedBandwidthOut": 0.1,
  • "allocatedCPU": 0.1,
  • "allocatedMemory": 0.1,
  • "allocatedMsgRateIn": 0.1,
  • "allocatedMsgRateOut": 0.1,
  • "bandwidthIn": {
    },
  • "bandwidthOut": {
    },
  • "brokerVersionString": "string",
  • "bundleGains": [
    ],
  • "bundleLosses": [
    ],
  • "bundleStats": {
    },
  • "cpu": {
    },
  • "directMemory": {
    },
  • "lastUpdate": 0,
  • "loadReportType": "string",
  • "memory": {
    },
  • "msgRateIn": 0.1,
  • "msgRateOut": 0.1,
  • "msgThroughputIn": 0.1,
  • "msgThroughputOut": 0.1,
  • "name": "string",
  • "nonPersistentTopicsEnabled": true,
  • "numBundles": 0,
  • "numConsumers": 0,
  • "numProducers": 0,
  • "numTopics": 0,
  • "overLoaded": true,
  • "persistentTopicsEnabled": true,
  • "preAllocatedBandwidthIn": 0.1,
  • "preAllocatedBandwidthOut": 0.1,
  • "preAllocatedCPU": 0.1,
  • "preAllocatedMemory": 0.1,
  • "preAllocatedMsgRateIn": 0.1,
  • "preAllocatedMsgRateOut": 0.1,
  • "protocols": {
    },
  • "pulsarServiceUrl": "string",
  • "pulsarServiceUrlTls": "string",
  • "systemResourceUsage": {
    },
  • "timestamp": 0,
  • "underLoaded": true,
  • "webServiceUrl": "string",
  • "webServiceUrlTls": "string"
}

Get all the mbean details of this broker JVM

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the metrics for Monitoring

Requested should be executed by Monitoring agent on each broker to fetch the metrics

-
Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all the topic stats by namespace

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{ }

clusters

Get the list of all the Pulsar clusters.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get the configuration for the specified cluster.

This operation requires Pulsar superuser privileges.

-
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

-

Responses

Response samples

Content type
application/json
{
  • "authenticationParameters": "string",
  • "authenticationPlugin": "org.apache.pulsar.client.impl.auth.AuthenticationToken",
  • "brokerClientTlsEnabled": true,
  • "brokerClientTlsEnabledWithKeyStore": true,
  • "brokerClientTlsTrustStore": "string",
  • "brokerClientTlsTrustStorePassword": "string",
  • "brokerClientTlsTrustStoreType": "JKS",
  • "brokerClientTrustCertsFilePath": "string",
  • "brokerServiceUrl": "pulsar://pulsar.example.com:6650",
  • "brokerServiceUrlTls": "pulsar+ssl://pulsar.example.com:6651",
  • "listenerName": "string",
  • "peerClusterNames": [
    ],
  • "proxyProtocol": "SNI",
  • "proxyServiceUrl": "pulsar+ssl://ats-proxy.example.com:4443 or pulsar://ats-proxy.example.com:4080",
  • "serviceUrl": "http://pulsar.example.com:8080",
  • "serviceUrlTls": "https://pulsar.example.com:8443",
  • "tlsAllowInsecureConnection": true
}

Get the cluster failure domains.

This operation requires Pulsar superuser privileges.

-
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

-

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get a domain in a cluster

This operation requires Pulsar superuser privileges.

-
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

-
domainName
required
string

The failure domain name

-

Responses

Response samples

Content type
application/json
{
  • "brokers": "[ 'broker-1', 'broker-2' ]"
}

Get the namespace isolation policies assigned to the cluster.

This operation requires Pulsar superuser privileges.

-
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

-

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get list of brokers with namespace-isolation policies attached to them.

This operation requires Pulsar superuser privileges.

-
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

-

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a broker with namespace-isolation policies attached to it.

This operation requires Pulsar superuser privileges.

-
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

-
broker
required
string
Example: broker1:8080

The broker name (:)

-

Responses

Response samples

Content type
application/json
{
  • "brokerName": "broker1:8080",
  • "namespaceRegex": [
    ],
  • "policyName": "my-policy",
  • "primary": true
}

Get the single namespace isolation policy assigned to the cluster.

This operation requires Pulsar superuser privileges.

-
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

-
policyName
required
string

The name of the namespace isolation policy

-

Responses

Response samples

Content type
application/json
{
  • "auto_failover_policy": {
    },
  • "namespaces": [
    ],
  • "primary": [
    ],
  • "secondary": [
    ]
}

Get the peer-cluster data for the specified cluster.

This operation requires Pulsar superuser privileges.

-
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

-

Responses

Response samples

Content type
application/json
[
  • "string"
]

namespaces

Get all namespaces that are grouped by given anti-affinity group in a given cluster. api can be only accessed by admin of any of the existing tenant

Authorizations:
Bearer
path Parameters
cluster
required
string
group
required
string
query Parameters
tenant
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get the bookie-affinity-group from namespace-local policy.

Authorizations:
Bearer
path Parameters
property
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "bookkeeperAffinityGroupPrimary": "string",
  • "bookkeeperAffinityGroupSecondary": "string"
}

Get the list of all the namespaces for a certain tenant.

Authorizations:
Bearer
path Parameters
tenant
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete a namespace and all the topics under it.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
query Parameters
force
boolean
Default: false
authoritative
boolean
Default: false

Responses

Get the dump all the policies specified for a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "auth_policies": {
    },
  • "autoSubscriptionCreationOverride": {
    },
  • "autoTopicCreationOverride": {
    },
  • "backlog_quota_map": {
    },
  • "bundles": {
    },
  • "clusterDispatchRate": {
    },
  • "clusterSubscribeRate": {
    },
  • "compaction_threshold": 0,
  • "deduplicationEnabled": true,
  • "deduplicationSnapshotIntervalSeconds": 0,
  • "delayed_delivery_policies": {
    },
  • "deleted": true,
  • "encryption_required": true,
  • "inactive_topic_policies": {
    },
  • "is_allow_auto_update_schema": true,
  • "latency_stats_sample_rate": {
    },
  • "max_consumers_per_subscription": 0,
  • "max_consumers_per_topic": 0,
  • "max_producers_per_topic": 0,
  • "max_subscriptions_per_topic": 0,
  • "max_topics_per_namespace": 0,
  • "max_unacked_messages_per_consumer": 0,
  • "max_unacked_messages_per_subscription": 0,
  • "message_ttl_in_seconds": 0,
  • "offload_deletion_lag_ms": 0,
  • "offload_policies": {
    },
  • "offload_threshold": 0,
  • "persistence": {
    },
  • "properties": {
    },
  • "publishMaxMessageRate": {
    },
  • "replication_clusters": [
    ],
  • "replicatorDispatchRate": {
    },
  • "resource_group_name": "string",
  • "retention_policies": {
    },
  • "schema_auto_update_compatibility_strategy": "AutoUpdateDisabled",
  • "schema_compatibility_strategy": "UNDEFINED",
  • "schema_validation_enforced": true,
  • "subscriptionDispatchRate": {
    },
  • "subscription_auth_mode": "None",
  • "subscription_expiration_time_minutes": 0,
  • "subscription_types_enabled": [
    ],
  • "topicDispatchRate": {
    }
}

Creates a new namespace with the specified policies

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Policies for the namespace

-
object (AuthPolicies)
object (AutoSubscriptionCreationOverride)
object (AutoTopicCreationOverride)
object
object (BundlesData)
object
object
compaction_threshold
integer <int64>
deduplicationEnabled
boolean
deduplicationSnapshotIntervalSeconds
integer <int32>
object (DelayedDeliveryPolicies)
deleted
boolean
encryption_required
boolean
object (InactiveTopicPolicies)
is_allow_auto_update_schema
boolean
object
max_consumers_per_subscription
integer <int32>
max_consumers_per_topic
integer <int32>
max_producers_per_topic
integer <int32>
max_subscriptions_per_topic
integer <int32>
max_topics_per_namespace
integer <int32>
max_unacked_messages_per_consumer
integer <int32>
max_unacked_messages_per_subscription
integer <int32>
message_ttl_in_seconds
integer <int32>
offload_deletion_lag_ms
integer <int64>
object (OffloadPolicies)
offload_threshold
integer <int64>
object (PersistencePolicies)
object
object
replication_clusters
Array of strings unique
object
resource_group_name
string
object (RetentionPolicies)
schema_auto_update_compatibility_strategy
string
Enum: "AutoUpdateDisabled" "Backward" "Forward" "Full" "AlwaysCompatible" "BackwardTransitive" "ForwardTransitive" "FullTransitive"
schema_compatibility_strategy
string
Enum: "UNDEFINED" "ALWAYS_INCOMPATIBLE" "ALWAYS_COMPATIBLE" "BACKWARD" "FORWARD" "FULL" "BACKWARD_TRANSITIVE" "FORWARD_TRANSITIVE" "FULL_TRANSITIVE"
schema_validation_enforced
boolean
object
subscription_auth_mode
string
Enum: "None" "Prefix"
subscription_expiration_time_minutes
integer <int32>
subscription_types_enabled
Array of strings unique
object

Responses

Request samples

Content type
application/json
{
  • "auth_policies": {
    },
  • "autoSubscriptionCreationOverride": {
    },
  • "autoTopicCreationOverride": {
    },
  • "backlog_quota_map": {
    },
  • "bundles": {
    },
  • "clusterDispatchRate": {
    },
  • "clusterSubscribeRate": {
    },
  • "compaction_threshold": 0,
  • "deduplicationEnabled": true,
  • "deduplicationSnapshotIntervalSeconds": 0,
  • "delayed_delivery_policies": {
    },
  • "deleted": true,
  • "encryption_required": true,
  • "inactive_topic_policies": {
    },
  • "is_allow_auto_update_schema": true,
  • "latency_stats_sample_rate": {
    },
  • "max_consumers_per_subscription": 0,
  • "max_consumers_per_topic": 0,
  • "max_producers_per_topic": 0,
  • "max_subscriptions_per_topic": 0,
  • "max_topics_per_namespace": 0,
  • "max_unacked_messages_per_consumer": 0,
  • "max_unacked_messages_per_subscription": 0,
  • "message_ttl_in_seconds": 0,
  • "offload_deletion_lag_ms": 0,
  • "offload_policies": {
    },
  • "offload_threshold": 0,
  • "persistence": {
    },
  • "properties": {
    },
  • "publishMaxMessageRate": {
    },
  • "replication_clusters": [
    ],
  • "replicatorDispatchRate": {
    },
  • "resource_group_name": "string",
  • "retention_policies": {
    },
  • "schema_auto_update_compatibility_strategy": "AutoUpdateDisabled",
  • "schema_compatibility_strategy": "UNDEFINED",
  • "schema_validation_enforced": true,
  • "subscriptionDispatchRate": {
    },
  • "subscription_auth_mode": "None",
  • "subscription_expiration_time_minutes": 0,
  • "subscription_types_enabled": [
    ],
  • "topicDispatchRate": {
    }
}

Get autoSubscriptionCreation info in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "allowAutoSubscriptionCreation": true
}

Override broker's allowAutoSubscriptionCreation setting for a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Settings for automatic subscription creation

-
allowAutoSubscriptionCreation
boolean

Responses

Request samples

Content type
application/json
{
  • "allowAutoSubscriptionCreation": true
}

Get autoTopicCreation info in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "allowAutoTopicCreation": true,
  • "defaultNumPartitions": 0,
  • "topicType": "string"
}

Override broker's allowAutoTopicCreation setting for a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Settings for automatic topic creation

-
allowAutoTopicCreation
boolean
defaultNumPartitions
integer <int32>
topicType
string

Responses

Request samples

Content type
application/json
{
  • "allowAutoTopicCreation": true,
  • "defaultNumPartitions": 0,
  • "topicType": "string"
}

Set a backlog quota for all the topics on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
query Parameters
backlogQuotaType
string
Enum: "destination_storage" "message_age"
Request Body schema: application/json

Backlog quota for all topics of the specified namespace

-
limit
integer <int64>
limitSize
integer <int64>
limitTime
integer <int32>
policy
string
Enum: "producer_request_hold" "producer_exception" "consumer_backlog_eviction"

Responses

Request samples

Content type
application/json
{
  • "limit": 0,
  • "limitSize": 0,
  • "limitTime": 0,
  • "policy": "producer_request_hold"
}

Get backlog quota map on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get the bundles split data.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "boundaries": [
    ],
  • "numBundles": 0
}

Clear backlog for all topics on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Clear backlog for a given subscription on all topics on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
subscription
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Maximum number of uncompacted bytes in topics before compaction is triggered.

The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction

-
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maximum number of uncompacted bytes in a topic before compaction is triggered.

The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction

-
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Maximum number of uncompacted bytes in a topic of the specified namespace

-
integer <int64>

Responses

Request samples

Content type
application/json
0
0

Get broker side deduplication for all topics in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
true

Enable or disable broker side deduplication for all topics in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Flag for disabling or enabling broker side deduplication for all topics in the specified namespace

-
boolean

Responses

Request samples

Content type
application/json
true

Get deduplicationSnapshotInterval config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set deduplicationSnapshotInterval config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Interval to take deduplication snapshot per topic

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get delayed delivery messages config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "tickTime": 0
}

Set delayed delivery messages config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Delayed delivery policies for the specified namespace

-
active
boolean
tickTime
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "tickTime": 0
}

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

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "dispatchThrottlingRateInByte": 0,
  • "dispatchThrottlingRateInMsg": 0,
  • "ratePeriodInSecond": 0,
  • "relativeToPublishRate": true
}

Get message encryption required status in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
true

Message encryption is required or not for all topics in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Flag defining if message encryption is required

-
boolean

Responses

Request samples

Content type
application/json
true

Get inactive topic policies config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "deleteWhileInactive": true,
  • "inactiveTopicDeleteMode": "delete_when_no_subscriptions",
  • "maxInactiveDurationSeconds": 0
}

Set inactive topic policies config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Inactive topic policies for the specified namespace

-
deleteWhileInactive
boolean
inactiveTopicDeleteMode
string
Enum: "delete_when_no_subscriptions" "delete_when_subscriptions_caught_up"
maxInactiveDurationSeconds
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "deleteWhileInactive": true,
  • "inactiveTopicDeleteMode": "delete_when_no_subscriptions",
  • "maxInactiveDurationSeconds": 0
}

The flag of whether allow auto update schema

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
true

Update flag of whether allow auto update schema

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Flag of whether to allow auto update schema

-
boolean

Responses

Request samples

Content type
application/json
true

Get maxConsumersPerSubscription config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxConsumersPerSubscription configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum consumers per subscription

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxConsumersPerTopic config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxConsumersPerTopic configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum consumers per topic

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxProducersPerTopic config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxProducersPerTopic configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum producers per topic

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxSubscriptionsPerTopic config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxSubscriptionsPerTopic configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum subscriptions per topic

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxTopicsPerNamespace config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxTopicsPerNamespace config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum topics for specific namespace

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxUnackedMessagesPerConsumer config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxConsumersPerTopic configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum unacked messages per consumer

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxUnackedMessagesPerSubscription config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxUnackedMessagesPerSubscription configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum unacked messages per subscription

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get the message TTL for the namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set message TTL in seconds for namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

TTL in seconds for the specified namespace

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

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 has been completely disabled. 'null' denotes that the topics in the namespace will fall back to the broker default for deletion lag.

-
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Get offload configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "fileSystemDriver": true,
  • "fileSystemProfilePath": "string",
  • "fileSystemURI": "string",
  • "gcsDriver": true,
  • "gcsManagedLedgerOffloadBucket": "string",
  • "gcsManagedLedgerOffloadMaxBlockSizeInBytes": 0,
  • "gcsManagedLedgerOffloadReadBufferSizeInBytes": 0,
  • "gcsManagedLedgerOffloadRegion": "string",
  • "gcsManagedLedgerOffloadServiceAccountKeyFile": "string",
  • "managedLedgerOffloadBucket": "string",
  • "managedLedgerOffloadDeletionLagInMillis": 0,
  • "managedLedgerOffloadDriver": "string",
  • "managedLedgerOffloadMaxBlockSizeInBytes": 0,
  • "managedLedgerOffloadMaxThreads": 0,
  • "managedLedgerOffloadPrefetchRounds": 0,
  • "managedLedgerOffloadReadBufferSizeInBytes": 0,
  • "managedLedgerOffloadRegion": "string",
  • "managedLedgerOffloadServiceEndpoint": "string",
  • "managedLedgerOffloadThresholdInBytes": 0,
  • "managedLedgerOffloadedReadPriority": "BOOKKEEPER_FIRST",
  • "offloadersDirectory": "string",
  • "s3Driver": true,
  • "s3ManagedLedgerOffloadBucket": "string",
  • "s3ManagedLedgerOffloadCredentialId": "string",
  • "s3ManagedLedgerOffloadCredentialSecret": "string",
  • "s3ManagedLedgerOffloadMaxBlockSizeInBytes": 0,
  • "s3ManagedLedgerOffloadReadBufferSizeInBytes": 0,
  • "s3ManagedLedgerOffloadRegion": "string",
  • "s3ManagedLedgerOffloadRole": "string",
  • "s3ManagedLedgerOffloadRoleSessionName": "string",
  • "s3ManagedLedgerOffloadServiceEndpoint": "string"
}

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

-
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

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. A negative value disables automatic offloading.

-
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Maximum number of bytes stored on the pulsar cluster for a topic of the specified namespace

-
integer <int64>

Responses

Request samples

Content type
application/json
0
0

Retrieve the permissions for a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Retrieve the permissions for a subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Revoke all permissions to a role on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
role
required
string

Responses

Grant a new permission to a role on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
role
required
string
Request Body schema: application/json

List of permissions for the specified role

-
Array
string
Enum: "produce" "consume" "functions" "sources" "sinks" "packages"

Responses

Request samples

Content type
application/json
[
  • "produce"
]

Get the persistence configuration for a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "bookkeeperAckQuorum": 0,
  • "bookkeeperEnsemble": 0,
  • "bookkeeperWriteQuorum": 0,
  • "managedLedgerMaxMarkDeleteRate": 0.1
}

Get key value pair properties for a given namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Put key value pairs property on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Key value pair properties for the namespace

-
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get property value for a given key on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
key
required
string

Responses

Put a key value pair property on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
key
required
string
value
required
string

Responses

Get the replication clusters for a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Set the replication clusters for a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

List of replication clusters

-
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

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 dispatch-rate yet

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "dispatchThrottlingRateInByte": 0,
  • "dispatchThrottlingRateInMsg": 0,
  • "ratePeriodInSecond": 0,
  • "relativeToPublishRate": true
}

Get the resourcegroup attached to the namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
"string"

Set resourcegroup for a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
resourcegroup
required
string

Responses

Get retention config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "retentionSizeInMB": 0,
  • "retentionTimeInMinutes": 0
}

Set retention configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Retention policies for the specified namespace

-
retentionSizeInMB
integer <int64>
retentionTimeInMinutes
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "retentionSizeInMB": 0,
  • "retentionTimeInMinutes": 0
}

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 the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api

-
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
"AutoUpdateDisabled"

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 updating the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api

-
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Strategy used to check the compatibility of new schemas

-
string

Responses

Request samples

Content type
application/json
"string"

The strategy of the namespace schema compatibility

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
"UNDEFINED"

Update the strategy used to check the compatibility of new schema

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Strategy used to check the compatibility of new schema

-
string

Responses

Request samples

Content type
application/json
"string"

Get schema validation enforced flag for namespace.

If the flag is set to true, when a producer without a schema attempts to produce to a topic with schema in this namespace, the producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don't support schema.if you enable this setting, it will cause non-java clients failed to produce.

-
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
query Parameters
applied
boolean
Default: false

Responses

Response samples

Content type
application/json
true

Set schema validation enforced flag on namespace.

If the flag is set to true, when a producer without a schema attempts to produce to a topic with schema in this namespace, the producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don't support schema.if you enable this setting, it will cause non-java clients failed to produce.

-
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Flag of whether validation is enforced on the specified namespace

-
boolean

Responses

Request samples

Content type
application/json
true

Get subscribe-rate configured for the namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "ratePeriodInSecond": 0,
  • "subscribeThrottlingRatePerConsumer": 0
}

Get subscription auth mode in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
"None"

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 dispatch-rate yet

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "dispatchThrottlingRateInByte": 0,
  • "dispatchThrottlingRateInMsg": 0,
  • "ratePeriodInSecond": 0,
  • "relativeToPublishRate": true
}

Get the subscription expiration time for the namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set subscription expiration time in minutes for namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Expiration time in minutes for the specified namespace

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

The set of whether allow subscription types

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
[
  • "Exclusive"
]

Update set of whether allow share sub type

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Set of whether allow subscription types

-
Array
string
Enum: "Exclusive" "Shared" "Failover" "Key_Shared"

Responses

Request samples

Content type
application/json
[
  • "Exclusive"
]

Get the list of all the topics under a certain namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
query Parameters
mode
string
Default: "PERSISTENT"
Enum: "PERSISTENT" "NON_PERSISTENT" "ALL"

Responses

Response samples

Content type
application/json
[
  • "string"
]

Unload namespace

Unload an active namespace from the current broker serving it. Performing this operation will let the brokerremoves all producers, consumers, and connections using this namespace, and close all topics (includingtheir persistent store). During that operation, the namespace is marked as tentatively unavailable until thebroker completes the unloading action. This operation requires strictly super user privileges, since it wouldresult in non-persistent message loss and unexpected connection closure to the clients.

-
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Unsubscribes the given subscription on all topics on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
subscription
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Clear backlog for all topics on a namespace bundle.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
bundle
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Clear backlog for a given subscription on all topics on a namespace bundle.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
subscription
required
string
bundle
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Split a namespace bundle

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
bundle
required
string
query Parameters
authoritative
boolean
Default: false
unload
boolean
Default: false
splitAlgorithmName
string

Responses

Unload a namespace bundle

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
bundle
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Unsubscribes the given subscription on all topics on a namespace bundle.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
subscription
required
string
bundle
required
string
query Parameters
authoritative
boolean
Default: false

Responses

non-persistent topic

Get the list of non-persistent topics under a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
query Parameters
bundle
string

Specify the bundle name

-

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get the list of partitioned topics under a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get the list of non-persistent topics under a namespace bundle.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
bundle
required
string

Bundle range of a topic

-

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete a topic.

The topic cannot be deleted if delete is not forcefully and there's any active subscription or producer connected to the it. Force delete ignores connected clients and deletes topic by explicitly closing them.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
force
boolean
Default: false

Stop all producer/consumer/replicator and delete topic forcefully

-
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
deleteSchema
boolean
Default: false

Delete the topic's schema storage

-

Responses

Create a non-partitioned topic.

This is the only REST endpoint from which non-partitioned topics could be created.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Key value pair properties for the topic metadata

-
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Expiry messages on all subscriptions of topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
expireTimeInSeconds
required
integer <int32>
Default: 0

Expires beyond the specified number of seconds

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get estimated backlog for offline topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Response samples

Content type
application/json
{
  • "brokerName": "string",
  • "cursorDetails": {
    },
  • "dataLedgerDetails": [
    ],
  • "messageBacklog": 0,
  • "statGeneratedAt": "2019-08-24T14:15:22Z",
  • "storageSize": 0,
  • "topicName": "string",
  • "totalMessages": 0
}

Get backlog quota map on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
isGlobal
boolean
Default: false

Responses

Calculate backlog size by a message ID (in bytes).

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get the status of a compaction operation for a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Response samples

Content type
application/json
{
  • "lastError": "string",
  • "status": "NOT_RUN"
}

Trigger a compaction operation on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get compaction threshold configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Remove deduplication configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
authoritative
boolean
Default: false

Responses

Get deduplication configuration of a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set deduplication enabled on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

DeduplicationEnabled policies for the specified topic

-
boolean

Responses

Request samples

Content type
application/json
true

Set delayed delivery messages config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get delayed delivery messages config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set delayed delivery messages config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Delayed delivery policies for the specified topic

-
active
boolean
tickTime
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "tickTime": 0
}

Get dispatch rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Examine a specific message on a topic by position relative to the earliest or the latest message.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
initialPosition
string
Default: "latest"
Enum: "latest" "earliest"

Relative start position to examine message.It can be 'latest' or 'earliest'

-
messagePosition
integer <int64>
Default: 1

The position of messages (default 1)

-
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get inactive topic policies on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get the stored topic metadata.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get the internal stats for the topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
metadata
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "compactedLedger": {
    },
  • "currentLedgerEntries": 0,
  • "currentLedgerSize": 0,
  • "cursors": {
    },
  • "entriesAddedCounter": 0,
  • "lastConfirmedEntry": "string",
  • "lastLedgerCreatedTimestamp": "string",
  • "lastLedgerCreationFailureTimestamp": "string",
  • "ledgers": [
    ],
  • "numberOfEntries": 0,
  • "pendingAddEntriesCount": 0,
  • "schemaLedgers": [
    ],
  • "state": "string",
  • "totalSize": 0,
  • "waitingCursorsCount": 0
}

Return the last commit message id of topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get message by its messageId.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
ledgerId
required
integer <int64>

The ledger id

-
entryId
required
integer <int64>

The entry id

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get maxConsumers config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get max consumers per subscription configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Remove maxMessageSize config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get maxMessageSize config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set maxMessageSize config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

The max message size of the topic

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxProducers config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Remove maxSubscriptionsPerTopic config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get maxSubscriptionsPerTopic config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set maxSubscriptionsPerTopic config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

The max subscriptions of the topic

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get max unacked messages per consumer config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Delete max unacked messages per subscription config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get max unacked messages per subscription config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set max unacked messages per subscription config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Max unacked messages on subscription policies for the specified topic

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get message TTL in seconds for a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get message ID published at or just after this absolute timestamp (in ms).

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
timestamp
required
integer <int64>

Specify the timestamp

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Offload a prefix of a topic to long term storage

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Offload a prefix of a topic to long term storage

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get offload policies on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get the stats for the partitioned topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
perPartition
boolean
Default: true

Get per partition stats

-
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
getPreciseBacklog
boolean
Default: false

If return precise backlog or imprecise backlog

-
subscriptionBacklogSize
boolean
Default: false

If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.

-
getEarliestTimeInBacklog
boolean
Default: false

If return the earliest time in backlog

-

Responses

Delete a partitioned topic.

It will also delete all the partitions of the topic if it exists.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
force
boolean
Default: false

Stop all producer/consumer/replicator and delete topic forcefully

-
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
deleteSchema
boolean
Default: false

Delete the topic's schema storage

-

Responses

Get partitioned topic metadata.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
checkAllowAutoCreation
boolean
Default: false

Is check configuration required to automatically create topic

-

Responses

Increment partitions of an existing partitioned topic.

It only increments partitions of existing non-global partitioned-topic

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
updateLocalTopicOnly
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
force
boolean
Default: false
Request Body schema: application/json
required

The number of partitions for the topic

-
integer <int32>
Default: 0

Responses

Request samples

Content type
application/json
0
0

Create a partitioned topic.

It needs to be called before creating a producer on a partitioned topic.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
createLocalTopicOnly
boolean
Default: false
Request Body schema: application/vnd.partitioned-topic-metadata+json
required

The metadata for the topic

-
partitions
integer <int32>
object

Responses

Request samples

Content type
application/vnd.partitioned-topic-metadata+json
{
  • "partitions": 0,
  • "properties": {
    }
}

Get permissions on a topic.

Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at thenamespace level combined (union) with any eventual specific permission set on the topic.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Revoke permissions on a topic.

Revoke permissions to a role on a single topic. If the permission was not set at the topiclevel, but rather at the namespace level, this operation will return an error (HTTP status code 412).

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
role
required
string

Client role to which grant permissions

-

Responses

Grant a new permission to a role on a single topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
role
required
string

Client role to which grant permissions

-
Request Body schema: application/json

Actions to be granted (produce,functions,consume)

-
Array
string
Enum: "produce" "consume" "functions" "sources" "sinks" "packages"

Responses

Request samples

Content type
application/json
[
  • "produce"
]

Get topic properties.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get publish rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Remove the replication clusters from a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
backlogQuotaType
string
Enum: "destination_storage" "message_age"
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get the replication clusters for a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set the replication clusters for a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json
required

List of replication clusters

-
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Remove replicatorDispatchRate config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get replicatorDispatchRate config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set replicatorDispatchRate config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Replicator dispatch rate of the topic

-
dispatchThrottlingRateInByte
integer <int64>
dispatchThrottlingRateInMsg
integer <int32>
ratePeriodInSecond
integer <int32>
relativeToPublishRate
boolean

Responses

Request samples

Content type
application/json
{
  • "dispatchThrottlingRateInByte": 0,
  • "dispatchThrottlingRateInMsg": 0,
  • "ratePeriodInSecond": 0,
  • "relativeToPublishRate": true
}

Get retention configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Remove schema compatibility strategy on a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Strategy used to check the compatibility of new schema

-
string

Responses

Request samples

Content type
application/json
"string"

Get schema compatibility strategy on a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the cluster

-
topic
required
string

Specify topic name

-
query Parameters
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set schema compatibility strategy on a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Strategy used to check the compatibility of new schema

-
string

Responses

Request samples

Content type
application/json
"string"

Get the stats for the topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Is authentication required to perform this operation

-
getPreciseBacklog
boolean
Default: false

If return precise backlog or imprecise backlog

-
subscriptionBacklogSize
boolean
Default: false

If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.

-
getEarliestTimeInBacklog
boolean
Default: false

If return time of the earliest message in backlog

-

Responses

Response samples

Content type
application/json
{
  • "averageMsgSize": 0.1,
  • "backlogSize": 0,
  • "bytesInCounter": 0,
  • "bytesOutCounter": 0,
  • "compaction": {
    },
  • "deduplicationStatus": "string",
  • "earliestMsgPublishTimeInBacklogs": 0,
  • "msgChunkPublished": true,
  • "msgDropRate": 0.1,
  • "msgInCounter": 0,
  • "msgOutCounter": 0,
  • "msgRateIn": 0.1,
  • "msgRateOut": 0.1,
  • "msgThroughputIn": 0.1,
  • "msgThroughputOut": 0.1,
  • "nonContiguousDeletedMessagesRanges": 0,
  • "nonContiguousDeletedMessagesRangesSerializedSize": 0,
  • "offloadedStorageSize": 0,
  • "publishers": [
    ],
  • "replication": {
    },
  • "storageSize": 0,
  • "subscriptions": {
    },
  • "topicEpoch": 0,
  • "waitingPublishers": 0
}

Delete a subscription.

The subscription cannot be deleted if delete is not forcefully and there are any active consumers attached to it. Force delete ignores connected consumers and deletes subscription by explicitly closing them.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscription to be deleted

-
query Parameters
force
boolean
Default: false

Disconnect and close all consumers and delete subscription forcefully

-
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Expiry messages on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscription to be Expiry messages on

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

messageId to reset back to (ledgerId:entryId)

-
batchIndex
integer <int32>
entryId
integer <int64>
excluded
boolean
ledgerId
integer <int64>
partitionIndex
integer <int32>
object

Responses

Request samples

Content type
application/json
{
  • "batchIndex": 0,
  • "entryId": 0,
  • "excluded": true,
  • "ledgerId": 0,
  • "partitionIndex": 0,
  • "properties": {
    }
}

Expiry messages on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscription to be Expiry messages on

-
expireTimeInSeconds
required
integer <int32>
Default: 0

Expires beyond the specified number of seconds

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Peek nth message on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscribed message expired

-
messagePosition
required
integer <int32>
Default: 1

The number of messages (default 1)

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Replaces all the properties on the given subscription

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscription to update

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

The new properties

-
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get replicated subscription status on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Name of subscription

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Enable or disable a replicated subscription on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Name of subscription

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json
required

Whether to enable replicated subscription

-
boolean

Responses

Request samples

Content type
application/json
true

Reset subscription to message position closest to given position.

It fence cursor and disconnects all active consumers before reseting cursor.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscription to reset position on

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

messageId to reset back to (ledgerId:entryId)

-
batchIndex
integer <int32>
entryId
integer <int64>
excluded
boolean
ledgerId
integer <int64>
partitionIndex
integer <int32>
object

Responses

Request samples

Content type
application/json
{
  • "batchIndex": 0,
  • "entryId": 0,
  • "excluded": true,
  • "ledgerId": 0,
  • "partitionIndex": 0,
  • "properties": {
    }
}

Reset subscription to message position closest to absolute timestamp (in ms).

It fence cursor and disconnects all active consumers before reseting cursor.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscription to reset position on

-
timestamp
required
integer <int64>

the timestamp to reset back

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Skipping messages on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Name of subscription

-
numMessages
required
integer <int32>
Default: 0

The number of messages to skip

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Skip all messages on a topic subscription.

Completely clears the backlog on the subscription.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Name of subscription

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Create a subscription on the topic.

Creates a subscription on the topic at the specified message id

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subscriptionName
required
string

Subscription to create position on

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
replicated
boolean

Is replicated required to perform this operation

-
Request Body schema: application/json

messageId where to create the subscription. It can be 'latest', 'earliest' or (ledgerId:entryId)

-
batchIndex
integer <int32>
entryId
integer <int64>
excluded
boolean
ledgerId
integer <int64>
partitionIndex
integer <int32>
object

Responses

Request samples

Content type
application/json
{
  • "batchIndex": 0,
  • "entryId": 0,
  • "excluded": true,
  • "ledgerId": 0,
  • "partitionIndex": 0,
  • "properties": {
    }
}

Get subscription message dispatch rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Remove subscription types enabled for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get is enable sub type fors specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set is enable sub types for specified topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Enable sub types for the specified topic

-
Array
string
Enum: "Exclusive" "Shared" "Failover" "Key_Shared"

Responses

Request samples

Content type
application/json
[
  • "Exclusive"
]

Get the list of persistent subscriptions for a given topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Response samples

Content type
application/json
{ }

Terminate all partitioned topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Truncate a topic.

NonPersistentTopic does not support truncate.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Unload a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

persistent topic

Get the list of topics under a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
query Parameters
bundle
string

Specify the bundle name

-

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get the list of partitioned topics under a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete a topic.

The topic cannot be deleted if delete is not forcefully and there's any active subscription or producer connected to the it. Force delete ignores connected clients and deletes topic by explicitly closing them.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
force
boolean
Default: false

Stop all producer/consumer/replicator and delete topic forcefully

-
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
deleteSchema
boolean
Default: false

Delete the topic's schema storage

-

Responses

Create a non-partitioned topic.

This is the only REST endpoint from which non-partitioned topics could be created.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Key value pair properties for the topic metadata

-
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Expiry messages on all subscriptions of topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
expireTimeInSeconds
required
integer <int32>
Default: 0

Expires beyond the specified number of seconds

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get estimated backlog for offline topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Response samples

Content type
application/json
{
  • "brokerName": "string",
  • "cursorDetails": {
    },
  • "dataLedgerDetails": [
    ],
  • "messageBacklog": 0,
  • "statGeneratedAt": "2019-08-24T14:15:22Z",
  • "storageSize": 0,
  • "topicName": "string",
  • "totalMessages": 0
}

Get backlog quota map on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
isGlobal
boolean
Default: false

Responses

Calculate backlog size by a message ID (in bytes).

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get the status of a compaction operation for a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Response samples

Content type
application/json
{
  • "lastError": "string",
  • "status": "NOT_RUN"
}

Trigger a compaction operation on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get compaction threshold configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Create missed partitions of an existing partitioned topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-

Responses

Remove deduplication configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
authoritative
boolean
Default: false

Responses

Get deduplication configuration of a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set deduplication enabled on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

DeduplicationEnabled policies for the specified topic

-
boolean

Responses

Request samples

Content type
application/json
true

Set delayed delivery messages config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get delayed delivery messages config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set delayed delivery messages config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Delayed delivery policies for the specified topic

-
active
boolean
tickTime
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "tickTime": 0
}

Get dispatch rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Examine a specific message on a topic by position relative to the earliest or the latest message.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
initialPosition
string
Default: "latest"
Enum: "latest" "earliest"

Relative start position to examine message.It can be 'latest' or 'earliest'

-
messagePosition
integer <int64>
Default: 1

The position of messages (default 1)

-
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Delete inactive topic policies on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get inactive topic policies on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set inactive topic policies on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
isGlobal
boolean
Default: false
Request Body schema: application/json

inactive topic policies for the specified topic

-
deleteWhileInactive
boolean
inactiveTopicDeleteMode
string
Enum: "delete_when_no_subscriptions" "delete_when_subscriptions_caught_up"
maxInactiveDurationSeconds
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "deleteWhileInactive": true,
  • "inactiveTopicDeleteMode": "delete_when_no_subscriptions",
  • "maxInactiveDurationSeconds": 0
}

Get the stored topic metadata.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get the internal stats for the topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
metadata
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "compactedLedger": {
    },
  • "currentLedgerEntries": 0,
  • "currentLedgerSize": 0,
  • "cursors": {
    },
  • "entriesAddedCounter": 0,
  • "lastConfirmedEntry": "string",
  • "lastLedgerCreatedTimestamp": "string",
  • "lastLedgerCreationFailureTimestamp": "string",
  • "ledgers": [
    ],
  • "numberOfEntries": 0,
  • "pendingAddEntriesCount": 0,
  • "schemaLedgers": [
    ],
  • "state": "string",
  • "totalSize": 0,
  • "waitingCursorsCount": 0
}

Return the last commit message id of topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get message by its messageId.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
ledgerId
required
integer <int64>

The ledger id

-
entryId
required
integer <int64>

The entry id

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get maxConsumers config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get max consumers per subscription configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Remove maxMessageSize config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get maxMessageSize config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set maxMessageSize config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

The max message size of the topic

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxProducers config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Remove maxSubscriptionsPerTopic config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get maxSubscriptionsPerTopic config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set maxSubscriptionsPerTopic config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

The max subscriptions of the topic

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get max unacked messages per consumer config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Delete max unacked messages per subscription config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get max unacked messages per subscription config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set max unacked messages per subscription config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Max unacked messages on subscription policies for the specified topic

-
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get message TTL in seconds for a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get message ID published at or just after this absolute timestamp (in ms).

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
timestamp
required
integer <int64>

Specify the timestamp

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Offload a prefix of a topic to long term storage

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Offload a prefix of a topic to long term storage

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get offload policies on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get the stats for the partitioned topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
perPartition
boolean
Default: true

Get per partition stats

-
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
getPreciseBacklog
boolean
Default: false

If return precise backlog or imprecise backlog

-
subscriptionBacklogSize
boolean
Default: false

If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.

-
getEarliestTimeInBacklog
boolean
Default: false

If return the earliest time in backlog

-

Responses

Delete a partitioned topic.

It will also delete all the partitions of the topic if it exists.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
force
boolean
Default: false

Stop all producer/consumer/replicator and delete topic forcefully

-
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
deleteSchema
boolean
Default: false

Delete the topic's schema storage

-

Responses

Get partitioned topic metadata.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
checkAllowAutoCreation
boolean
Default: false

Is check configuration required to automatically create topic

-

Responses

Increment partitions of an existing partitioned topic.

It only increments partitions of existing non-global partitioned-topic

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
updateLocalTopicOnly
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
force
boolean
Default: false
Request Body schema: application/json
required

The number of partitions for the topic

-
integer <int32>
Default: 0

Responses

Request samples

Content type
application/json
0
0

Create a partitioned topic.

It needs to be called before creating a producer on a partitioned topic.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
createLocalTopicOnly
boolean
Default: false
Request Body schema: application/vnd.partitioned-topic-metadata+json
required

The metadata for the topic

-
partitions
integer <int32>
object

Responses

Request samples

Content type
application/vnd.partitioned-topic-metadata+json
{
  • "partitions": 0,
  • "properties": {
    }
}

Get permissions on a topic.

Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at thenamespace level combined (union) with any eventual specific permission set on the topic.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Revoke permissions on a topic.

Revoke permissions to a role on a single topic. If the permission was not set at the topiclevel, but rather at the namespace level, this operation will return an error (HTTP status code 412).

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
role
required
string

Client role to which grant permissions

-

Responses

Grant a new permission to a role on a single topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
role
required
string

Client role to which grant permissions

-
Request Body schema: application/json

Actions to be granted (produce,functions,consume)

-
Array
string
Enum: "produce" "consume" "functions" "sources" "sinks" "packages"

Responses

Request samples

Content type
application/json
[
  • "produce"
]

Get topic properties.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get publish rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Remove the replication clusters from a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
backlogQuotaType
string
Enum: "destination_storage" "message_age"
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get the replication clusters for a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set the replication clusters for a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json
required

List of replication clusters

-
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Remove replicatorDispatchRate config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get replicatorDispatchRate config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set replicatorDispatchRate config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Replicator dispatch rate of the topic

-
dispatchThrottlingRateInByte
integer <int64>
dispatchThrottlingRateInMsg
integer <int32>
ratePeriodInSecond
integer <int32>
relativeToPublishRate
boolean

Responses

Request samples

Content type
application/json
{
  • "dispatchThrottlingRateInByte": 0,
  • "dispatchThrottlingRateInMsg": 0,
  • "ratePeriodInSecond": 0,
  • "relativeToPublishRate": true
}

Remove retention configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get retention configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set retention configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
isGlobal
boolean
Default: false
Request Body schema: application/json

Retention policies for the specified namespace

-
retentionSizeInMB
integer <int64>
retentionTimeInMinutes
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "retentionSizeInMB": 0,
  • "retentionTimeInMinutes": 0
}

Remove schema compatibility strategy on a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Strategy used to check the compatibility of new schema

-
string

Responses

Request samples

Content type
application/json
"string"

Get schema compatibility strategy on a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the cluster

-
topic
required
string

Specify topic name

-
query Parameters
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set schema compatibility strategy on a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Strategy used to check the compatibility of new schema

-
string

Responses

Request samples

Content type
application/json
"string"

Get the stats for the topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
getPreciseBacklog
boolean
Default: false

If return precise backlog or imprecise backlog

-
subscriptionBacklogSize
boolean
Default: false

If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.

-
getEarliestTimeInBacklog
boolean
Default: false

If return time of the earliest message in backlog

-

Responses

Response samples

Content type
application/json
{
  • "averageMsgSize": 0.1,
  • "backlogSize": 0,
  • "bytesInCounter": 0,
  • "bytesOutCounter": 0,
  • "compaction": {
    },
  • "deduplicationStatus": "string",
  • "earliestMsgPublishTimeInBacklogs": 0,
  • "msgChunkPublished": true,
  • "msgInCounter": 0,
  • "msgOutCounter": 0,
  • "msgRateIn": 0.1,
  • "msgRateOut": 0.1,
  • "msgThroughputIn": 0.1,
  • "msgThroughputOut": 0.1,
  • "nonContiguousDeletedMessagesRanges": 0,
  • "nonContiguousDeletedMessagesRangesSerializedSize": 0,
  • "offloadedStorageSize": 0,
  • "publishers": [
    ],
  • "replication": {
    },
  • "storageSize": 0,
  • "subscriptions": {
    },
  • "topicEpoch": 0,
  • "waitingPublishers": 0
}

Get subscribe rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Delete a subscription.

The subscription cannot be deleted if delete is not forcefully and there are any active consumers attached to it. Force delete ignores connected consumers and deletes subscription by explicitly closing them.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscription to be deleted

-
query Parameters
force
boolean
Default: false

Disconnect and close all consumers and delete subscription forcefully

-
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Expiry messages on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscription to be Expiry messages on

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

messageId to reset back to (ledgerId:entryId)

-
batchIndex
integer <int32>
entryId
integer <int64>
excluded
boolean
ledgerId
integer <int64>
partitionIndex
integer <int32>
object

Responses

Request samples

Content type
application/json
{
  • "batchIndex": 0,
  • "entryId": 0,
  • "excluded": true,
  • "ledgerId": 0,
  • "partitionIndex": 0,
  • "properties": {
    }
}

Expiry messages on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscription to be Expiry messages on

-
expireTimeInSeconds
required
integer <int32>
Default: 0

Expires beyond the specified number of seconds

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Peek nth message on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscribed message expired

-
messagePosition
required
integer <int32>
Default: 1

The number of messages (default 1)

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Replaces all the properties on the given subscription

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscription to update

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

The new properties

-
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get replicated subscription status on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Name of subscription

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Enable or disable a replicated subscription on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Name of subscription

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json
required

Whether to enable replicated subscription

-
boolean

Responses

Request samples

Content type
application/json
true

Reset subscription to message position closest to given position.

It fence cursor and disconnects all active consumers before reseting cursor.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscription to reset position on

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

messageId to reset back to (ledgerId:entryId)

-
batchIndex
integer <int32>
entryId
integer <int64>
excluded
boolean
ledgerId
integer <int64>
partitionIndex
integer <int32>
object

Responses

Request samples

Content type
application/json
{
  • "batchIndex": 0,
  • "entryId": 0,
  • "excluded": true,
  • "ledgerId": 0,
  • "partitionIndex": 0,
  • "properties": {
    }
}

Reset subscription to message position closest to absolute timestamp (in ms).

It fence cursor and disconnects all active consumers before reseting cursor.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Subscription to reset position on

-
timestamp
required
integer <int64>

the timestamp to reset back

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Skipping messages on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Name of subscription

-
numMessages
required
integer <int32>
Default: 0

The number of messages to skip

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Skip all messages on a topic subscription.

Completely clears the backlog on the subscription.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subName
required
string

Name of subscription

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Create a subscription on the topic.

Creates a subscription on the topic at the specified message id

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
subscriptionName
required
string

Subscription to create position on

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
replicated
boolean

Is replicated required to perform this operation

-
Request Body schema: application/json

messageId where to create the subscription. It can be 'latest', 'earliest' or (ledgerId:entryId)

-
batchIndex
integer <int32>
entryId
integer <int64>
excluded
boolean
ledgerId
integer <int64>
partitionIndex
integer <int32>
object

Responses

Request samples

Content type
application/json
{
  • "batchIndex": 0,
  • "entryId": 0,
  • "excluded": true,
  • "ledgerId": 0,
  • "partitionIndex": 0,
  • "properties": {
    }
}

Get subscription message dispatch rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Remove subscription types enabled for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Get is enable sub type fors specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Set is enable sub types for specified topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-
Request Body schema: application/json

Enable sub types for the specified topic

-
Array
string
Enum: "Exclusive" "Shared" "Failover" "Key_Shared"

Responses

Request samples

Content type
application/json
[
  • "Exclusive"
]

Get the list of persistent subscriptions for a given topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Response samples

Content type
application/json
{ }

Terminate all partitioned topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Truncate a topic.

The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers.

-
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

Unload a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

-
namespace
required
string

Specify the namespace

-
topic
required
string

Specify topic name

-
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

-

Responses

resource-quotas

Get resource quota of a namespace bundle.

Authorizations:
Bearer
path Parameters
tenant
required
string

Tenant name

-
namespace
required
string

Namespace name within the specified tenant

-
bundle
required
string

Namespace bundle range

-

Responses

Response samples

Content type
application/json
{
  • "bandwidthIn": 0.1,
  • "bandwidthOut": 0.1,
  • "dynamic": true,
  • "memory": 0.1,
  • "msgRateIn": 0.1,
  • "msgRateOut": 0.1
}

resourcegroups

Get the list of all the resourcegroups.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete a resourcegroup.

Authorizations:
Bearer
path Parameters
resourcegroup
required
string

Responses

Get the rate limiters specified for a resourcegroup.

Authorizations:
Bearer
path Parameters
resourcegroup
required
string

Responses

Response samples

Content type
application/json
{
  • "dispatchRateInBytes": 0,
  • "dispatchRateInMsgs": 0,
  • "publishRateInBytes": 0,
  • "publishRateInMsgs": 0
}

Creates a new resourcegroup with the specified rate limiters

Authorizations:
Bearer
path Parameters
resourcegroup
required
string
Request Body schema: application/json

Rate limiters for the resourcegroup

-
dispatchRateInBytes
integer <int64>
dispatchRateInMsgs
integer <int32>
publishRateInBytes
integer <int64>
publishRateInMsgs
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "dispatchRateInBytes": 0,
  • "dispatchRateInMsgs": 0,
  • "publishRateInBytes": 0,
  • "publishRateInMsgs": 0
}

schemas

test the schema compatibility

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false
Request Body schema: application/json

A JSON value presenting a schema payload. An example of the expected schema can be found down here.

-
object
schema
string
type
string

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "compatibility": true,
  • "schemaCompatibilityStrategy": "string"
}

Delete the schema of a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "version": 0
}

Get the schema of a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "properties": {
    },
  • "timestamp": 0,
  • "type": "NONE",
  • "version": 0
}

Update the schema of a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false
Request Body schema: application/json

A JSON value presenting a schema payload. An example of the expected schema can be found down here.

-
object
schema
string
type
string

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "version": { }
}

Get the schema of a topic at a given version

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
version
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "properties": {
    },
  • "timestamp": 0,
  • "type": "NONE",
  • "version": 0
}

Get the all schemas of a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "getSchemaResponses": [
    ]
}

get the version of the schema

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false
Request Body schema: application/json

A JSON value presenting a schema payload. An example of the expected schema can be found down here.

-
object
schema
string
type
string

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "version": 0
}

tenants

Get the admin configuration for a given tenant.

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant name

-

Responses

Get metrics for all functions owned by worker

Requested should be executed by Monitoring agent on each worker to fetch the metrics

-
Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the metrics for Monitoring

Request should be executed by Monitoring agent on each worker to fetch the worker-metrics

-
Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetches information about which Pulsar Functions are assigned to which Pulsar clusters

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Fetches information about the Pulsar cluster running Pulsar Functions

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetches info about the leader node of the Pulsar cluster running Pulsar Functions

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "port": 0,
  • "workerHostname": "string",
  • "workerId": "string"
}

Checks if this node is the leader and is ready to service requests

Authorizations:
Bearer

Responses

Fetches a list of supported Pulsar IO connectors currently running in cluster mode

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • { }
]

Get the status of any ongoing drain operation at this worker

Authorizations:
Bearer

Responses

Drains this worker, i.e., moves its work-assignments to other workers

Authorizations:
Bearer

Responses

Get the status of any ongoing drain operation at the specified worker

Authorizations:
Bearer
query Parameters
workerId
string

Responses

Drains the specified worker, i.e., moves its work-assignments to other workers

Authorizations:
Bearer
query Parameters
workerId
string

Responses

Triggers a rebalance of functions to workers

Authorizations:
Bearer

Responses

functions

Fetches a list of supported Pulsar IO connectors currently running in cluster mode Deprecated

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • { }
]

Lists all Pulsar Functions currently deployed in a given namespace

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-

Responses

Response samples

Content type
application/json
"string"

Deletes a Pulsar Function currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-

Responses

Fetches information about a Pulsar Function currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-

Responses

Response samples

Content type
application/json
{
  • "autoAck": true,
  • "batchBuilder": "string",
  • "className": "string",
  • "cleanupSubscription": true,
  • "customRuntimeOptions": "string",
  • "customSchemaInputs": {
    },
  • "customSchemaOutputs": {
    },
  • "customSerdeInputs": {
    },
  • "deadLetterTopic": "string",
  • "exposePulsarAdminClientEnabled": true,
  • "forwardSourceMessageProperty": true,
  • "fqfn": "string",
  • "go": "string",
  • "inputSpecs": {
    },
  • "inputs": [
    ],
  • "jar": "string",
  • "logTopic": "string",
  • "maxMessageRetries": 0,
  • "maxPendingAsyncRequests": 0,
  • "name": "string",
  • "namespace": "string",
  • "output": "string",
  • "outputSchemaType": "string",
  • "outputSerdeClassName": "string",
  • "parallelism": 0,
  • "processingGuarantees": "ATLEAST_ONCE",
  • "producerConfig": {
    },
  • "py": "string",
  • "resources": {
    },
  • "retainKeyOrdering": true,
  • "retainOrdering": true,
  • "runtime": "JAVA",
  • "runtimeFlags": "string",
  • "secrets": {
    },
  • "subName": "string",
  • "subscriptionPosition": "Latest",
  • "tenant": "string",
  • "timeoutMs": 0,
  • "topicsPattern": "string",
  • "userConfig": {
    },
  • "windowConfig": {
    }
}

Creates a new Pulsar Function in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-
Request Body schema:

DataStax Astra Pulsar Admin API - source (2.10.5)

Download OpenAPI specification:Download

Compatible source Pulsar Admin API endpoints on DataStax Astra Streaming

+

broker-stats

Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache'

Authorizations:
Bearer
path Parameters
allocator
required
string

Responses

Response samples

Content type
application/json
{
  • "directArenas": [
    ],
  • "heapArenas": [
    ],
  • "normalCacheSize": 0,
  • "numDirectArenas": 0,
  • "numHeapArenas": 0,
  • "numThreadLocalCaches": 0,
  • "smallCacheSize": 0
}

Get pending bookie client op stats by namesapce

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

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 called broker-resource-availability

THIS API IS ONLY FOR USE BY TESTING FOR CONFIRMING NAMESPACE ALLOCATION ALGORITHM

+
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get Load for this broker

consists of topics stats & systemResourceUsage

+
Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "allocatedBandwidthIn": 0.1,
  • "allocatedBandwidthOut": 0.1,
  • "allocatedCPU": 0.1,
  • "allocatedMemory": 0.1,
  • "allocatedMsgRateIn": 0.1,
  • "allocatedMsgRateOut": 0.1,
  • "bandwidthIn": {
    },
  • "bandwidthOut": {
    },
  • "brokerVersionString": "string",
  • "bundleGains": [
    ],
  • "bundleLosses": [
    ],
  • "bundleStats": {
    },
  • "cpu": {
    },
  • "directMemory": {
    },
  • "lastUpdate": 0,
  • "loadReportType": "string",
  • "memory": {
    },
  • "msgRateIn": 0.1,
  • "msgRateOut": 0.1,
  • "msgThroughputIn": 0.1,
  • "msgThroughputOut": 0.1,
  • "name": "string",
  • "nonPersistentTopicsEnabled": true,
  • "numBundles": 0,
  • "numConsumers": 0,
  • "numProducers": 0,
  • "numTopics": 0,
  • "overLoaded": true,
  • "persistentTopicsEnabled": true,
  • "preAllocatedBandwidthIn": 0.1,
  • "preAllocatedBandwidthOut": 0.1,
  • "preAllocatedCPU": 0.1,
  • "preAllocatedMemory": 0.1,
  • "preAllocatedMsgRateIn": 0.1,
  • "preAllocatedMsgRateOut": 0.1,
  • "protocols": {
    },
  • "pulsarServiceUrl": "string",
  • "pulsarServiceUrlTls": "string",
  • "systemResourceUsage": {
    },
  • "timestamp": 0,
  • "underLoaded": true,
  • "webServiceUrl": "string",
  • "webServiceUrlTls": "string"
}

Get all the mbean details of this broker JVM

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the metrics for Monitoring

Requested should be executed by Monitoring agent on each broker to fetch the metrics

+
Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all the topic stats by namespace

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{ }

clusters

Get the list of all the Pulsar clusters.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get the configuration for the specified cluster.

This operation requires Pulsar superuser privileges.

+
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

+

Responses

Response samples

Content type
application/json
{
  • "authenticationParameters": "string",
  • "authenticationPlugin": "org.apache.pulsar.client.impl.auth.AuthenticationToken",
  • "brokerClientTlsEnabled": true,
  • "brokerClientTlsEnabledWithKeyStore": true,
  • "brokerClientTlsTrustStore": "string",
  • "brokerClientTlsTrustStorePassword": "string",
  • "brokerClientTlsTrustStoreType": "JKS",
  • "brokerClientTrustCertsFilePath": "string",
  • "brokerServiceUrl": "pulsar://pulsar.example.com:6650",
  • "brokerServiceUrlTls": "pulsar+ssl://pulsar.example.com:6651",
  • "listenerName": "string",
  • "peerClusterNames": [
    ],
  • "proxyProtocol": "SNI",
  • "proxyServiceUrl": "pulsar+ssl://ats-proxy.example.com:4443 or pulsar://ats-proxy.example.com:4080",
  • "serviceUrl": "http://pulsar.example.com:8080",
  • "serviceUrlTls": "https://pulsar.example.com:8443",
  • "tlsAllowInsecureConnection": true
}

Get the cluster failure domains.

This operation requires Pulsar superuser privileges.

+
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

+

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get a domain in a cluster

This operation requires Pulsar superuser privileges.

+
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

+
domainName
required
string

The failure domain name

+

Responses

Response samples

Content type
application/json
{
  • "brokers": "[ 'broker-1', 'broker-2' ]"
}

Get the namespace isolation policies assigned to the cluster.

This operation requires Pulsar superuser privileges.

+
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

+

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get list of brokers with namespace-isolation policies attached to them.

This operation requires Pulsar superuser privileges.

+
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a broker with namespace-isolation policies attached to it.

This operation requires Pulsar superuser privileges.

+
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

+
broker
required
string
Example: broker1:8080

The broker name (:)

+

Responses

Response samples

Content type
application/json
{
  • "brokerName": "broker1:8080",
  • "namespaceRegex": [
    ],
  • "policyName": "my-policy",
  • "primary": true
}

Get the single namespace isolation policy assigned to the cluster.

This operation requires Pulsar superuser privileges.

+
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

+
policyName
required
string

The name of the namespace isolation policy

+

Responses

Response samples

Content type
application/json
{
  • "auto_failover_policy": {
    },
  • "namespaces": [
    ],
  • "primary": [
    ],
  • "secondary": [
    ]
}

Get the peer-cluster data for the specified cluster.

This operation requires Pulsar superuser privileges.

+
Authorizations:
Bearer
path Parameters
cluster
required
string

The cluster name

+

Responses

Response samples

Content type
application/json
[
  • "string"
]

namespaces

Get all namespaces that are grouped by given anti-affinity group in a given cluster. api can be only accessed by admin of any of the existing tenant

Authorizations:
Bearer
path Parameters
cluster
required
string
group
required
string
query Parameters
tenant
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get the bookie-affinity-group from namespace-local policy.

Authorizations:
Bearer
path Parameters
property
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "bookkeeperAffinityGroupPrimary": "string",
  • "bookkeeperAffinityGroupSecondary": "string"
}

Get the list of all the namespaces for a certain tenant.

Authorizations:
Bearer
path Parameters
tenant
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete a namespace and all the topics under it.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
query Parameters
force
boolean
Default: false
authoritative
boolean
Default: false

Responses

Get the dump all the policies specified for a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "auth_policies": {
    },
  • "autoSubscriptionCreationOverride": {
    },
  • "autoTopicCreationOverride": {
    },
  • "backlog_quota_map": {
    },
  • "bundles": {
    },
  • "clusterDispatchRate": {
    },
  • "clusterSubscribeRate": {
    },
  • "compaction_threshold": 0,
  • "deduplicationEnabled": true,
  • "deduplicationSnapshotIntervalSeconds": 0,
  • "delayed_delivery_policies": {
    },
  • "deleted": true,
  • "encryption_required": true,
  • "inactive_topic_policies": {
    },
  • "is_allow_auto_update_schema": true,
  • "latency_stats_sample_rate": {
    },
  • "max_consumers_per_subscription": 0,
  • "max_consumers_per_topic": 0,
  • "max_producers_per_topic": 0,
  • "max_subscriptions_per_topic": 0,
  • "max_topics_per_namespace": 0,
  • "max_unacked_messages_per_consumer": 0,
  • "max_unacked_messages_per_subscription": 0,
  • "message_ttl_in_seconds": 0,
  • "offload_deletion_lag_ms": 0,
  • "offload_policies": {
    },
  • "offload_threshold": 0,
  • "persistence": {
    },
  • "properties": {
    },
  • "publishMaxMessageRate": {
    },
  • "replication_clusters": [
    ],
  • "replicatorDispatchRate": {
    },
  • "resource_group_name": "string",
  • "retention_policies": {
    },
  • "schema_auto_update_compatibility_strategy": "AutoUpdateDisabled",
  • "schema_compatibility_strategy": "UNDEFINED",
  • "schema_validation_enforced": true,
  • "subscriptionDispatchRate": {
    },
  • "subscription_auth_mode": "None",
  • "subscription_expiration_time_minutes": 0,
  • "subscription_types_enabled": [
    ],
  • "topicDispatchRate": {
    }
}

Creates a new namespace with the specified policies

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Policies for the namespace

+
object (AuthPolicies)
object (AutoSubscriptionCreationOverride)
object (AutoTopicCreationOverride)
object
object (BundlesData)
object
object
compaction_threshold
integer <int64>
deduplicationEnabled
boolean
deduplicationSnapshotIntervalSeconds
integer <int32>
object (DelayedDeliveryPolicies)
deleted
boolean
encryption_required
boolean
object (InactiveTopicPolicies)
is_allow_auto_update_schema
boolean
object
max_consumers_per_subscription
integer <int32>
max_consumers_per_topic
integer <int32>
max_producers_per_topic
integer <int32>
max_subscriptions_per_topic
integer <int32>
max_topics_per_namespace
integer <int32>
max_unacked_messages_per_consumer
integer <int32>
max_unacked_messages_per_subscription
integer <int32>
message_ttl_in_seconds
integer <int32>
offload_deletion_lag_ms
integer <int64>
object (OffloadPolicies)
offload_threshold
integer <int64>
object (PersistencePolicies)
object
object
replication_clusters
Array of strings unique
object
resource_group_name
string
object (RetentionPolicies)
schema_auto_update_compatibility_strategy
string
Enum: "AutoUpdateDisabled" "Backward" "Forward" "Full" "AlwaysCompatible" "BackwardTransitive" "ForwardTransitive" "FullTransitive"
schema_compatibility_strategy
string
Enum: "UNDEFINED" "ALWAYS_INCOMPATIBLE" "ALWAYS_COMPATIBLE" "BACKWARD" "FORWARD" "FULL" "BACKWARD_TRANSITIVE" "FORWARD_TRANSITIVE" "FULL_TRANSITIVE"
schema_validation_enforced
boolean
object
subscription_auth_mode
string
Enum: "None" "Prefix"
subscription_expiration_time_minutes
integer <int32>
subscription_types_enabled
Array of strings unique
object

Responses

Request samples

Content type
application/json
{
  • "auth_policies": {
    },
  • "autoSubscriptionCreationOverride": {
    },
  • "autoTopicCreationOverride": {
    },
  • "backlog_quota_map": {
    },
  • "bundles": {
    },
  • "clusterDispatchRate": {
    },
  • "clusterSubscribeRate": {
    },
  • "compaction_threshold": 0,
  • "deduplicationEnabled": true,
  • "deduplicationSnapshotIntervalSeconds": 0,
  • "delayed_delivery_policies": {
    },
  • "deleted": true,
  • "encryption_required": true,
  • "inactive_topic_policies": {
    },
  • "is_allow_auto_update_schema": true,
  • "latency_stats_sample_rate": {
    },
  • "max_consumers_per_subscription": 0,
  • "max_consumers_per_topic": 0,
  • "max_producers_per_topic": 0,
  • "max_subscriptions_per_topic": 0,
  • "max_topics_per_namespace": 0,
  • "max_unacked_messages_per_consumer": 0,
  • "max_unacked_messages_per_subscription": 0,
  • "message_ttl_in_seconds": 0,
  • "offload_deletion_lag_ms": 0,
  • "offload_policies": {
    },
  • "offload_threshold": 0,
  • "persistence": {
    },
  • "properties": {
    },
  • "publishMaxMessageRate": {
    },
  • "replication_clusters": [
    ],
  • "replicatorDispatchRate": {
    },
  • "resource_group_name": "string",
  • "retention_policies": {
    },
  • "schema_auto_update_compatibility_strategy": "AutoUpdateDisabled",
  • "schema_compatibility_strategy": "UNDEFINED",
  • "schema_validation_enforced": true,
  • "subscriptionDispatchRate": {
    },
  • "subscription_auth_mode": "None",
  • "subscription_expiration_time_minutes": 0,
  • "subscription_types_enabled": [
    ],
  • "topicDispatchRate": {
    }
}

Get autoSubscriptionCreation info in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "allowAutoSubscriptionCreation": true
}

Override broker's allowAutoSubscriptionCreation setting for a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Settings for automatic subscription creation

+
allowAutoSubscriptionCreation
boolean

Responses

Request samples

Content type
application/json
{
  • "allowAutoSubscriptionCreation": true
}

Get autoTopicCreation info in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "allowAutoTopicCreation": true,
  • "defaultNumPartitions": 0,
  • "topicType": "string"
}

Override broker's allowAutoTopicCreation setting for a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Settings for automatic topic creation

+
allowAutoTopicCreation
boolean
defaultNumPartitions
integer <int32>
topicType
string

Responses

Request samples

Content type
application/json
{
  • "allowAutoTopicCreation": true,
  • "defaultNumPartitions": 0,
  • "topicType": "string"
}

Set a backlog quota for all the topics on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
query Parameters
backlogQuotaType
string
Enum: "destination_storage" "message_age"
Request Body schema: application/json

Backlog quota for all topics of the specified namespace

+
limit
integer <int64>
limitSize
integer <int64>
limitTime
integer <int32>
policy
string
Enum: "producer_request_hold" "producer_exception" "consumer_backlog_eviction"

Responses

Request samples

Content type
application/json
{
  • "limit": 0,
  • "limitSize": 0,
  • "limitTime": 0,
  • "policy": "producer_request_hold"
}

Get backlog quota map on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get the bundles split data.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "boundaries": [
    ],
  • "numBundles": 0
}

Clear backlog for all topics on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Clear backlog for a given subscription on all topics on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
subscription
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Maximum number of uncompacted bytes in topics before compaction is triggered.

The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction

+
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maximum number of uncompacted bytes in a topic before compaction is triggered.

The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction

+
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Maximum number of uncompacted bytes in a topic of the specified namespace

+
integer <int64>

Responses

Request samples

Content type
application/json
0
0

Get broker side deduplication for all topics in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
true

Enable or disable broker side deduplication for all topics in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Flag for disabling or enabling broker side deduplication for all topics in the specified namespace

+
boolean

Responses

Request samples

Content type
application/json
true

Get deduplicationSnapshotInterval config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set deduplicationSnapshotInterval config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Interval to take deduplication snapshot per topic

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get delayed delivery messages config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "tickTime": 0
}

Set delayed delivery messages config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Delayed delivery policies for the specified namespace

+
active
boolean
tickTime
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "tickTime": 0
}

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

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "dispatchThrottlingRateInByte": 0,
  • "dispatchThrottlingRateInMsg": 0,
  • "ratePeriodInSecond": 0,
  • "relativeToPublishRate": true
}

Get message encryption required status in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
true

Message encryption is required or not for all topics in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Flag defining if message encryption is required

+
boolean

Responses

Request samples

Content type
application/json
true

Get inactive topic policies config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "deleteWhileInactive": true,
  • "inactiveTopicDeleteMode": "delete_when_no_subscriptions",
  • "maxInactiveDurationSeconds": 0
}

Set inactive topic policies config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Inactive topic policies for the specified namespace

+
deleteWhileInactive
boolean
inactiveTopicDeleteMode
string
Enum: "delete_when_no_subscriptions" "delete_when_subscriptions_caught_up"
maxInactiveDurationSeconds
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "deleteWhileInactive": true,
  • "inactiveTopicDeleteMode": "delete_when_no_subscriptions",
  • "maxInactiveDurationSeconds": 0
}

The flag of whether allow auto update schema

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
true

Update flag of whether allow auto update schema

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Flag of whether to allow auto update schema

+
boolean

Responses

Request samples

Content type
application/json
true

Get maxConsumersPerSubscription config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxConsumersPerSubscription configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum consumers per subscription

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxConsumersPerTopic config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxConsumersPerTopic configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum consumers per topic

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxProducersPerTopic config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxProducersPerTopic configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum producers per topic

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxSubscriptionsPerTopic config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxSubscriptionsPerTopic configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum subscriptions per topic

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxTopicsPerNamespace config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxTopicsPerNamespace config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum topics for specific namespace

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxUnackedMessagesPerConsumer config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxConsumersPerTopic configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum unacked messages per consumer

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxUnackedMessagesPerSubscription config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set maxUnackedMessagesPerSubscription configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Number of maximum unacked messages per subscription

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get the message TTL for the namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set message TTL in seconds for namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

TTL in seconds for the specified namespace

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

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 has been completely disabled. 'null' denotes that the topics in the namespace will fall back to the broker default for deletion lag.

+
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Get offload configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "fileSystemDriver": true,
  • "fileSystemProfilePath": "string",
  • "fileSystemURI": "string",
  • "gcsDriver": true,
  • "gcsManagedLedgerOffloadBucket": "string",
  • "gcsManagedLedgerOffloadMaxBlockSizeInBytes": 0,
  • "gcsManagedLedgerOffloadReadBufferSizeInBytes": 0,
  • "gcsManagedLedgerOffloadRegion": "string",
  • "gcsManagedLedgerOffloadServiceAccountKeyFile": "string",
  • "managedLedgerOffloadBucket": "string",
  • "managedLedgerOffloadDeletionLagInMillis": 0,
  • "managedLedgerOffloadDriver": "string",
  • "managedLedgerOffloadMaxBlockSizeInBytes": 0,
  • "managedLedgerOffloadMaxThreads": 0,
  • "managedLedgerOffloadPrefetchRounds": 0,
  • "managedLedgerOffloadReadBufferSizeInBytes": 0,
  • "managedLedgerOffloadRegion": "string",
  • "managedLedgerOffloadServiceEndpoint": "string",
  • "managedLedgerOffloadThresholdInBytes": 0,
  • "managedLedgerOffloadedReadPriority": "BOOKKEEPER_FIRST",
  • "offloadersDirectory": "string",
  • "s3Driver": true,
  • "s3ManagedLedgerOffloadBucket": "string",
  • "s3ManagedLedgerOffloadCredentialId": "string",
  • "s3ManagedLedgerOffloadCredentialSecret": "string",
  • "s3ManagedLedgerOffloadMaxBlockSizeInBytes": 0,
  • "s3ManagedLedgerOffloadReadBufferSizeInBytes": 0,
  • "s3ManagedLedgerOffloadRegion": "string",
  • "s3ManagedLedgerOffloadRole": "string",
  • "s3ManagedLedgerOffloadRoleSessionName": "string",
  • "s3ManagedLedgerOffloadServiceEndpoint": "string"
}

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

+
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

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. A negative value disables automatic offloading.

+
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Maximum number of bytes stored on the pulsar cluster for a topic of the specified namespace

+
integer <int64>

Responses

Request samples

Content type
application/json
0
0

Retrieve the permissions for a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Retrieve the permissions for a subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Revoke all permissions to a role on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
role
required
string

Responses

Grant a new permission to a role on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
role
required
string
Request Body schema: application/json

List of permissions for the specified role

+
Array
string
Enum: "produce" "consume" "functions" "sources" "sinks" "packages"

Responses

Request samples

Content type
application/json
[
  • "produce"
]

Get the persistence configuration for a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "bookkeeperAckQuorum": 0,
  • "bookkeeperEnsemble": 0,
  • "bookkeeperWriteQuorum": 0,
  • "managedLedgerMaxMarkDeleteRate": 0.1
}

Get key value pair properties for a given namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Put key value pairs property on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Key value pair properties for the namespace

+
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get property value for a given key on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
key
required
string

Responses

Put a key value pair property on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
key
required
string
value
required
string

Responses

Get the replication clusters for a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Set the replication clusters for a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

List of replication clusters

+
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

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 dispatch-rate yet

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "dispatchThrottlingRateInByte": 0,
  • "dispatchThrottlingRateInMsg": 0,
  • "ratePeriodInSecond": 0,
  • "relativeToPublishRate": true
}

Get the resourcegroup attached to the namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
"string"

Set resourcegroup for a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
resourcegroup
required
string

Responses

Get retention config on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "retentionSizeInMB": 0,
  • "retentionTimeInMinutes": 0
}

Set retention configuration on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Retention policies for the specified namespace

+
retentionSizeInMB
integer <int64>
retentionTimeInMinutes
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "retentionSizeInMB": 0,
  • "retentionTimeInMinutes": 0
}

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 the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api

+
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
"AutoUpdateDisabled"

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 updating the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api

+
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Strategy used to check the compatibility of new schemas

+
string

Responses

Request samples

Content type
application/json
"string"

The strategy of the namespace schema compatibility

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
"UNDEFINED"

Update the strategy used to check the compatibility of new schema

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json

Strategy used to check the compatibility of new schema

+
string

Responses

Request samples

Content type
application/json
"string"

Get schema validation enforced flag for namespace.

If the flag is set to true, when a producer without a schema attempts to produce to a topic with schema in this namespace, the producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don't support schema.if you enable this setting, it will cause non-java clients failed to produce.

+
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
query Parameters
applied
boolean
Default: false

Responses

Response samples

Content type
application/json
true

Set schema validation enforced flag on namespace.

If the flag is set to true, when a producer without a schema attempts to produce to a topic with schema in this namespace, the producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don't support schema.if you enable this setting, it will cause non-java clients failed to produce.

+
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Flag of whether validation is enforced on the specified namespace

+
boolean

Responses

Request samples

Content type
application/json
true

Get subscribe-rate configured for the namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "ratePeriodInSecond": 0,
  • "subscribeThrottlingRatePerConsumer": 0
}

Get subscription auth mode in a namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
"None"

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 dispatch-rate yet

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "dispatchThrottlingRateInByte": 0,
  • "dispatchThrottlingRateInMsg": 0,
  • "ratePeriodInSecond": 0,
  • "relativeToPublishRate": true
}

Get the subscription expiration time for the namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
0
0

Set subscription expiration time in minutes for namespace

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Expiration time in minutes for the specified namespace

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

The set of whether allow subscription types

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
[
  • "Exclusive"
]

Update set of whether allow share sub type

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
Request Body schema: application/json
required

Set of whether allow subscription types

+
Array
string
Enum: "Exclusive" "Shared" "Failover" "Key_Shared"

Responses

Request samples

Content type
application/json
[
  • "Exclusive"
]

Get the list of all the topics under a certain namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
query Parameters
mode
string
Default: "PERSISTENT"
Enum: "PERSISTENT" "NON_PERSISTENT" "ALL"

Responses

Response samples

Content type
application/json
[
  • "string"
]

Unload namespace

Unload an active namespace from the current broker serving it. Performing this operation will let the brokerremoves all producers, consumers, and connections using this namespace, and close all topics (includingtheir persistent store). During that operation, the namespace is marked as tentatively unavailable until thebroker completes the unloading action. This operation requires strictly super user privileges, since it wouldresult in non-persistent message loss and unexpected connection closure to the clients.

+
Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string

Responses

Unsubscribes the given subscription on all topics on a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
subscription
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Clear backlog for all topics on a namespace bundle.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
bundle
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Clear backlog for a given subscription on all topics on a namespace bundle.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
subscription
required
string
bundle
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Split a namespace bundle

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
bundle
required
string
query Parameters
authoritative
boolean
Default: false
unload
boolean
Default: false
splitAlgorithmName
string

Responses

Unload a namespace bundle

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
bundle
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Unsubscribes the given subscription on all topics on a namespace bundle.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
subscription
required
string
bundle
required
string
query Parameters
authoritative
boolean
Default: false

Responses

non-persistent topic

Get the list of non-persistent topics under a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
query Parameters
bundle
string

Specify the bundle name

+

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get the list of partitioned topics under a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get the list of non-persistent topics under a namespace bundle.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
bundle
required
string

Bundle range of a topic

+

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete a topic.

The topic cannot be deleted if delete is not forcefully and there's any active subscription or producer connected to the it. Force delete ignores connected clients and deletes topic by explicitly closing them.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
force
boolean
Default: false

Stop all producer/consumer/replicator and delete topic forcefully

+
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
deleteSchema
boolean
Default: false

Delete the topic's schema storage

+

Responses

Create a non-partitioned topic.

This is the only REST endpoint from which non-partitioned topics could be created.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Key value pair properties for the topic metadata

+
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Expiry messages on all subscriptions of topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
expireTimeInSeconds
required
integer <int32>
Default: 0

Expires beyond the specified number of seconds

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get estimated backlog for offline topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Response samples

Content type
application/json
{
  • "brokerName": "string",
  • "cursorDetails": {
    },
  • "dataLedgerDetails": [
    ],
  • "messageBacklog": 0,
  • "statGeneratedAt": "2019-08-24T14:15:22Z",
  • "storageSize": 0,
  • "topicName": "string",
  • "totalMessages": 0
}

Get backlog quota map on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
isGlobal
boolean
Default: false

Responses

Calculate backlog size by a message ID (in bytes).

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get the status of a compaction operation for a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Response samples

Content type
application/json
{
  • "lastError": "string",
  • "status": "NOT_RUN"
}

Trigger a compaction operation on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get compaction threshold configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Remove deduplication configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
authoritative
boolean
Default: false

Responses

Get deduplication configuration of a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set deduplication enabled on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

DeduplicationEnabled policies for the specified topic

+
boolean

Responses

Request samples

Content type
application/json
true

Set delayed delivery messages config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get delayed delivery messages config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set delayed delivery messages config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Delayed delivery policies for the specified topic

+
active
boolean
tickTime
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "tickTime": 0
}

Get dispatch rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Examine a specific message on a topic by position relative to the earliest or the latest message.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
initialPosition
string
Default: "latest"
Enum: "latest" "earliest"

Relative start position to examine message.It can be 'latest' or 'earliest'

+
messagePosition
integer <int64>
Default: 1

The position of messages (default 1)

+
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get inactive topic policies on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get the stored topic metadata.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get the internal stats for the topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
metadata
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "compactedLedger": {
    },
  • "currentLedgerEntries": 0,
  • "currentLedgerSize": 0,
  • "cursors": {
    },
  • "entriesAddedCounter": 0,
  • "lastConfirmedEntry": "string",
  • "lastLedgerCreatedTimestamp": "string",
  • "lastLedgerCreationFailureTimestamp": "string",
  • "ledgers": [
    ],
  • "numberOfEntries": 0,
  • "pendingAddEntriesCount": 0,
  • "schemaLedgers": [
    ],
  • "state": "string",
  • "totalSize": 0,
  • "waitingCursorsCount": 0
}

Return the last commit message id of topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get message by its messageId.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
ledgerId
required
integer <int64>

The ledger id

+
entryId
required
integer <int64>

The entry id

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get maxConsumers config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get max consumers per subscription configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Remove maxMessageSize config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get maxMessageSize config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set maxMessageSize config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

The max message size of the topic

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxProducers config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Remove maxSubscriptionsPerTopic config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get maxSubscriptionsPerTopic config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set maxSubscriptionsPerTopic config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

The max subscriptions of the topic

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get max unacked messages per consumer config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Delete max unacked messages per subscription config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get max unacked messages per subscription config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set max unacked messages per subscription config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Max unacked messages on subscription policies for the specified topic

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get message TTL in seconds for a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get message ID published at or just after this absolute timestamp (in ms).

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
timestamp
required
integer <int64>

Specify the timestamp

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Offload a prefix of a topic to long term storage

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Offload a prefix of a topic to long term storage

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get offload policies on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get the stats for the partitioned topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
perPartition
boolean
Default: true

Get per partition stats

+
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
getPreciseBacklog
boolean
Default: false

If return precise backlog or imprecise backlog

+
subscriptionBacklogSize
boolean
Default: false

If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.

+
getEarliestTimeInBacklog
boolean
Default: false

If return the earliest time in backlog

+

Responses

Delete a partitioned topic.

It will also delete all the partitions of the topic if it exists.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
force
boolean
Default: false

Stop all producer/consumer/replicator and delete topic forcefully

+
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
deleteSchema
boolean
Default: false

Delete the topic's schema storage

+

Responses

Get partitioned topic metadata.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
checkAllowAutoCreation
boolean
Default: false

Is check configuration required to automatically create topic

+

Responses

Increment partitions of an existing partitioned topic.

It only increments partitions of existing non-global partitioned-topic

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
updateLocalTopicOnly
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
force
boolean
Default: false
Request Body schema: application/json
required

The number of partitions for the topic

+
integer <int32>
Default: 0

Responses

Request samples

Content type
application/json
0
0

Create a partitioned topic.

It needs to be called before creating a producer on a partitioned topic.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
createLocalTopicOnly
boolean
Default: false
Request Body schema: application/vnd.partitioned-topic-metadata+json
required

The metadata for the topic

+
partitions
integer <int32>
object

Responses

Request samples

Content type
application/vnd.partitioned-topic-metadata+json
{
  • "partitions": 0,
  • "properties": {
    }
}

Get permissions on a topic.

Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at thenamespace level combined (union) with any eventual specific permission set on the topic.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Revoke permissions on a topic.

Revoke permissions to a role on a single topic. If the permission was not set at the topiclevel, but rather at the namespace level, this operation will return an error (HTTP status code 412).

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
role
required
string

Client role to which grant permissions

+

Responses

Grant a new permission to a role on a single topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
role
required
string

Client role to which grant permissions

+
Request Body schema: application/json

Actions to be granted (produce,functions,consume)

+
Array
string
Enum: "produce" "consume" "functions" "sources" "sinks" "packages"

Responses

Request samples

Content type
application/json
[
  • "produce"
]

Get topic properties.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get publish rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Remove the replication clusters from a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
backlogQuotaType
string
Enum: "destination_storage" "message_age"
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get the replication clusters for a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set the replication clusters for a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json
required

List of replication clusters

+
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Remove replicatorDispatchRate config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get replicatorDispatchRate config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set replicatorDispatchRate config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Replicator dispatch rate of the topic

+
dispatchThrottlingRateInByte
integer <int64>
dispatchThrottlingRateInMsg
integer <int32>
ratePeriodInSecond
integer <int32>
relativeToPublishRate
boolean

Responses

Request samples

Content type
application/json
{
  • "dispatchThrottlingRateInByte": 0,
  • "dispatchThrottlingRateInMsg": 0,
  • "ratePeriodInSecond": 0,
  • "relativeToPublishRate": true
}

Get retention configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Remove schema compatibility strategy on a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Strategy used to check the compatibility of new schema

+
string

Responses

Request samples

Content type
application/json
"string"

Get schema compatibility strategy on a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the cluster

+
topic
required
string

Specify topic name

+
query Parameters
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set schema compatibility strategy on a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Strategy used to check the compatibility of new schema

+
string

Responses

Request samples

Content type
application/json
"string"

Get the stats for the topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Is authentication required to perform this operation

+
getPreciseBacklog
boolean
Default: false

If return precise backlog or imprecise backlog

+
subscriptionBacklogSize
boolean
Default: false

If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.

+
getEarliestTimeInBacklog
boolean
Default: false

If return time of the earliest message in backlog

+

Responses

Response samples

Content type
application/json
{
  • "averageMsgSize": 0.1,
  • "backlogSize": 0,
  • "bytesInCounter": 0,
  • "bytesOutCounter": 0,
  • "compaction": {
    },
  • "deduplicationStatus": "string",
  • "earliestMsgPublishTimeInBacklogs": 0,
  • "msgChunkPublished": true,
  • "msgDropRate": 0.1,
  • "msgInCounter": 0,
  • "msgOutCounter": 0,
  • "msgRateIn": 0.1,
  • "msgRateOut": 0.1,
  • "msgThroughputIn": 0.1,
  • "msgThroughputOut": 0.1,
  • "nonContiguousDeletedMessagesRanges": 0,
  • "nonContiguousDeletedMessagesRangesSerializedSize": 0,
  • "offloadedStorageSize": 0,
  • "publishers": [
    ],
  • "replication": {
    },
  • "storageSize": 0,
  • "subscriptions": {
    },
  • "topicEpoch": 0,
  • "waitingPublishers": 0
}

Delete a subscription.

The subscription cannot be deleted if delete is not forcefully and there are any active consumers attached to it. Force delete ignores connected consumers and deletes subscription by explicitly closing them.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscription to be deleted

+
query Parameters
force
boolean
Default: false

Disconnect and close all consumers and delete subscription forcefully

+
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Expiry messages on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscription to be Expiry messages on

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

messageId to reset back to (ledgerId:entryId)

+
batchIndex
integer <int32>
entryId
integer <int64>
excluded
boolean
ledgerId
integer <int64>
partitionIndex
integer <int32>
object

Responses

Request samples

Content type
application/json
{
  • "batchIndex": 0,
  • "entryId": 0,
  • "excluded": true,
  • "ledgerId": 0,
  • "partitionIndex": 0,
  • "properties": {
    }
}

Expiry messages on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscription to be Expiry messages on

+
expireTimeInSeconds
required
integer <int32>
Default: 0

Expires beyond the specified number of seconds

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Peek nth message on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscribed message expired

+
messagePosition
required
integer <int32>
Default: 1

The number of messages (default 1)

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Replaces all the properties on the given subscription

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscription to update

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

The new properties

+
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get replicated subscription status on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Name of subscription

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Enable or disable a replicated subscription on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Name of subscription

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json
required

Whether to enable replicated subscription

+
boolean

Responses

Request samples

Content type
application/json
true

Reset subscription to message position closest to given position.

It fence cursor and disconnects all active consumers before reseting cursor.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscription to reset position on

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

messageId to reset back to (ledgerId:entryId)

+
batchIndex
integer <int32>
entryId
integer <int64>
excluded
boolean
ledgerId
integer <int64>
partitionIndex
integer <int32>
object

Responses

Request samples

Content type
application/json
{
  • "batchIndex": 0,
  • "entryId": 0,
  • "excluded": true,
  • "ledgerId": 0,
  • "partitionIndex": 0,
  • "properties": {
    }
}

Reset subscription to message position closest to absolute timestamp (in ms).

It fence cursor and disconnects all active consumers before reseting cursor.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscription to reset position on

+
timestamp
required
integer <int64>

the timestamp to reset back

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Skipping messages on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Name of subscription

+
numMessages
required
integer <int32>
Default: 0

The number of messages to skip

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Skip all messages on a topic subscription.

Completely clears the backlog on the subscription.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Name of subscription

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Create a subscription on the topic.

Creates a subscription on the topic at the specified message id

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subscriptionName
required
string

Subscription to create position on

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
replicated
boolean

Is replicated required to perform this operation

+
Request Body schema: application/json

messageId where to create the subscription. It can be 'latest', 'earliest' or (ledgerId:entryId)

+
batchIndex
integer <int32>
entryId
integer <int64>
excluded
boolean
ledgerId
integer <int64>
partitionIndex
integer <int32>
object

Responses

Request samples

Content type
application/json
{
  • "batchIndex": 0,
  • "entryId": 0,
  • "excluded": true,
  • "ledgerId": 0,
  • "partitionIndex": 0,
  • "properties": {
    }
}

Get subscription message dispatch rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Remove subscription types enabled for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get is enable sub type fors specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set is enable sub types for specified topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Enable sub types for the specified topic

+
Array
string
Enum: "Exclusive" "Shared" "Failover" "Key_Shared"

Responses

Request samples

Content type
application/json
[
  • "Exclusive"
]

Get the list of persistent subscriptions for a given topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Response samples

Content type
application/json
{ }

Terminate all partitioned topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Truncate a topic.

NonPersistentTopic does not support truncate.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Unload a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

persistent topic

Get the list of topics under a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
query Parameters
bundle
string

Specify the bundle name

+

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get the list of partitioned topics under a namespace.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete a topic.

The topic cannot be deleted if delete is not forcefully and there's any active subscription or producer connected to the it. Force delete ignores connected clients and deletes topic by explicitly closing them.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
force
boolean
Default: false

Stop all producer/consumer/replicator and delete topic forcefully

+
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
deleteSchema
boolean
Default: false

Delete the topic's schema storage

+

Responses

Create a non-partitioned topic.

This is the only REST endpoint from which non-partitioned topics could be created.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Key value pair properties for the topic metadata

+
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Expiry messages on all subscriptions of topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
expireTimeInSeconds
required
integer <int32>
Default: 0

Expires beyond the specified number of seconds

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get estimated backlog for offline topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Response samples

Content type
application/json
{
  • "brokerName": "string",
  • "cursorDetails": {
    },
  • "dataLedgerDetails": [
    ],
  • "messageBacklog": 0,
  • "statGeneratedAt": "2019-08-24T14:15:22Z",
  • "storageSize": 0,
  • "topicName": "string",
  • "totalMessages": 0
}

Get backlog quota map on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
isGlobal
boolean
Default: false

Responses

Calculate backlog size by a message ID (in bytes).

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get the status of a compaction operation for a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Response samples

Content type
application/json
{
  • "lastError": "string",
  • "status": "NOT_RUN"
}

Trigger a compaction operation on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get compaction threshold configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Create missed partitions of an existing partitioned topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+

Responses

Remove deduplication configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
authoritative
boolean
Default: false

Responses

Get deduplication configuration of a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set deduplication enabled on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

DeduplicationEnabled policies for the specified topic

+
boolean

Responses

Request samples

Content type
application/json
true

Set delayed delivery messages config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get delayed delivery messages config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set delayed delivery messages config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Delayed delivery policies for the specified topic

+
active
boolean
tickTime
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "tickTime": 0
}

Get dispatch rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Examine a specific message on a topic by position relative to the earliest or the latest message.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
initialPosition
string
Default: "latest"
Enum: "latest" "earliest"

Relative start position to examine message.It can be 'latest' or 'earliest'

+
messagePosition
integer <int64>
Default: 1

The position of messages (default 1)

+
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Delete inactive topic policies on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get inactive topic policies on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set inactive topic policies on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
isGlobal
boolean
Default: false
Request Body schema: application/json

inactive topic policies for the specified topic

+
deleteWhileInactive
boolean
inactiveTopicDeleteMode
string
Enum: "delete_when_no_subscriptions" "delete_when_subscriptions_caught_up"
maxInactiveDurationSeconds
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "deleteWhileInactive": true,
  • "inactiveTopicDeleteMode": "delete_when_no_subscriptions",
  • "maxInactiveDurationSeconds": 0
}

Get the stored topic metadata.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get the internal stats for the topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
metadata
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "compactedLedger": {
    },
  • "currentLedgerEntries": 0,
  • "currentLedgerSize": 0,
  • "cursors": {
    },
  • "entriesAddedCounter": 0,
  • "lastConfirmedEntry": "string",
  • "lastLedgerCreatedTimestamp": "string",
  • "lastLedgerCreationFailureTimestamp": "string",
  • "ledgers": [
    ],
  • "numberOfEntries": 0,
  • "pendingAddEntriesCount": 0,
  • "schemaLedgers": [
    ],
  • "state": "string",
  • "totalSize": 0,
  • "waitingCursorsCount": 0
}

Return the last commit message id of topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get message by its messageId.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
ledgerId
required
integer <int64>

The ledger id

+
entryId
required
integer <int64>

The entry id

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get maxConsumers config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get max consumers per subscription configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Remove maxMessageSize config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get maxMessageSize config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set maxMessageSize config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

The max message size of the topic

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get maxProducers config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Remove maxSubscriptionsPerTopic config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get maxSubscriptionsPerTopic config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set maxSubscriptionsPerTopic config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

The max subscriptions of the topic

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get max unacked messages per consumer config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Delete max unacked messages per subscription config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get max unacked messages per subscription config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set max unacked messages per subscription config on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Max unacked messages on subscription policies for the specified topic

+
integer <int32>

Responses

Request samples

Content type
application/json
0
0

Get message TTL in seconds for a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get message ID published at or just after this absolute timestamp (in ms).

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
timestamp
required
integer <int64>

Specify the timestamp

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Offload a prefix of a topic to long term storage

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Offload a prefix of a topic to long term storage

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get offload policies on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get the stats for the partitioned topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
perPartition
boolean
Default: true

Get per partition stats

+
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
getPreciseBacklog
boolean
Default: false

If return precise backlog or imprecise backlog

+
subscriptionBacklogSize
boolean
Default: false

If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.

+
getEarliestTimeInBacklog
boolean
Default: false

If return the earliest time in backlog

+

Responses

Delete a partitioned topic.

It will also delete all the partitions of the topic if it exists.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
force
boolean
Default: false

Stop all producer/consumer/replicator and delete topic forcefully

+
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
deleteSchema
boolean
Default: false

Delete the topic's schema storage

+

Responses

Get partitioned topic metadata.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
checkAllowAutoCreation
boolean
Default: false

Is check configuration required to automatically create topic

+

Responses

Increment partitions of an existing partitioned topic.

It only increments partitions of existing non-global partitioned-topic

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
updateLocalTopicOnly
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
force
boolean
Default: false
Request Body schema: application/json
required

The number of partitions for the topic

+
integer <int32>
Default: 0

Responses

Request samples

Content type
application/json
0
0

Create a partitioned topic.

It needs to be called before creating a producer on a partitioned topic.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
createLocalTopicOnly
boolean
Default: false
Request Body schema: application/vnd.partitioned-topic-metadata+json
required

The metadata for the topic

+
partitions
integer <int32>
object

Responses

Request samples

Content type
application/vnd.partitioned-topic-metadata+json
{
  • "partitions": 0,
  • "properties": {
    }
}

Get permissions on a topic.

Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at thenamespace level combined (union) with any eventual specific permission set on the topic.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Revoke permissions on a topic.

Revoke permissions to a role on a single topic. If the permission was not set at the topiclevel, but rather at the namespace level, this operation will return an error (HTTP status code 412).

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
role
required
string

Client role to which grant permissions

+

Responses

Grant a new permission to a role on a single topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
role
required
string

Client role to which grant permissions

+
Request Body schema: application/json

Actions to be granted (produce,functions,consume)

+
Array
string
Enum: "produce" "consume" "functions" "sources" "sinks" "packages"

Responses

Request samples

Content type
application/json
[
  • "produce"
]

Get topic properties.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get publish rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Remove the replication clusters from a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
backlogQuotaType
string
Enum: "destination_storage" "message_age"
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get the replication clusters for a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set the replication clusters for a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json
required

List of replication clusters

+
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Remove replicatorDispatchRate config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get replicatorDispatchRate config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set replicatorDispatchRate config for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Replicator dispatch rate of the topic

+
dispatchThrottlingRateInByte
integer <int64>
dispatchThrottlingRateInMsg
integer <int32>
ratePeriodInSecond
integer <int32>
relativeToPublishRate
boolean

Responses

Request samples

Content type
application/json
{
  • "dispatchThrottlingRateInByte": 0,
  • "dispatchThrottlingRateInMsg": 0,
  • "ratePeriodInSecond": 0,
  • "relativeToPublishRate": true
}

Remove retention configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get retention configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set retention configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
isGlobal
boolean
Default: false
Request Body schema: application/json

Retention policies for the specified namespace

+
retentionSizeInMB
integer <int64>
retentionTimeInMinutes
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "retentionSizeInMB": 0,
  • "retentionTimeInMinutes": 0
}

Remove schema compatibility strategy on a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Strategy used to check the compatibility of new schema

+
string

Responses

Request samples

Content type
application/json
"string"

Get schema compatibility strategy on a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the cluster

+
topic
required
string

Specify topic name

+
query Parameters
applied
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set schema compatibility strategy on a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Strategy used to check the compatibility of new schema

+
string

Responses

Request samples

Content type
application/json
"string"

Get the stats for the topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
getPreciseBacklog
boolean
Default: false

If return precise backlog or imprecise backlog

+
subscriptionBacklogSize
boolean
Default: false

If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.

+
getEarliestTimeInBacklog
boolean
Default: false

If return time of the earliest message in backlog

+

Responses

Response samples

Content type
application/json
{
  • "averageMsgSize": 0.1,
  • "backlogSize": 0,
  • "bytesInCounter": 0,
  • "bytesOutCounter": 0,
  • "compaction": {
    },
  • "deduplicationStatus": "string",
  • "earliestMsgPublishTimeInBacklogs": 0,
  • "msgChunkPublished": true,
  • "msgInCounter": 0,
  • "msgOutCounter": 0,
  • "msgRateIn": 0.1,
  • "msgRateOut": 0.1,
  • "msgThroughputIn": 0.1,
  • "msgThroughputOut": 0.1,
  • "nonContiguousDeletedMessagesRanges": 0,
  • "nonContiguousDeletedMessagesRangesSerializedSize": 0,
  • "offloadedStorageSize": 0,
  • "publishers": [
    ],
  • "replication": {
    },
  • "storageSize": 0,
  • "subscriptions": {
    },
  • "topicEpoch": 0,
  • "waitingPublishers": 0
}

Get subscribe rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Delete a subscription.

The subscription cannot be deleted if delete is not forcefully and there are any active consumers attached to it. Force delete ignores connected consumers and deletes subscription by explicitly closing them.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscription to be deleted

+
query Parameters
force
boolean
Default: false

Disconnect and close all consumers and delete subscription forcefully

+
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Expiry messages on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscription to be Expiry messages on

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

messageId to reset back to (ledgerId:entryId)

+
batchIndex
integer <int32>
entryId
integer <int64>
excluded
boolean
ledgerId
integer <int64>
partitionIndex
integer <int32>
object

Responses

Request samples

Content type
application/json
{
  • "batchIndex": 0,
  • "entryId": 0,
  • "excluded": true,
  • "ledgerId": 0,
  • "partitionIndex": 0,
  • "properties": {
    }
}

Expiry messages on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscription to be Expiry messages on

+
expireTimeInSeconds
required
integer <int32>
Default: 0

Expires beyond the specified number of seconds

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Peek nth message on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscribed message expired

+
messagePosition
required
integer <int32>
Default: 1

The number of messages (default 1)

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Replaces all the properties on the given subscription

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscription to update

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

The new properties

+
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get replicated subscription status on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Name of subscription

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Enable or disable a replicated subscription on a topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Name of subscription

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json
required

Whether to enable replicated subscription

+
boolean

Responses

Request samples

Content type
application/json
true

Reset subscription to message position closest to given position.

It fence cursor and disconnects all active consumers before reseting cursor.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscription to reset position on

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

messageId to reset back to (ledgerId:entryId)

+
batchIndex
integer <int32>
entryId
integer <int64>
excluded
boolean
ledgerId
integer <int64>
partitionIndex
integer <int32>
object

Responses

Request samples

Content type
application/json
{
  • "batchIndex": 0,
  • "entryId": 0,
  • "excluded": true,
  • "ledgerId": 0,
  • "partitionIndex": 0,
  • "properties": {
    }
}

Reset subscription to message position closest to absolute timestamp (in ms).

It fence cursor and disconnects all active consumers before reseting cursor.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Subscription to reset position on

+
timestamp
required
integer <int64>

the timestamp to reset back

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Skipping messages on a topic subscription.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Name of subscription

+
numMessages
required
integer <int32>
Default: 0

The number of messages to skip

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Skip all messages on a topic subscription.

Completely clears the backlog on the subscription.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subName
required
string

Name of subscription

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Create a subscription on the topic.

Creates a subscription on the topic at the specified message id

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
subscriptionName
required
string

Subscription to create position on

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
replicated
boolean

Is replicated required to perform this operation

+
Request Body schema: application/json

messageId where to create the subscription. It can be 'latest', 'earliest' or (ledgerId:entryId)

+
batchIndex
integer <int32>
entryId
integer <int64>
excluded
boolean
ledgerId
integer <int64>
partitionIndex
integer <int32>
object

Responses

Request samples

Content type
application/json
{
  • "batchIndex": 0,
  • "entryId": 0,
  • "excluded": true,
  • "ledgerId": 0,
  • "partitionIndex": 0,
  • "properties": {
    }
}

Get subscription message dispatch rate configuration for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
applied
boolean
Default: false
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Remove subscription types enabled for specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Get is enable sub type fors specified topic.

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Set is enable sub types for specified topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
isGlobal
boolean
Default: false
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+
Request Body schema: application/json

Enable sub types for the specified topic

+
Array
string
Enum: "Exclusive" "Shared" "Failover" "Key_Shared"

Responses

Request samples

Content type
application/json
[
  • "Exclusive"
]

Get the list of persistent subscriptions for a given topic.

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Response samples

Content type
application/json
{ }

Terminate all partitioned topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Truncate a topic.

The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers.

+
Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

Unload a topic

Authorizations:
Bearer
path Parameters
tenant
required
string

Specify the tenant

+
namespace
required
string

Specify the namespace

+
topic
required
string

Specify topic name

+
query Parameters
authoritative
boolean
Default: false

Whether leader broker redirected this call to this broker. For internal use.

+

Responses

resource-quotas

Get resource quota of a namespace bundle.

Authorizations:
Bearer
path Parameters
tenant
required
string

Tenant name

+
namespace
required
string

Namespace name within the specified tenant

+
bundle
required
string

Namespace bundle range

+

Responses

Response samples

Content type
application/json
{
  • "bandwidthIn": 0.1,
  • "bandwidthOut": 0.1,
  • "dynamic": true,
  • "memory": 0.1,
  • "msgRateIn": 0.1,
  • "msgRateOut": 0.1
}

resourcegroups

Get the list of all the resourcegroups.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete a resourcegroup.

Authorizations:
Bearer
path Parameters
resourcegroup
required
string

Responses

Get the rate limiters specified for a resourcegroup.

Authorizations:
Bearer
path Parameters
resourcegroup
required
string

Responses

Response samples

Content type
application/json
{
  • "dispatchRateInBytes": 0,
  • "dispatchRateInMsgs": 0,
  • "publishRateInBytes": 0,
  • "publishRateInMsgs": 0
}

Creates a new resourcegroup with the specified rate limiters

Authorizations:
Bearer
path Parameters
resourcegroup
required
string
Request Body schema: application/json

Rate limiters for the resourcegroup

+
dispatchRateInBytes
integer <int64>
dispatchRateInMsgs
integer <int32>
publishRateInBytes
integer <int64>
publishRateInMsgs
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "dispatchRateInBytes": 0,
  • "dispatchRateInMsgs": 0,
  • "publishRateInBytes": 0,
  • "publishRateInMsgs": 0
}

schemas

test the schema compatibility

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false
Request Body schema: application/json

A JSON value presenting a schema payload. An example of the expected schema can be found down here.

+
object
schema
string
type
string

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "compatibility": true,
  • "schemaCompatibilityStrategy": "string"
}

Delete the schema of a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "version": 0
}

Get the schema of a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "properties": {
    },
  • "timestamp": 0,
  • "type": "NONE",
  • "version": 0
}

Update the schema of a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false
Request Body schema: application/json

A JSON value presenting a schema payload. An example of the expected schema can be found down here.

+
object
schema
string
type
string

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "version": { }
}

Get the schema of a topic at a given version

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
version
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "properties": {
    },
  • "timestamp": 0,
  • "type": "NONE",
  • "version": 0
}

Get the all schemas of a topic

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "getSchemaResponses": [
    ]
}

get the version of the schema

Authorizations:
Bearer
path Parameters
tenant
required
string
namespace
required
string
topic
required
string
query Parameters
authoritative
boolean
Default: false
Request Body schema: application/json

A JSON value presenting a schema payload. An example of the expected schema can be found down here.

+
object
schema
string
type
string

Responses

Request samples

Content type
application/json
Example
null

Response samples

Content type
application/json
{
  • "version": 0
}

tenants

Get the admin configuration for a given tenant.

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant name

+

Responses

Get metrics for all functions owned by worker

Requested should be executed by Monitoring agent on each worker to fetch the metrics

+
Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets the metrics for Monitoring

Request should be executed by Monitoring agent on each worker to fetch the worker-metrics

+
Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetches information about which Pulsar Functions are assigned to which Pulsar clusters

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Fetches information about the Pulsar cluster running Pulsar Functions

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetches info about the leader node of the Pulsar cluster running Pulsar Functions

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "port": 0,
  • "workerHostname": "string",
  • "workerId": "string"
}

Checks if this node is the leader and is ready to service requests

Authorizations:
Bearer

Responses

Fetches a list of supported Pulsar IO connectors currently running in cluster mode

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • { }
]

Get the status of any ongoing drain operation at this worker

Authorizations:
Bearer

Responses

Drains this worker, i.e., moves its work-assignments to other workers

Authorizations:
Bearer

Responses

Get the status of any ongoing drain operation at the specified worker

Authorizations:
Bearer
query Parameters
workerId
string

Responses

Drains the specified worker, i.e., moves its work-assignments to other workers

Authorizations:
Bearer
query Parameters
workerId
string

Responses

Triggers a rebalance of functions to workers

Authorizations:
Bearer

Responses

functions

Fetches a list of supported Pulsar IO connectors currently running in cluster mode Deprecated

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • { }
]

Lists all Pulsar Functions currently deployed in a given namespace

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+

Responses

Response samples

Content type
application/json
"string"

Deletes a Pulsar Function currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+

Responses

Fetches information about a Pulsar Function currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+

Responses

Response samples

Content type
application/json
{
  • "autoAck": true,
  • "batchBuilder": "string",
  • "className": "string",
  • "cleanupSubscription": true,
  • "customRuntimeOptions": "string",
  • "customSchemaInputs": {
    },
  • "customSchemaOutputs": {
    },
  • "customSerdeInputs": {
    },
  • "deadLetterTopic": "string",
  • "exposePulsarAdminClientEnabled": true,
  • "forwardSourceMessageProperty": true,
  • "fqfn": "string",
  • "go": "string",
  • "inputSpecs": {
    },
  • "inputs": [
    ],
  • "jar": "string",
  • "logTopic": "string",
  • "maxMessageRetries": 0,
  • "maxPendingAsyncRequests": 0,
  • "name": "string",
  • "namespace": "string",
  • "output": "string",
  • "outputSchemaType": "string",
  • "outputSerdeClassName": "string",
  • "parallelism": 0,
  • "processingGuarantees": "ATLEAST_ONCE",
  • "producerConfig": {
    },
  • "py": "string",
  • "resources": {
    },
  • "retainKeyOrdering": true,
  • "retainOrdering": true,
  • "runtime": "JAVA",
  • "runtimeFlags": "string",
  • "secrets": {
    },
  • "subName": "string",
  • "subscriptionPosition": "Latest",
  • "tenant": "string",
  • "timeoutMs": 0,
  • "topicsPattern": "string",
  • "userConfig": {
    },
  • "windowConfig": {
    }
}

Creates a new Pulsar Function in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+
Request Body schema:

You can submit a function (in any languages that you are familiar with) +" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK">

You can submit a function (in any languages that you are familiar with) to a Pulsar cluster. Follow the steps below.

  1. Create a JSON object using some of the following parameters. @@ -4730,21 +4731,21 @@
    1. Encapsulate the JSON object to a multipart object.
    -
autoAck
boolean
batchBuilder
string
className
string
cleanupSubscription
boolean
customRuntimeOptions
string
object
object
object
deadLetterTopic
string
exposePulsarAdminClientEnabled
boolean
forwardSourceMessageProperty
boolean
fqfn
string
go
string
object
inputs
Array of strings
jar
string
logTopic
string
maxMessageRetries
integer <int32>
maxPendingAsyncRequests
integer <int32>
name
string
namespace
string
output
string
outputSchemaType
string
outputSerdeClassName
string
parallelism
integer <int32>
processingGuarantees
string
Enum: "ATLEAST_ONCE" "ATMOST_ONCE" "EFFECTIVELY_ONCE"
object (ProducerConfig)
py
string
object (Resources)
retainKeyOrdering
boolean
retainOrdering
boolean
runtime
string
Enum: "JAVA" "PYTHON" "GO"
runtimeFlags
string
object
subName
string
subscriptionPosition
string
Enum: "Latest" "Earliest"
tenant
string
timeoutMs
integer <int64>
topicsPattern
string
object
object (WindowConfig)

Responses

Request samples

Content type
No sample

Updates a Pulsar Function currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-
Request Body schema:
autoAck
boolean
batchBuilder
string
className
string
cleanupSubscription
boolean
customRuntimeOptions
string
object
object
object
deadLetterTopic
string
exposePulsarAdminClientEnabled
boolean
forwardSourceMessageProperty
boolean
fqfn
string
go
string
object
inputs
Array of strings
jar
string
logTopic
string
maxMessageRetries
integer <int32>
maxPendingAsyncRequests
integer <int32>
name
string
namespace
string
output
string
outputSchemaType
string
outputSerdeClassName
string
parallelism
integer <int32>
processingGuarantees
string
Enum: "ATLEAST_ONCE" "ATMOST_ONCE" "EFFECTIVELY_ONCE"
object (ProducerConfig)
py
string
object (Resources)
retainKeyOrdering
boolean
retainOrdering
boolean
runtime
string
Enum: "JAVA" "PYTHON" "GO"
runtimeFlags
string
object
subName
string
subscriptionPosition
string
Enum: "Latest" "Earliest"
tenant
string
timeoutMs
integer <int64>
topicsPattern
string
object
object (WindowConfig)

Responses

Request samples

Content type
No sample

Updates a Pulsar Function currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+
Request Body schema:

A JSON value presenting configuration payload of a Pulsar Function. An example of the expected Pulsar Function can be found here.

+" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK">

A JSON value presenting configuration payload of a Pulsar Function. An example of the expected Pulsar Function can be found here.

  • autoAck Whether or not the framework acknowledges messages automatically.
    • @@ -4864,301 +4865,301 @@
  • cleanupSubscription Whether the subscriptions of a Pulsar Function created or used should be deleted when the Pulsar Function is deleted.
-
autoAck
boolean
batchBuilder
string
className
string
cleanupSubscription
boolean
customRuntimeOptions
string
object
object
object
deadLetterTopic
string
exposePulsarAdminClientEnabled
boolean
forwardSourceMessageProperty
boolean
fqfn
string
go
string
object
inputs
Array of strings
jar
string
logTopic
string
maxMessageRetries
integer <int32>
maxPendingAsyncRequests
integer <int32>
name
string
namespace
string
output
string
outputSchemaType
string
outputSerdeClassName
string
parallelism
integer <int32>
processingGuarantees
string
Enum: "ATLEAST_ONCE" "ATMOST_ONCE" "EFFECTIVELY_ONCE"
object (ProducerConfig)
py
string
object (Resources)
retainKeyOrdering
boolean
retainOrdering
boolean
runtime
string
Enum: "JAVA" "PYTHON" "GO"
runtimeFlags
string
object
subName
string
subscriptionPosition
string
Enum: "Latest" "Earliest"
tenant
string
timeoutMs
integer <int64>
topicsPattern
string
object
object (WindowConfig)

Responses

Request samples

Content type
No sample

Restart all instances of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-

Responses

Start all instances of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-

Responses

Displays the stats of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-

Responses

Response samples

Content type
application/json
{
  • "1min": {
    },
  • "avgProcessLatency": 0.1,
  • "instances": [
    ],
  • "lastInvocation": 0,
  • "processedSuccessfullyTotal": 0,
  • "receivedTotal": 0,
  • "systemExceptionsTotal": 0,
  • "userExceptionsTotal": 0
}

Displays the status of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-

Responses

Response samples

Content type
application/json
{
  • "instances": [
    ],
  • "numInstances": 0,
  • "numRunning": 0
}

Stop all instances of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-

Responses

Triggers a Pulsar Function with a user-specified value or file data

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-
Request Body schema: multipart/form-data

The value with which you want to trigger the Pulsar Function

-
string

Responses

Response samples

Content type
application/json
{
  • "brokerPublishTime": 0,
  • "data": [
    ],
  • "encryptionCtx": {
    },
  • "eventTime": 0,
  • "index": 0,
  • "key": "string",
  • "keyBytes": [
    ],
  • "messageId": { },
  • "orderingKey": [
    ],
  • "producerName": "string",
  • "properties": {
    },
  • "publishTime": 0,
  • "readerSchema": {
    },
  • "redeliveryCount": 0,
  • "replicated": true,
  • "replicatedFrom": "string",
  • "schemaVersion": [
    ],
  • "sequenceId": 0,
  • "topicName": "string",
  • "value": { }
}

Restart an instance of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-
instanceId
required
string

The instanceId of a Pulsar Function (if instance-id is not provided, all instances are restarted

-

Responses

Start an instance of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-
instanceId
required
string

The instanceId of a Pulsar Function (if instance-id is not provided, all instances sre started.

-

Responses

Displays the stats of a Pulsar Function instance

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-
instanceId
required
string

The instanceId of a Pulsar Function (if instance-id is not provided, the stats of all instances is returned

-

Responses

Response samples

Content type
application/json
{
  • "1min": {
    },
  • "avgProcessLatency": 0.1,
  • "lastInvocation": 0,
  • "processedSuccessfullyTotal": 0,
  • "receivedTotal": 0,
  • "systemExceptionsTotal": 0,
  • "userExceptionsTotal": 0,
  • "userMetrics": {
    }
}

Displays the status of a Pulsar Function instance

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-
instanceId
required
string

The instanceId of a Pulsar Function (if instance-id is not provided, the stats of all instances is returned

-

Responses

Response samples

Content type
application/json
{
  • "averageLatency": 0.1,
  • "error": "string",
  • "lastInvocationTime": 0,
  • "latestSystemExceptions": [
    ],
  • "latestUserExceptions": [
    ],
  • "numReceived": 0,
  • "numRestarts": 0,
  • "numSuccessfullyProcessed": 0,
  • "numSystemExceptions": 0,
  • "numUserExceptions": 0,
  • "running": true,
  • "workerId": "string"
}

Stop an instance of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

-
namespace
required
string

The namespace of a Pulsar Function

-
functionName
required
string

The name of a Pulsar Function

-
instanceId
required
string

The instanceId of a Pulsar Function (if instance-id is not provided, all instances are stopped.

-

Responses

packages

Get all the specified type packages in a namespace.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "contact": "string",
  • "createTime": 0,
  • "description": "string",
  • "modificationTime": 0,
  • "properties": {
    }
}

Get all the versions of a package.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string
packageName
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete a package with the package name.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string
packageName
required
string
version
required
string

Responses

Download a package with the package name.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string
packageName
required
string
version
required
string

Responses

Response samples

Content type
application/json
{ }

Upload a package.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string
packageName
required
string
version
required
string

Responses

Get the metadata of a package.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string
packageName
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "contact": "string",
  • "createTime": 0,
  • "description": "string",
  • "modificationTime": 0,
  • "properties": {
    }
}

Update the metadata of a package.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string
packageName
required
string
version
required
string

Responses

sinks

Fetches the list of built-in Pulsar IO sinks

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lists all Pulsar Sinks currently deployed in a given namespace

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-

Responses

Response samples

Content type
application/json
"string"

Deletes a Pulsar Sink currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-
sinkName
required
string

The name of a Pulsar Sink

-

Responses

Fetches information about a Pulsar Sink currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-
sinkName
required
string

The name of a Pulsar Sink

-

Responses

Response samples

Content type
application/json
{
  • "archive": "string",
  • "autoAck": true,
  • "className": "string",
  • "cleanupSubscription": true,
  • "configs": {
    },
  • "customRuntimeOptions": "string",
  • "deadLetterTopic": "string",
  • "inputSpecs": {
    },
  • "inputs": [
    ],
  • "maxMessageRetries": 0,
  • "name": "string",
  • "namespace": "string",
  • "negativeAckRedeliveryDelayMs": 0,
  • "parallelism": 0,
  • "processingGuarantees": "ATLEAST_ONCE",
  • "resources": {
    },
  • "retainKeyOrdering": true,
  • "retainOrdering": true,
  • "runtimeFlags": "string",
  • "secrets": {
    },
  • "sourceSubscriptionName": "string",
  • "sourceSubscriptionPosition": "Latest",
  • "tenant": "string",
  • "timeoutMs": 0,
  • "topicToSchemaProperties": {
    },
  • "topicToSchemaType": {
    },
  • "topicToSerdeClassName": {
    },
  • "topicsPattern": "string"
}

Creates a new Pulsar Sink in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-
sinkName
required
string

The name of a Pulsar Sink

-
Request Body schema:
autoAck
boolean
batchBuilder
string
className
string
cleanupSubscription
boolean
customRuntimeOptions
string
object
object
object
deadLetterTopic
string
exposePulsarAdminClientEnabled
boolean
forwardSourceMessageProperty
boolean
fqfn
string
go
string
object
inputs
Array of strings
jar
string
logTopic
string
maxMessageRetries
integer <int32>
maxPendingAsyncRequests
integer <int32>
name
string
namespace
string
output
string
outputSchemaType
string
outputSerdeClassName
string
parallelism
integer <int32>
processingGuarantees
string
Enum: "ATLEAST_ONCE" "ATMOST_ONCE" "EFFECTIVELY_ONCE"
object (ProducerConfig)
py
string
object (Resources)
retainKeyOrdering
boolean
retainOrdering
boolean
runtime
string
Enum: "JAVA" "PYTHON" "GO"
runtimeFlags
string
object
subName
string
subscriptionPosition
string
Enum: "Latest" "Earliest"
tenant
string
timeoutMs
integer <int64>
topicsPattern
string
object
object (WindowConfig)

Responses

Request samples

Content type
No sample

Restart all instances of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+

Responses

Start all instances of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+

Responses

Displays the stats of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+

Responses

Response samples

Content type
application/json
{
  • "1min": {
    },
  • "avgProcessLatency": 0.1,
  • "instances": [
    ],
  • "lastInvocation": 0,
  • "processedSuccessfullyTotal": 0,
  • "receivedTotal": 0,
  • "systemExceptionsTotal": 0,
  • "userExceptionsTotal": 0
}

Displays the status of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+

Responses

Response samples

Content type
application/json
{
  • "instances": [
    ],
  • "numInstances": 0,
  • "numRunning": 0
}

Stop all instances of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+

Responses

Triggers a Pulsar Function with a user-specified value or file data

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+
Request Body schema: multipart/form-data

The value with which you want to trigger the Pulsar Function

+
string

Responses

Response samples

Content type
application/json
{
  • "brokerPublishTime": 0,
  • "data": [
    ],
  • "encryptionCtx": {
    },
  • "eventTime": 0,
  • "index": 0,
  • "key": "string",
  • "keyBytes": [
    ],
  • "messageId": { },
  • "orderingKey": [
    ],
  • "producerName": "string",
  • "properties": {
    },
  • "publishTime": 0,
  • "readerSchema": {
    },
  • "redeliveryCount": 0,
  • "replicated": true,
  • "replicatedFrom": "string",
  • "schemaVersion": [
    ],
  • "sequenceId": 0,
  • "topicName": "string",
  • "value": { }
}

Restart an instance of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+
instanceId
required
string

The instanceId of a Pulsar Function (if instance-id is not provided, all instances are restarted

+

Responses

Start an instance of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+
instanceId
required
string

The instanceId of a Pulsar Function (if instance-id is not provided, all instances sre started.

+

Responses

Displays the stats of a Pulsar Function instance

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+
instanceId
required
string

The instanceId of a Pulsar Function (if instance-id is not provided, the stats of all instances is returned

+

Responses

Response samples

Content type
application/json
{
  • "1min": {
    },
  • "avgProcessLatency": 0.1,
  • "lastInvocation": 0,
  • "processedSuccessfullyTotal": 0,
  • "receivedTotal": 0,
  • "systemExceptionsTotal": 0,
  • "userExceptionsTotal": 0,
  • "userMetrics": {
    }
}

Displays the status of a Pulsar Function instance

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+
instanceId
required
string

The instanceId of a Pulsar Function (if instance-id is not provided, the stats of all instances is returned

+

Responses

Response samples

Content type
application/json
{
  • "averageLatency": 0.1,
  • "error": "string",
  • "lastInvocationTime": 0,
  • "latestSystemExceptions": [
    ],
  • "latestUserExceptions": [
    ],
  • "numReceived": 0,
  • "numRestarts": 0,
  • "numSuccessfullyProcessed": 0,
  • "numSystemExceptions": 0,
  • "numUserExceptions": 0,
  • "running": true,
  • "workerId": "string"
}

Stop an instance of a Pulsar Function

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Function

+
namespace
required
string

The namespace of a Pulsar Function

+
functionName
required
string

The name of a Pulsar Function

+
instanceId
required
string

The instanceId of a Pulsar Function (if instance-id is not provided, all instances are stopped.

+

Responses

packages

Get all the specified type packages in a namespace.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "contact": "string",
  • "createTime": 0,
  • "description": "string",
  • "modificationTime": 0,
  • "properties": {
    }
}

Get all the versions of a package.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string
packageName
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete a package with the package name.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string
packageName
required
string
version
required
string

Responses

Download a package with the package name.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string
packageName
required
string
version
required
string

Responses

Response samples

Content type
application/json
{ }

Upload a package.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string
packageName
required
string
version
required
string

Responses

Get the metadata of a package.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string
packageName
required
string
version
required
string

Responses

Response samples

Content type
application/json
{
  • "contact": "string",
  • "createTime": 0,
  • "description": "string",
  • "modificationTime": 0,
  • "properties": {
    }
}

Update the metadata of a package.

Authorizations:
Bearer
path Parameters
type
required
string
tenant
required
string
namespace
required
string
packageName
required
string
version
required
string

Responses

sinks

Fetches the list of built-in Pulsar IO sinks

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lists all Pulsar Sinks currently deployed in a given namespace

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+

Responses

Response samples

Content type
application/json
"string"

Deletes a Pulsar Sink currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+
sinkName
required
string

The name of a Pulsar Sink

+

Responses

Fetches information about a Pulsar Sink currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+
sinkName
required
string

The name of a Pulsar Sink

+

Responses

Response samples

Content type
application/json
{
  • "archive": "string",
  • "autoAck": true,
  • "className": "string",
  • "cleanupSubscription": true,
  • "configs": {
    },
  • "customRuntimeOptions": "string",
  • "deadLetterTopic": "string",
  • "inputSpecs": {
    },
  • "inputs": [
    ],
  • "maxMessageRetries": 0,
  • "name": "string",
  • "namespace": "string",
  • "negativeAckRedeliveryDelayMs": 0,
  • "parallelism": 0,
  • "processingGuarantees": "ATLEAST_ONCE",
  • "resources": {
    },
  • "retainKeyOrdering": true,
  • "retainOrdering": true,
  • "runtimeFlags": "string",
  • "secrets": {
    },
  • "sourceSubscriptionName": "string",
  • "sourceSubscriptionPosition": "Latest",
  • "tenant": "string",
  • "timeoutMs": 0,
  • "topicToSchemaProperties": {
    },
  • "topicToSchemaType": {
    },
  • "topicToSerdeClassName": {
    },
  • "topicsPattern": "string"
}

Creates a new Pulsar Sink in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+
sinkName
required
string

The name of a Pulsar Sink

+
Request Body schema:

You can submit a sink (in any languages that you are familiar with) to a Pulsar cluster. Follow the steps below.

+" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK">

You can submit a sink (in any languages that you are familiar with) to a Pulsar cluster. Follow the steps below.

  1. Create a JSON object using some of the following parameters. A JSON value presenting config payload of a Pulsar Sink. All available configuration options are:
    2. @@ -5254,23 +5255,23 @@
    1. Encapsulate the JSON object to a multipart object.
    -
archive
string
autoAck
boolean
className
string
cleanupSubscription
boolean
object
customRuntimeOptions
string
deadLetterTopic
string
object
inputs
Array of strings
maxMessageRetries
integer <int32>
name
string
namespace
string
negativeAckRedeliveryDelayMs
integer <int64>
parallelism
integer <int32>
processingGuarantees
string
Enum: "ATLEAST_ONCE" "ATMOST_ONCE" "EFFECTIVELY_ONCE"
object (Resources)
retainKeyOrdering
boolean
retainOrdering
boolean
runtimeFlags
string
object
sourceSubscriptionName
string
sourceSubscriptionPosition
string
Enum: "Latest" "Earliest"
tenant
string
timeoutMs
integer <int64>
object
object
object
topicsPattern
string

Responses

Request samples

Content type
No sample

Updates a Pulsar Sink currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-
sinkName
required
string

The name of a Pulsar Sink

-
Request Body schema:
archive
string
autoAck
boolean
className
string
cleanupSubscription
boolean
object
customRuntimeOptions
string
deadLetterTopic
string
object
inputs
Array of strings
maxMessageRetries
integer <int32>
name
string
namespace
string
negativeAckRedeliveryDelayMs
integer <int64>
parallelism
integer <int32>
processingGuarantees
string
Enum: "ATLEAST_ONCE" "ATMOST_ONCE" "EFFECTIVELY_ONCE"
object (Resources)
retainKeyOrdering
boolean
retainOrdering
boolean
runtimeFlags
string
object
sourceSubscriptionName
string
sourceSubscriptionPosition
string
Enum: "Latest" "Earliest"
tenant
string
timeoutMs
integer <int64>
object
object
object
topicsPattern
string

Responses

Request samples

Content type
No sample

Updates a Pulsar Sink currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+
sinkName
required
string

The name of a Pulsar Sink

+
Request Body schema:

A JSON value presenting config payload of a Pulsar Sink. All available configuration options are:

+" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK">

A JSON value presenting config payload of a Pulsar Sink. All available configuration options are:

  • classname The class name of a Pulsar Sink if archive is file-url-path (file://)
    • @@ -5352,225 +5353,225 @@
  • runtimeFlags Any flags that you want to pass to the runtime as a single string
-
archive
string
autoAck
boolean
className
string
cleanupSubscription
boolean
object
customRuntimeOptions
string
deadLetterTopic
string
object
inputs
Array of strings
maxMessageRetries
integer <int32>
name
string
namespace
string
negativeAckRedeliveryDelayMs
integer <int64>
parallelism
integer <int32>
processingGuarantees
string
Enum: "ATLEAST_ONCE" "ATMOST_ONCE" "EFFECTIVELY_ONCE"
object (Resources)
retainKeyOrdering
boolean
retainOrdering
boolean
runtimeFlags
string
object
sourceSubscriptionName
string
sourceSubscriptionPosition
string
Enum: "Latest" "Earliest"
tenant
string
timeoutMs
integer <int64>
object
object
object
topicsPattern
string

Responses

Request samples

Content type
No sample

Restart all instances of a Pulsar Sink

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-
sinkName
required
string

The name of a Pulsar Sink

-

Responses

Start all instances of a Pulsar Sink

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-
sinkName
required
string

The name of a Pulsar Sink

-

Responses

Displays the status of a Pulsar Sink running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-
sinkName
required
string

The name of a Pulsar Sink

-

Responses

Response samples

Content type
application/json
{
  • "instances": [
    ],
  • "numInstances": 0,
  • "numRunning": 0
}

Stop all instances of a Pulsar Sink

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-
sinkName
required
string

The name of a Pulsar Sink

-

Responses

Restart an instance of a Pulsar Sink

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-
sinkName
required
string

The name of a Pulsar Sink

-
instanceId
required
string

The instanceId of a Pulsar Sink

-

Responses

Start an instance of a Pulsar Sink

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-
sinkName
required
string

The name of a Pulsar Sink

-
instanceId
required
string

The instanceId of a Pulsar Sink

-

Responses

Displays the status of a Pulsar Sink instance

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-
sinkName
required
string

The name of a Pulsar Sink

-
instanceId
required
string

The instanceId of a Pulsar Sink

-

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "lastReceivedTime": 0,
  • "latestSinkExceptions": [
    ],
  • "latestSystemExceptions": [
    ],
  • "numReadFromPulsar": 0,
  • "numRestarts": 0,
  • "numSinkExceptions": 0,
  • "numSystemExceptions": 0,
  • "numWrittenToSink": 0,
  • "running": true,
  • "workerId": "string"
}

Stop an instance of a Pulsar Sink

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

-
namespace
required
string

The namespace of a Pulsar Sink

-
sinkName
required
string

The name of a Pulsar Sink

-
instanceId
required
string

The instanceId of a Pulsar Sink

-

Responses

sources

Fetches the list of built-in Pulsar IO sources

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lists all Pulsar Sources currently deployed in a given namespace

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-

Responses

Response samples

Content type
application/json
"string"

Deletes a Pulsar Source currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-
sourceName
required
string

The name of a Pulsar Source

-

Responses

Fetches information about a Pulsar Source currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-
sourceName
required
string

The name of a Pulsar Source

-

Responses

Response samples

Content type
application/json
{
  • "archive": "string",
  • "batchBuilder": "string",
  • "batchSourceConfig": {
    },
  • "className": "string",
  • "configs": {
    },
  • "customRuntimeOptions": "string",
  • "name": "string",
  • "namespace": "string",
  • "parallelism": 0,
  • "processingGuarantees": "ATLEAST_ONCE",
  • "producerConfig": {
    },
  • "resources": {
    },
  • "runtimeFlags": "string",
  • "schemaType": "string",
  • "secrets": {
    },
  • "serdeClassName": "string",
  • "tenant": "string",
  • "topicName": "string"
}

Creates a new Pulsar Source in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-
sourceName
required
string

The name of a Pulsar Source

-
Request Body schema:
archive
string
autoAck
boolean
className
string
cleanupSubscription
boolean
object
customRuntimeOptions
string
deadLetterTopic
string
object
inputs
Array of strings
maxMessageRetries
integer <int32>
name
string
namespace
string
negativeAckRedeliveryDelayMs
integer <int64>
parallelism
integer <int32>
processingGuarantees
string
Enum: "ATLEAST_ONCE" "ATMOST_ONCE" "EFFECTIVELY_ONCE"
object (Resources)
retainKeyOrdering
boolean
retainOrdering
boolean
runtimeFlags
string
object
sourceSubscriptionName
string
sourceSubscriptionPosition
string
Enum: "Latest" "Earliest"
tenant
string
timeoutMs
integer <int64>
object
object
object
topicsPattern
string

Responses

Request samples

Content type
No sample

Restart all instances of a Pulsar Sink

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+
sinkName
required
string

The name of a Pulsar Sink

+

Responses

Start all instances of a Pulsar Sink

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+
sinkName
required
string

The name of a Pulsar Sink

+

Responses

Displays the status of a Pulsar Sink running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+
sinkName
required
string

The name of a Pulsar Sink

+

Responses

Response samples

Content type
application/json
{
  • "instances": [
    ],
  • "numInstances": 0,
  • "numRunning": 0
}

Stop all instances of a Pulsar Sink

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+
sinkName
required
string

The name of a Pulsar Sink

+

Responses

Restart an instance of a Pulsar Sink

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+
sinkName
required
string

The name of a Pulsar Sink

+
instanceId
required
string

The instanceId of a Pulsar Sink

+

Responses

Start an instance of a Pulsar Sink

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+
sinkName
required
string

The name of a Pulsar Sink

+
instanceId
required
string

The instanceId of a Pulsar Sink

+

Responses

Displays the status of a Pulsar Sink instance

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+
sinkName
required
string

The name of a Pulsar Sink

+
instanceId
required
string

The instanceId of a Pulsar Sink

+

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "lastReceivedTime": 0,
  • "latestSinkExceptions": [
    ],
  • "latestSystemExceptions": [
    ],
  • "numReadFromPulsar": 0,
  • "numRestarts": 0,
  • "numSinkExceptions": 0,
  • "numSystemExceptions": 0,
  • "numWrittenToSink": 0,
  • "running": true,
  • "workerId": "string"
}

Stop an instance of a Pulsar Sink

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Sink

+
namespace
required
string

The namespace of a Pulsar Sink

+
sinkName
required
string

The name of a Pulsar Sink

+
instanceId
required
string

The instanceId of a Pulsar Sink

+

Responses

sources

Fetches the list of built-in Pulsar IO sources

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lists all Pulsar Sources currently deployed in a given namespace

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+

Responses

Response samples

Content type
application/json
"string"

Deletes a Pulsar Source currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+
sourceName
required
string

The name of a Pulsar Source

+

Responses

Fetches information about a Pulsar Source currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+
sourceName
required
string

The name of a Pulsar Source

+

Responses

Response samples

Content type
application/json
{
  • "archive": "string",
  • "batchBuilder": "string",
  • "batchSourceConfig": {
    },
  • "className": "string",
  • "configs": {
    },
  • "customRuntimeOptions": "string",
  • "name": "string",
  • "namespace": "string",
  • "parallelism": 0,
  • "processingGuarantees": "ATLEAST_ONCE",
  • "producerConfig": {
    },
  • "resources": {
    },
  • "runtimeFlags": "string",
  • "schemaType": "string",
  • "secrets": {
    },
  • "serdeClassName": "string",
  • "tenant": "string",
  • "topicName": "string"
}

Creates a new Pulsar Source in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+
sourceName
required
string

The name of a Pulsar Source

+
Request Body schema:

You can submit a source (in any languages that you are familiar with) to a Pulsar cluster. Follow the steps below.

+" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK">

You can submit a source (in any languages that you are familiar with) to a Pulsar cluster. Follow the steps below.

  1. Create a JSON object using some of the following parameters. A JSON value presenting configuration payload of a Pulsar Source. An example of the expected functions can be found here.
    2. @@ -5634,23 +5635,23 @@
    1. Encapsulate the JSON object to a multipart object.
    -
archive
string
batchBuilder
string
object (BatchSourceConfig)
className
string
object
customRuntimeOptions
string
name
string
namespace
string
parallelism
integer <int32>
processingGuarantees
string
Enum: "ATLEAST_ONCE" "ATMOST_ONCE" "EFFECTIVELY_ONCE"
object (ProducerConfig)
object (Resources)
runtimeFlags
string
schemaType
string
object
serdeClassName
string
tenant
string
topicName
string

Responses

Request samples

Content type
No sample

Updates a Pulsar Source currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-
sourceName
required
string

The name of a Pulsar Source

-
Request Body schema:
archive
string
batchBuilder
string
object (BatchSourceConfig)
className
string
object
customRuntimeOptions
string
name
string
namespace
string
parallelism
integer <int32>
processingGuarantees
string
Enum: "ATLEAST_ONCE" "ATMOST_ONCE" "EFFECTIVELY_ONCE"
object (ProducerConfig)
object (Resources)
runtimeFlags
string
schemaType
string
object
serdeClassName
string
tenant
string
topicName
string

Responses

Request samples

Content type
No sample

Updates a Pulsar Source currently running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+
sourceName
required
string

The name of a Pulsar Source

+
Request Body schema:

A JSON value presenting configuration payload of a Pulsar Source. An example of the expected functions can be found here.

+" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK">

A JSON value presenting configuration payload of a Pulsar Source. An example of the expected functions can be found here.

  • classname The class name of a Pulsar Source if archive is file-url-path (file://).
    • @@ -5700,155 +5701,155 @@
  • runtimeFlags Any flags that you want to pass to the runtime.
-
archive
string
batchBuilder
string
object (BatchSourceConfig)
className
string
object
customRuntimeOptions
string
name
string
namespace
string
parallelism
integer <int32>
processingGuarantees
string
Enum: "ATLEAST_ONCE" "ATMOST_ONCE" "EFFECTIVELY_ONCE"
object (ProducerConfig)
object (Resources)
runtimeFlags
string
schemaType
string
object
serdeClassName
string
tenant
string
topicName
string

Responses

Request samples

Content type
No sample

Restart all instances of a Pulsar Source

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-
sourceName
required
string

The name of a Pulsar Source

-

Responses

Start all instances of a Pulsar Source

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-
sourceName
required
string

The name of a Pulsar Source

-

Responses

Displays the status of a Pulsar Source running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-
sourceName
required
string

The name of a Pulsar Source

-

Responses

Response samples

Content type
application/json
{
  • "instances": [
    ],
  • "numInstances": 0,
  • "numRunning": 0
}

Stop all instances of a Pulsar Source

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-
sourceName
required
string

The name of a Pulsar Source

-

Responses

Restart an instance of a Pulsar Source

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-
sourceName
required
string

The name of a Pulsar Source

-
instanceId
required
string

The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).

-

Responses

Start an instance of a Pulsar Source

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-
sourceName
required
string

The name of a Pulsar Source

-
instanceId
required
string

The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).

-

Responses

Displays the status of a Pulsar Source instance

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-
sourceName
required
string

The name of a Pulsar Source

-
instanceId
required
string

The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).

-

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "lastReceivedTime": 0,
  • "latestSourceExceptions": [
    ],
  • "latestSystemExceptions": [
    ],
  • "numReceivedFromSource": 0,
  • "numRestarts": 0,
  • "numSourceExceptions": 0,
  • "numSystemExceptions": 0,
  • "numWritten": 0,
  • "running": true,
  • "workerId": "string"
}

Stop instance of a Pulsar Source

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

-
namespace
required
string

The namespace of a Pulsar Source

-
sourceName
required
string

The name of a Pulsar Source

-
instanceId
required
string

The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).

-

Responses

+
archive
string
batchBuilder
string
object (BatchSourceConfig)
className
string
object
customRuntimeOptions
string
name
string
namespace
string
parallelism
integer <int32>
processingGuarantees
string
Enum: "ATLEAST_ONCE" "ATMOST_ONCE" "EFFECTIVELY_ONCE"
object (ProducerConfig)
object (Resources)
runtimeFlags
string
schemaType
string
object
serdeClassName
string
tenant
string
topicName
string

Responses

Request samples

Content type
No sample

Restart all instances of a Pulsar Source

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+
sourceName
required
string

The name of a Pulsar Source

+

Responses

Start all instances of a Pulsar Source

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+
sourceName
required
string

The name of a Pulsar Source

+

Responses

Displays the status of a Pulsar Source running in cluster mode

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+
sourceName
required
string

The name of a Pulsar Source

+

Responses

Response samples

Content type
application/json
{
  • "instances": [
    ],
  • "numInstances": 0,
  • "numRunning": 0
}

Stop all instances of a Pulsar Source

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+
sourceName
required
string

The name of a Pulsar Source

+

Responses

Restart an instance of a Pulsar Source

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+
sourceName
required
string

The name of a Pulsar Source

+
instanceId
required
string

The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).

+

Responses

Start an instance of a Pulsar Source

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+
sourceName
required
string

The name of a Pulsar Source

+
instanceId
required
string

The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).

+

Responses

Displays the status of a Pulsar Source instance

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+
sourceName
required
string

The name of a Pulsar Source

+
instanceId
required
string

The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).

+

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "lastReceivedTime": 0,
  • "latestSourceExceptions": [
    ],
  • "latestSystemExceptions": [
    ],
  • "numReceivedFromSource": 0,
  • "numRestarts": 0,
  • "numSourceExceptions": 0,
  • "numSystemExceptions": 0,
  • "numWritten": 0,
  • "running": true,
  • "workerId": "string"
}

Stop instance of a Pulsar Source

Authorizations:
Bearer
path Parameters
tenant
required
string

The tenant of a Pulsar Source

+
namespace
required
string

The namespace of a Pulsar Source

+
sourceName
required
string

The name of a Pulsar Source

+
instanceId
required
string

The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).

+

Responses