List Alert Rule

GET 
/projects/:projectId/providers/Aruba.Insight/alertRules

List Alert Rule

Request

Path Parameters

projectId stringrequired
Default value: *

Query Parameters

filter string
sort string
projection string
offset int32
limit int32
serviceTypology string
Default value:
serviceName string
Default value:
api-version string
The requested API version
Default value: 1.0

Responses

200

Success

text/plain

Schema

Schema

total int64
self stringnullable
prev stringnullable
next stringnullable
first stringnullable
last stringnullable

values

object[]

nullable

Array [

id stringnullable

alertModel

object

labels

object

nullable

property name* string

annotations

object

nullable

property name* string

startsAt stringnullable

endsAt stringnullable

generatorURL stringnullable

status

object

inhibitedBy undefined[]nullable

silencedBy undefined[]nullable

state stringnullable

fingerprint stringnullable

webhook

object

url stringnullable

request

object

name stringnullable

tags string[]nullable

description stringnullable

username stringnullable

tenant stringnullable

company stringnullable

serviceCategory stringnullable

serviceTypology stringnullable

clusterTypology stringnullable

cluster stringnullable

clustername stringnullable

nodePool stringnullable

serviceNumber int32nullable

resourceId string[]nullable

resourceName string[]nullable

resourceTypology stringnullable

vdc stringnullable

vm string[]nullable

metric stringnullable

lastReception date-timenullable

lastActivation date-timenullable

creationDatetime date-timenullable

lastEdit date-timenullable

deletionDate date-timenullable

rule stringnullable

theshold int64nullable

um stringnullable

duration stringnullable

state stringnullable

email booleannullable

emailValue stringnullable

sms booleannullable

smsValue stringnullable

panel booleannullable

hidden booleannullable

alertActions

object[]

nullable

Array [

actionType ActionType (string)

Possible values: [NotificationPanel, SendEmail, SendSms, AutoscalingDbaas]

parameters

object

nullable

property name* string

]

resourceVersion stringnullable

resourceUid stringnullable

actions

object[]

nullable

Array [

key stringnullable

disabled booleannullable

executable booleannullable

]

lastReception stringnullable

lastActivation stringnullable

lastEdit stringnullable

]

metadata

object

data

object[]

nullable

Array [

type stringnullable

values string[]nullable

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "id": "string",
      "alertModel": {
        "labels": {},
        "annotations": {},
        "startsAt": "string",
        "endsAt": "string",
        "generatorURL": "string",
        "status": {
          "inhibitedBy": [
            null
          ],
          "silencedBy": [
            null
          ],
          "state": "string"
        },
        "fingerprint": "string",
        "webhook": {
          "url": "string"
        }
      },
      "request": {
        "name": "string",
        "tags": [
          "string"
        ],
        "description": "string",
        "username": "string",
        "tenant": "string",
        "company": "string",
        "serviceCategory": "string",
        "serviceTypology": "string",
        "clusterTypology": "string",
        "cluster": "string",
        "clustername": "string",
        "nodePool": "string",
        "serviceNumber": 0,
        "resourceId": [
          "string"
        ],
        "resourceName": [
          "string"
        ],
        "resourceTypology": "string",
        "vdc": "string",
        "vm": [
          "string"
        ],
        "metric": "string",
        "lastReception": "2024-07-29T15:51:28.071Z",
        "lastActivation": "2024-07-29T15:51:28.071Z",
        "creationDatetime": "2024-07-29T15:51:28.071Z",
        "lastEdit": "2024-07-29T15:51:28.071Z",
        "deletionDate": "2024-07-29T15:51:28.071Z",
        "rule": "string",
        "theshold": 0,
        "um": "string",
        "duration": "string",
        "state": "string",
        "email": true,
        "emailValue": "string",
        "sms": true,
        "smsValue": "string",
        "panel": true,
        "hidden": true,
        "alertActions": [
          {
            "actionType": "NotificationPanel",
            "parameters": {}
          }
        ]
      },
      "resourceVersion": "string",
      "resourceUid": "string",
      "actions": [
        {
          "key": "string",
          "disabled": true,
          "executable": true
        }
      ],
      "lastReception": "string",
      "lastActivation": "string",
      "lastEdit": "string"
    }
  ],
  "metadata": {
    "data": [
      {
        "type": "string",
        "values": [
          "string"
        ]
      }
    ]
  }
}

application/json

Schema

Schema

total int64
self stringnullable
prev stringnullable
next stringnullable
first stringnullable
last stringnullable

values

object[]

nullable

Array [

id stringnullable

alertModel

object

labels

object

nullable

property name* string

annotations

object

nullable

property name* string

startsAt stringnullable

endsAt stringnullable

generatorURL stringnullable

status

object

inhibitedBy undefined[]nullable

silencedBy undefined[]nullable

state stringnullable

fingerprint stringnullable

webhook

object

url stringnullable

request

object

name stringnullable

tags string[]nullable

description stringnullable

username stringnullable

tenant stringnullable

company stringnullable

serviceCategory stringnullable

serviceTypology stringnullable

clusterTypology stringnullable

cluster stringnullable

clustername stringnullable

nodePool stringnullable

serviceNumber int32nullable

resourceId string[]nullable

resourceName string[]nullable

resourceTypology stringnullable

vdc stringnullable

vm string[]nullable

metric stringnullable

lastReception date-timenullable

lastActivation date-timenullable

creationDatetime date-timenullable

lastEdit date-timenullable

deletionDate date-timenullable

rule stringnullable

theshold int64nullable

um stringnullable

duration stringnullable

state stringnullable

email booleannullable

emailValue stringnullable

sms booleannullable

smsValue stringnullable

panel booleannullable

hidden booleannullable

alertActions

object[]

nullable

Array [

actionType ActionType (string)

Possible values: [NotificationPanel, SendEmail, SendSms, AutoscalingDbaas]

parameters

object

nullable

property name* string

]

resourceVersion stringnullable

resourceUid stringnullable

actions

object[]

nullable

Array [

key stringnullable

disabled booleannullable

executable booleannullable

]

lastReception stringnullable

lastActivation stringnullable

lastEdit stringnullable

]

metadata

object

data

object[]

nullable

Array [

type stringnullable

values string[]nullable

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "id": "string",
      "alertModel": {
        "labels": {},
        "annotations": {},
        "startsAt": "string",
        "endsAt": "string",
        "generatorURL": "string",
        "status": {
          "inhibitedBy": [
            null
          ],
          "silencedBy": [
            null
          ],
          "state": "string"
        },
        "fingerprint": "string",
        "webhook": {
          "url": "string"
        }
      },
      "request": {
        "name": "string",
        "tags": [
          "string"
        ],
        "description": "string",
        "username": "string",
        "tenant": "string",
        "company": "string",
        "serviceCategory": "string",
        "serviceTypology": "string",
        "clusterTypology": "string",
        "cluster": "string",
        "clustername": "string",
        "nodePool": "string",
        "serviceNumber": 0,
        "resourceId": [
          "string"
        ],
        "resourceName": [
          "string"
        ],
        "resourceTypology": "string",
        "vdc": "string",
        "vm": [
          "string"
        ],
        "metric": "string",
        "lastReception": "2024-07-29T15:51:28.071Z",
        "lastActivation": "2024-07-29T15:51:28.071Z",
        "creationDatetime": "2024-07-29T15:51:28.071Z",
        "lastEdit": "2024-07-29T15:51:28.071Z",
        "deletionDate": "2024-07-29T15:51:28.071Z",
        "rule": "string",
        "theshold": 0,
        "um": "string",
        "duration": "string",
        "state": "string",
        "email": true,
        "emailValue": "string",
        "sms": true,
        "smsValue": "string",
        "panel": true,
        "hidden": true,
        "alertActions": [
          {
            "actionType": "NotificationPanel",
            "parameters": {}
          }
        ]
      },
      "resourceVersion": "string",
      "resourceUid": "string",
      "actions": [
        {
          "key": "string",
          "disabled": true,
          "executable": true
        }
      ],
      "lastReception": "string",
      "lastActivation": "string",
      "lastEdit": "string"
    }
  ],
  "metadata": {
    "data": [
      {
        "type": "string",
        "values": [
          "string"
        ]
      }
    ]
  }
}

text/json

Schema

Schema

total int64
self stringnullable
prev stringnullable
next stringnullable
first stringnullable
last stringnullable

values

object[]

nullable

Array [

id stringnullable

alertModel

object

labels

object

nullable

property name* string

annotations

object

nullable

property name* string

startsAt stringnullable

endsAt stringnullable

generatorURL stringnullable

status

object

inhibitedBy undefined[]nullable

silencedBy undefined[]nullable

state stringnullable

fingerprint stringnullable

webhook

object

url stringnullable

request

object

name stringnullable

tags string[]nullable

description stringnullable

username stringnullable

tenant stringnullable

company stringnullable

serviceCategory stringnullable

serviceTypology stringnullable

clusterTypology stringnullable

cluster stringnullable

clustername stringnullable

nodePool stringnullable

serviceNumber int32nullable

resourceId string[]nullable

resourceName string[]nullable

resourceTypology stringnullable

vdc stringnullable

vm string[]nullable

metric stringnullable

lastReception date-timenullable

lastActivation date-timenullable

creationDatetime date-timenullable

lastEdit date-timenullable

deletionDate date-timenullable

rule stringnullable

theshold int64nullable

um stringnullable

duration stringnullable

state stringnullable

email booleannullable

emailValue stringnullable

sms booleannullable

smsValue stringnullable

panel booleannullable

hidden booleannullable

alertActions

object[]

nullable

Array [

actionType ActionType (string)

Possible values: [NotificationPanel, SendEmail, SendSms, AutoscalingDbaas]

parameters

object

nullable

property name* string

]

resourceVersion stringnullable

resourceUid stringnullable

actions

object[]

nullable

Array [

key stringnullable

disabled booleannullable

executable booleannullable

]

lastReception stringnullable

lastActivation stringnullable

lastEdit stringnullable

]

metadata

object

data

object[]

nullable

Array [

type stringnullable

values string[]nullable

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "id": "string",
      "alertModel": {
        "labels": {},
        "annotations": {},
        "startsAt": "string",
        "endsAt": "string",
        "generatorURL": "string",
        "status": {
          "inhibitedBy": [
            null
          ],
          "silencedBy": [
            null
          ],
          "state": "string"
        },
        "fingerprint": "string",
        "webhook": {
          "url": "string"
        }
      },
      "request": {
        "name": "string",
        "tags": [
          "string"
        ],
        "description": "string",
        "username": "string",
        "tenant": "string",
        "company": "string",
        "serviceCategory": "string",
        "serviceTypology": "string",
        "clusterTypology": "string",
        "cluster": "string",
        "clustername": "string",
        "nodePool": "string",
        "serviceNumber": 0,
        "resourceId": [
          "string"
        ],
        "resourceName": [
          "string"
        ],
        "resourceTypology": "string",
        "vdc": "string",
        "vm": [
          "string"
        ],
        "metric": "string",
        "lastReception": "2024-07-29T15:51:28.071Z",
        "lastActivation": "2024-07-29T15:51:28.071Z",
        "creationDatetime": "2024-07-29T15:51:28.071Z",
        "lastEdit": "2024-07-29T15:51:28.071Z",
        "deletionDate": "2024-07-29T15:51:28.071Z",
        "rule": "string",
        "theshold": 0,
        "um": "string",
        "duration": "string",
        "state": "string",
        "email": true,
        "emailValue": "string",
        "sms": true,
        "smsValue": "string",
        "panel": true,
        "hidden": true,
        "alertActions": [
          {
            "actionType": "NotificationPanel",
            "parameters": {}
          }
        ]
      },
      "resourceVersion": "string",
      "resourceUid": "string",
      "actions": [
        {
          "key": "string",
          "disabled": true,
          "executable": true
        }
      ],
      "lastReception": "string",
      "lastActivation": "string",
      "lastEdit": "string"
    }
  ],
  "metadata": {
    "data": [
      {
        "type": "string",
        "values": [
          "string"
        ]
      }
    ]
  }
}

400

Bad Request

text/plain

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

401

Unauthorized

text/plain

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Not Found

text/plain

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...