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

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"
}