listNotificationProfiles
This API is used to list all the Notification Profiles created in OpManager.
HTTP Method
GETAPI URL
https://localhost:8060/api/json/admin/listNotificationProfiles?apiKey=***************&isGlobal=true&profileFilter=All&deviceName=devicenameParameters
| Param Name | Description | Data Type | Allowed Values / Regex | Is Mandatory |
|---|---|---|---|---|
| apiKey | API key used to authenticate and access your OpManager server. | String | - | Yes |
| isGlobal | Boolean flag indicating whether to fetch only global profiles. true- Lists only global profiles. false- Lists all device-specific profiles. | Boolean | Allowed values: trueor false | No |
| profileFilter | Specifies the filter used to list profiles based on the action type. | String | Allowed values: All, Send Email, Send SMS, Run Program, Webhook, Log a Ticket, Chat, Send Trap, Syslog | No |
| deviceName | Specifies the name of the device to check which global profiles are associated with it. Can be retrieved using the API: listDevices. If a profile is associated, the hasAssociatedfield in the response will be true. | String | - | No |
| groupName | Specifies the name of the device group, if profiles are queried based on a specific group. Can be retrieved using the API: listDeviceGroups. | String | Allowed values: Any valid device group name (supports alphanumeric text and symbols). | No |
| profileAssociationType | Defines the type of association between profiles and devices or groups. Can be verified from the API response of listNotificationProfiles. | String | Allowed values: MANUAL, BY_DEVICE_GROUP, BY_INTERFACE_GROUP | No |
Sample Response
HTTP Code: 200
[ { "profileName": "Play Sound", "hasSubProfiles": false, "profileType": "Run Program", "profileLabel": "Run Program", "profileID": "1", "hasCriteria": false, "isDevice": false, "status": "true"}, { "profileName": "testProfile", "hasSubProfiles": false, "profileType": "Send Email", "profileLabel": "Send Email", "profileID": "301", "isDevice": false, "hasAssociated": true, "status": "true"}]Error Response
View common error responsesRate limit: 50 requests per minute. Exceeding this limit will block requests for 5 minutes