Sign in
Messaging Interface

Subscribe to a topic

Subscribes to a specified topic

post/api/v1/messaging/subscribe

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

namestring required

Name of the subscription

destinationNamestring required

Name of the destination (topic or queue) for subscription

namedSubscriptionstring

Name of the named subscription, if any

filterstring

Filter expression using JMS selector syntax

maxDepthinteger

Maximum depth of messages queued for the subscription

retainMessageboolean

Should the message be retained on the destination

Response

Subscribed to topic successfully

string required

Changes

No recorded changes to this operation across all 1 revision of this API.