Get the topic details

This endpoint is used to get the topic details.

URL

https://{{HOST}}/udp/topic/{topicName}

Method

GET

Required IMS Scopes

  • apollo_read

URL Path Variable

Name Description Example Type
topicName
required		 topic name /topic/temperature string

Request Header Parameters

Type Value Description
Authentication
required		 Bearer {access_token} IMS access token

Example

Request

curl -X GET 
  'https://{{HOST}}/udp/topic/temperature' 
  -H 'Authorization: Bearer {access_token}'

Response

{
    "topicName": "temperature",
    "partitions": 1,
    "replications": 1,
    "messagetypeIds": [
        "temperature_sensor",
        "high_temperature_alarm"
    ],
    "createdBy": "Apollo.testUser1",
    "updatedBy": "Apollo.testUser1",
    "isActive": "true"
}

Errors

Code Description
400 The request could not be understood by the server due to malformed syntax.
403 The request can not be processed if token is not valid or expired.