{"type":"api","title":"Get Subscription","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/80d47b4b-45fb-3fe5-9677-6b13ca96ca96","info":{"title":"External Kafka/gRPC Subscription APIs","description":"External Kafka/gRPC subscription APIs exposed by Notification service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.2.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/Notification/extrnl-kafka-v2-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/crosswork/notification/v2","description":"Generated server url"}]},"spec":{"tags":["External Kafka/gRPC Subscription"],"summary":"Get Subscription","operationId":"getAllSubscription","responses":{"200":{"description":"Success with response message-body","content":{"application/json":{"schema":{"type":"object","description":"This is a wrapper of SubscriptionDTO","properties":{"subscriptionList":{"uniqueItems":true,"type":"array","description":"Collection of SubscriptionDTO","items":{"type":"object","description":"This is a record of subscription","required":["destinationName","destinationType","topicName"],"properties":{"destinationName":{"type":"string","description":"The destination name created as part of Data Gateways destination UI/API"},"destinationType":{"type":"string","description":"The type of destination, (possible values [Kafka])"},"filter":{"type":["string","null"],"description":"This field is optional. (Only supported for Inventory & Performance) Inventory : Filter based on Device type. E.g \"filter\": \"Routers/Cisco 1000 Series Routers/Cisco 1004 Router\" Performance : Filter based on Policy type & Policy Instance (Policy name)E.g \"filter\": \"policy_type=OpticalSFP, policy_instance=instance1"},"topicName":{"type":"string","description":"Topic name to be subscribed for"},"subscriptionData":{"type":["string","null"],"description":"For Device_Performance_Monitoring: possible values [policy_type=, policy_instance=], For Network_Performance_Monitoring: possible values [SR_PM_Interface, SR_PM_Policy], For Service_Health_Monitoring: possible values [Y1731_Probes, PCA_Probes]"},"subscriptionDataType":{"type":"string","description":"The type of data subscribed for, (possible values [Inventory_Changes, Alarm, System_Audit, Device_Performance_Monitoring, Network_Performance_Monitoring, Service_Health_Monitoring])"}},"$$ref":"#/components/schemas/SubscriptionDTO"}}},"$$ref":"#/components/schemas/SubscriptionListDTO"},"examples":{"example":{"summary":"Sample response","value":{"subscriptionList":[{"createTime":"Thu Sep 11 06:06:07 UTC 2025","destinationName":"kafkadest","destinationType":"Kafka","filter":null,"topicName":"audit123","subscriptionData":null,"subscriptionDataType":"System_Audit","userName":"admin"}]},"$$ref":"#/components/examples/GetSubscription"}}}}},"400":{"description":"Bad Request - Invalid request"},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"500":{"description":"Internal Server Error - operation-failed"}},"method":"get","path":"/subscription"}}