Search Results

TIBCO Cloud™ Messaging Admin REST API

Contents

Introduction

The TIBCO Cloud™ Messaging Administration REST API provides information and management access to supported messaging services.

Authorization

A TIBCO Cloud OAuth To authorize, use the access token prefixed with the word Bearer, as the value of the Authorization header. For example, Bearer TG9yZW0gaXBzdW0gZG9sciBzaXI=.

Throttling

Only a limited number of Admin REST API can be made within a period of time. When a request is throttled a (429) too many requests error will be returned.

Regional URLs

  • North America (west) - https://messaging.cloud.tibco.com/tcm/v1
  • North America (east) - https://us-east.messaging.cloud.tibco.com/tcm/v1
  • Europe - https://eu.messaging.cloud.tibco.com/tcm/v1
  • APJ - https://au.messaging.cloud.tibco.com/tcm/v1

TIBCO Cloud API UI

An interactive view of the TIBCO Cloud™ Messaging Administration REST API is available through a regional TIBCO Cloud API UI:

Reference

Source: swagger.json

REST API Groups

Plan

Method URL Summary
GET /plan Get plan details, e.g. subscription ID, plan type, and capabilities.

Roles

Method URL Summary
GET /roles Get the list of roles for a subscription.
POST /roles Create a new role for the subscription.
GET /roles/{Name} Get a specific role using the role name.
DELETE /roles/{Name} Delete a specific role using the role name.
GET /roles/{Name}/config Gets a config file using the default channel.
GET /roles/{Name}/config/{Channel} Gets a config file using a specific channel.

FTL and eFTL

Method URL Summary
GET /system Get the summary, clients, and durable stats for FTL and eFTL.
GET /system/durables Get the stats for FTL and eFTL durables.
GET /system/eftl/clients Get the stats of the connected eFTL clients.
GET /system/summary Get a summary of FTL and eFTL operations.

EMS

Method URL Summary
GET /system/ems Get system info for TIBCO Enterprise Message Service.
GET /system/ems/configuration/bridges Get the list of bridges.
POST /system/ems/configuration/bridges Create a new bridge from source to target destination.
GET /system/ems/configuration/bridges/source-queue/{SourceName} Get bridge configuration of the source queue.
DELETE /system/ems/configuration/bridges/source-queue/{SourceName}/target-queue/{TargetName} Delete the bridge from source queue to target queue.
DELETE /system/ems/configuration/bridges/source-queue/{SourceName}/target-topic/{TargetName} Delete the bridge from source queue to target topic.
GET /system/ems/configuration/bridges/source-topic/{SourceName} Get bridge configuration of the source topic.
DELETE /system/ems/configuration/bridges/source-topic/{SourceName}/target-queue/{TargetName} Delete the bridge from source topic to target queue.
DELETE /system/ems/configuration/bridges/source-topic/{SourceName}/target-topic/{TargetName} Delete the bridge from source topic to target topic.
GET /system/ems/queues Get the list of queues.
POST /system/ems/queues Create a static queue.
GET /system/ems/queues/{Pattern}/list Get information about all queues that match the naming pattern.
GET /system/ems/queues/{Queue} Get information about the given queue.
PUT /system/ems/queues/{Queue} Set all destination properties of a queue.
DELETE /system/ems/queues/{Queue} Delete the given queue.
GET /system/ems/topics Get the list of topics.
POST /system/ems/topics Create a static topic.
GET /system/ems/topics/{Pattern}/list Get information about all topics that match the naming pattern.
GET /system/ems/topics/{Topic} Get information about the given topic.
PUT /system/ems/topics/{Topic} Set all destination properties of a topic.
DELETE /system/ems/topics/{Topic} Delete the given topic.

Pulsar

Method URL Summary
GET /system/pulsar Get a summary of the current Pulsar usage and the list of namespaces.
GET /system/pulsar/namespaces Get the list of namespaces.
GET /system/pulsar/summary Get a summary of the current Pulsar usage.

Pulsar Topics

Method URL Summary
GET /system/pulsar/namespaces/{Ns}/topics Get the list of active topics. The content of the list updates every 60 seconds.
GET /system/pulsar/persistent/{Ns} Get the list of persistent topics.
GET /system/pulsar/persistent/{Ns}/partitioned Get the list of partitioned persistent topics.
DELETE /system/pulsar/persistent/{Ns}/{Topic} Delete a persistent topic.
GET /system/pulsar/persistent/{Ns}/{Topic}/partitioned-stats Get statistics for a partitioned persistent topic.
PUT /system/pulsar/persistent/{Ns}/{Topic}/partitions Create a partitioned persistent topic.
DELETE /system/pulsar/persistent/{Ns}/{Topic}/partitions Delete a partitioned persistent topic.
GET /system/pulsar/persistent/{Ns}/{Topic}/stats Get statistics for a persistent topic.
PUT /system/pulsar/persistent/{Ns}/{Topic}/subscription/{Subscription} Create a subscription on a persistent topic.
DELETE /system/pulsar/persistent/{Ns}/{Topic}/subscription/{Subscription} Delete a subscription on a persistent topic.
POST /system/pulsar/persistent/{Ns}/{Topic}/terminate/partitions Terminate all partitions on a persistent topic.

Pulsar Non-Persistent Topics

Method URL Summary
GET /system/pulsar/non-persistent/{Ns} Get the list of non-persistent topics.
GET /system/pulsar/non-persistent/{Ns}/partitioned Get the list of partitioned non-persistent topics.
DELETE /system/pulsar/non-persistent/{Ns}/{Topic} Delete a non-persistent topic.
GET /system/pulsar/non-persistent/{Ns}/{Topic}/partitioned-stats Get statistics for a partitioned non-persistent topic.
PUT /system/pulsar/non-persistent/{Ns}/{Topic}/partitions Create a partitioned non-persistent topic.
DELETE /system/pulsar/non-persistent/{Ns}/{Topic}/partitions Delete a partitioned non-persistent topic.
GET /system/pulsar/non-persistent/{Ns}/{Topic}/stats Gets statistics for a non-persistent topic.
DELETE /system/pulsar/non-persistent/{Ns}/{Topic}/subscription/{Subscription} Delete a subscription on a non-persistent topic.

Pulsar Schemas

Method URL Summary
GET /system/pulsar/schemas/{Ns}/{Topic}/schema Get the schema of a topic.
POST /system/pulsar/schemas/{Ns}/{Topic}/schema Update the schema of a topic.
DELETE /system/pulsar/schemas/{Ns}/{Topic}/schema Delete the schema of a topic.