Get a Tenant's Notification Profile

GET 
/api/cloud/2.0/agg/notifications/profiles/:notification-profile-id

Overview

Get the notification profile associated with the current tenant.

Pass the notification profile Id as path param

The current tenant TSG Id is obtained from the user JWT.

This is a per-tenant query.

Request

Path Parameters

notification-profile-id stringrequired

Responses

200

OK

application/json

Schema

Schema

id string

Notification Profile Id

profileName stringrequired

Notification Profile Name

description string

Notification Profile Description

opState stringrequired

Possible values: [ENABLED, DISABLED]

Notification Profile Operational State

status stringrequired

Notification Profile Status

tenantList string[]required

Input Tenant List

excludeTenantList string[]

List of excluded tenants

notifTypeDetails object[]required
Notification Type Detail
Array [
type stringrequired
Possible values: [INCIDENTS, UPGRADES, ANNOUNCEMENTS]
Notification Type
notifCategoryList object[]required
List of notification type categories
Array [
name stringrequired
Notification type category name
bestPractice booleanrequired
Best practice flag for category
subCategoryList object[]required
List of notification type sub-categories
Array [
name stringrequired
Notification type sub-category name
bestPractice booleanrequired
Best practice flag for sub-category
needLicense booleanrequired
Need license flag for sub-category
]
]
]
notifChannels object[]required
Notification Channel List
Array [
name stringrequired
Notification channel name
type stringrequired
Possible values: [EMAIL, WEBHOOK]
Notification channel type
emailChannelDetails object
Email channel details
property name* EmailChannelDetails
emails object[]required
List of emails
Array [
name stringrequired
Email owner name
emailId stringrequired
Email id
]
webhookChannelDetails object
Webhook channel details
property name* WebhookChannelDetails
urls string[]required
List of Webhook URLs - do not include token in the URL
authType stringrequired
Possible values: [NO_AUTH, TOKEN]
Webhook Authentication Type
token stringrequired
Webhook token value
template object
Channel output template
name string
Output channel template name
templateJson string
JSON describing the output channel template
]
successTenant string[]

List of child tenants that got the incident profile

failureTenant string[]

List of child tenants that didn't get the incident profile

Example (from schema)

{
  "id": "string",
  "profileName": "string",
  "description": "string",
  "opState": "ENABLED",
  "status": "string",
  "tenantList": [
    "string"
  ],
  "excludeTenantList": [
    "string"
  ],
  "notifTypeDetails": [
    {
      "type": "INCIDENTS",
      "notifCategoryList": [
        {
          "name": "string",
          "bestPractice": true,
          "subCategoryList": [
            {
              "name": "string",
              "bestPractice": true,
              "needLicense": true
            }
          ]
        }
      ]
    }
  ],
  "notifChannels": [
    {
      "name": "string",
      "type": "EMAIL",
      "emailChannelDetails": {},
      "webhookChannelDetails": {},
      "template": {
        "name": "string",
        "templateJson": "string"
      }
    }
  ],
  "successTenant": [
    "string"
  ],
  "failureTenant": [
    "string"
  ]
}

Example

{
  "data": {
    "description": "Upgrades Notification Profile",
    "excludeTenantList": [],
    "successTenant": [],
    "failureTenant": [],
    "status": "SUCCESS",
    "id": "9a71cf75-4266-4e63-bcd0-5e9a2ede13a8",
    "notifChannels": [
      {
        "name": "Webhook Channel",
        "type": "WEBHOOK",
        "webhookChannelDetails": {
          "urls": [
            "www.test-3.webhook.com",
            "https://webhook.site/0b168876-c339-45d5-babe-c49bb02c35e6"
          ],
          "authType": "NO_AUTH"
        }
      },
      {
        "emailChannelDetails": {
          "emails": [
            {
              "emailId": "new@email.com",
              "name": "new@email.com"
            },
            {
              "emailId": "swamiananthawork@gmail.com",
              "name": "Swami Work"
            },
            {
              "emailId": "dummy.email@gmail2.com",
              "name": "Dummy email"
            },
            {
              "emailId": "prad.bapat@gmail.com",
              "name": "Pradnya Bapat"
            },
            {
              "emailId": "zdfgdsfg@vsfgv.sdf",
              "name": "zdfgdsfg@vsfgv.sdf"
            }
          ]
        },
        "name": "Email Channel",
        "type": "EMAIL"
      }
    ],
    "notifTypeDetails": [
      {
        "notifCategoryList": [
          {
            "bestPractice": false,
            "name": "Dataplane",
            "subCategoryList": [
              {
                "bestPractice": false,
                "name": "Other Updates"
              },
              {
                "bestPractice": false,
                "name": "Postponed"
              },
              {
                "bestPractice": true,
                "name": "Error"
              },
              {
                "bestPractice": true,
                "name": "Completed"
              },
              {
                "bestPractice": false,
                "name": "Rolled back"
              }
            ]
          }
        ],
        "type": "UPGRADES"
      }
    ],
    "opState": "ENABLED",
    "profileName": "Upgrades_Profile",
    "tenantList": [
      "1444672864",
      "1750393864",
      "1034376033",
      "1611363357",
      "1213310096",
      "1797990641"
    ]
  },
  "requestId": "0cbf27c6-7539-41e8-aa88-0ca05d9f7375"
}

404

Not Found

application/json

Schema

Schema

object

Example (from schema)

{}

Example

{
  "error": {
    "errorCode": 60004,
    "errorType": "VALIDATION_ERROR",
    "httpStatus": 404,
    "msg": "Notification Profile not found"
  },
  "requestId": "61e29573-8df8-4423-af60-a88f1ee86950"
}

Loading...