Search Results

Admin REST API

The Admin REST API is an interface for information and management of a subscription and not a messaging API. It displays curated output from the various TIBCO Cloud Messaging components, such as eFTL clients, durable information, and plan usage rates. It is not a messaging publish/subscribe (pub/sub) API.

Base URLs

Use the URL specific to your location. The URLs are:

Region Base URL
North America https://messaging.cloud.tibco.com/tcm/v1
Europe https://eu.messaging.cloud.tibco.com/tcm/v1
APJ https://au.messaging.cloud.tibco.com/tcm/v1

Creating an OAuth Token

A TIBCO Cloud OAuth token is required to call the REST API. Each OAuth token is user-specific. Once created, securely save the token to use again.

Note: When creating the OAuth token ensure that you check the Messaging checkbox or the token will not work.

For information on how to acquire a token see: OAuth Access Tokens

Using an OAuth Token

To use a token, use cURL to make a request to the API using the following example. Replace <your_oauth_token> with the token you received.

curl 'https://messaging.cloud.tibco.com/tcm/v1/system' --header 'Authorization: Bearer <your_oauth_token>'

API Specification

APIs represent the current state of the subscription and are useful for keeping track of resources.

Method URI Description
GET /tcm/v1/system Get the current state of the summary, durable, and client information.
GET /tcm/v1/system/summary Get a summary of counters.
GET /tcm/v1/system/durables Get a list of persistence durables with associated matchers created by clients.
GET /tcm/v1/system/eftl/client Get the list of connected eFTL clients and their subscriptions.

Throttling

Servers hosting the Admin REST API use a throttling mechanism to manage system resources.

If a request is throttled, a 429 - too many requests error is returned.

Output

All output from this API is a valid JSON object.

Errors

This REST API returns the following status codes, and will include a JSON

HTTP Status Code Reason Description
200 OK Success.
401 Unauthorized Authentication was invalid.
404 Not found API or resource does not exist.
429 Too many requests API access for this subscription is throttled.
500 Internal server error An error occurred when processing the request.

Example Error JSON

Too Many Requests Error example:

{
  	  "error": {	
   	     "code": 429,
 	     "message": "Too Many Requests"
    }
}