Alert Label Rule

Get Alert Label Rule

Endpoint to retrieve a single Alert Label Rule by ID

post/alert-label-rule/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Alert Label Rule to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "criteria": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Example short text",
    "description": "This is an example of longer text content that might be stored in this field.",
    "isEnabled": true,
    "monitors": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "alertSeverities": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "alertLabels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "monitorLabels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "alertTitlePattern": "This is an example of longer text content that might be stored in this field.",
    "alertDescriptionPattern": "This is an example of longer text content that might be stored in this field.",
    "monitorNamePattern": "This is an example of longer text content that might be stored in this field.",
    "monitorDescriptionPattern": "This is an example of longer text content that might be stored in this field.",
    "labelsToAdd": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "inheritLabelsFromMonitors": true,
    "inheritLabelsFromHosts": true,
    "inheritLabelsFromKubernetesClusters": true,
    "inheritLabelsFromDockerHosts": true,
    "inheritLabelsFromPodmanHosts": true,
    "inheritLabelsFromServices": true,
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.