Create Alert Rule Set

Create Alert Rule Set

Use this endpoint to create alert rule set for an organisation
Authorized Roles : PROVIDER or ORG_ADMIN

Request
URI
POST
https://{api_host}/provider/orgs/{id}/alert-rule-set
COPY
Path Parameters
string
id
Required

ID of the Organisation


Request Body
AlertRuleSetDto of type(s) application/json
Required
{
    "id": "string",
    "orgName": "string",
    "name": "string",
    "instanceCount": 0,
    "lastModifiedUserEmail": "string",
    "lastModifiedTime": "string",
    "orgId": "string",
    "alertRuleSetExpressions": [
        {
            "id": "string",
            "alertRuleSetId": "string",
            "alertRuleType": {
                "alertRuleTypeId": "string",
                "name": "string",
                "status": "string",
                "targetType": "string",
                "metricType": "string",
                "metricKey": "string",
                "alertType": "string"
            },
            "criticalExpression": "string",
            "warningExpression": "string",
            "criticalLastsFor": 0,
            "warningLastsFor": 0
        }
    ],
    "default": false,
    "links": [
        {
            "rel": "string",
            "href": "string",
            "hreflang": "string",
            "media": "string",
            "title": "string",
            "type": "string",
            "deprecation": "string",
            "profile": "string",
            "name": "string"
        }
    ]
}
string As uuid As uuid
id
Optional

id

string
orgName
Optional

orgName

string
name
Required

name

integer As int64 As int64
instanceCount
Optional

instanceCount

string
lastModifiedUserEmail
Optional

lastModifiedUserEmail

string As date-time As date-time
lastModifiedTime
Optional

lastModifiedTime

string As uuid As uuid
orgId
Optional

orgId

alertRuleSetExpressions
Required

alertRuleSetExpressions

boolean
default
Optional

default

array of Link
links
Optional

links

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns AlertRuleSetDto of type(s) application/vnd.vmware.dms-v1+json
{
    "id": "string",
    "orgName": "string",
    "name": "string",
    "instanceCount": 0,
    "lastModifiedUserEmail": "string",
    "lastModifiedTime": "string",
    "orgId": "string",
    "alertRuleSetExpressions": [
        {
            "id": "string",
            "alertRuleSetId": "string",
            "alertRuleType": {
                "alertRuleTypeId": "string",
                "name": "string",
                "status": "string",
                "targetType": "string",
                "metricType": "string",
                "metricKey": "string",
                "alertType": "string"
            },
            "criticalExpression": "string",
            "warningExpression": "string",
            "criticalLastsFor": 0,
            "warningLastsFor": 0
        }
    ],
    "default": false,
    "links": [
        {
            "rel": "string",
            "href": "string",
            "hreflang": "string",
            "media": "string",
            "title": "string",
            "type": "string",
            "deprecation": "string",
            "profile": "string",
            "name": "string"
        }
    ]
}
string As uuid As uuid
id
Optional

id

string
orgName
Optional

orgName

string
name
Required

name

integer As int64 As int64
instanceCount
Optional

instanceCount

string
lastModifiedUserEmail
Optional

lastModifiedUserEmail

string As date-time As date-time
lastModifiedTime
Optional

lastModifiedTime

string As uuid As uuid
orgId
Optional

orgId

alertRuleSetExpressions
Required

alertRuleSetExpressions

boolean
default
Optional

default

array of Link
links
Optional

links


400

Bad Request

Operation doesn't return any data structure