Alert

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Alert",
  "description": "Alert schema from FlashArray REST API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-alert-schema.json",
  "allOf": [
    {
      "description": "A built-in resource. Many are singletons predefined by Purity (e.g., support\nsettings). Some correspond to a piece of software, like an app, or hardware,\nlike a controller. Others are created by the system in response to some event\n(e.g., alerts, audit records).\n\nTypically, a user can't create, delete or rename a built-in resource. A few\ncan be created or deleted, but not renamed because the names are meaningful\nto Purity (e.g., VIFs).\n",
      "type": "object",
      "properties": {
        "id": {
          "description": "A globally unique, system-generated ID.\nThe ID cannot be modified and cannot refer to another resource.\n",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "A locally unique, system-generated name. The name cannot be modified.\n",
          "type": "string",
          "readOnly": true
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "context": {
          "description": "The context in which the operation was performed.\n\nValid values include a reference to any array which is a member of the same fleet\nor to the fleet itself.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n",
          "readOnly": true,
          "title": "FixedReferenceWithType",
          "allOf": [
            {
              "$ref": "#/components/schemas/_fixedReferenceWithType"
            }
          ]
        }
      }
    },
    {
      "description": "Alert generated by the array when an event occurs.",
      "type": "object",
      "properties": {
        "action": {
          "description": "The action of the alert.",
          "type": "string",
          "readOnly": true
        },
        "actual": {
          "description": "Actual condition at the time the alert is created.",
          "type": "string",
          "readOnly": true,
          "example": "95%"
        },
        "category": {
          "description": "The category of the alert.\nValid values include `array`, `hardware` and `software`.\n",
          "type": "string",
          "readOnly": true,
          "example": "array"
        },
        "closed": {
          "description": "The time the alert was closed in milliseconds since the UNIX epoch.",
          "type": "integer",
          "format": "int64",
          "readOnly": true,
          "example": 1578440492342
        },
        "code": {
          "description": "The code number of the alert.",
          "type": "integer",
          "format": "int64",
          "readOnly": true,
          "example": 7
        },
        "component_name": {
          "description": "The name of the component that generated the alert.",
          "type": "string",
          "readOnly": true,
          "example": "vm-tom"
        },
        "component_type": {
          "description": "The type of component that generated the alert.",
          "type": "string",
          "readOnly": true,
          "example": "storage"
        },
        "created": {
          "description": "The time the alert was created in milliseconds since the UNIX epoch.",
          "type": "integer",
          "format": "int64",
          "readOnly": true,
          "example": 1576275532434
        },
        "description": {
          "description": "A short description of the alert.",
          "type": "string",
          "readOnly": true,
          "example": "boot drive overutilization"
        },
        "duration": {
          "description": "The duration of the alert.",
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "expected": {
          "description": "Expected state or threshold under normal conditions.",
          "type": "string",
          "readOnly": true,
          "example": "90%"
        },
        "flagged": {
          "description": "If set to `true`, the message is flagged.\nImportant messages can can be flagged and listed separately.\n",
          "type": "boolean",
          "example": true
        },
        "issue": {
          "description": "Information about the alert cause.",
          "type": "string",
          "readOnly": true,
          "example": "boot drive overutilization"
        },
        "knowledge_base_url": {
          "description": "The URL of the relevant knowledge base page.",
          "type": "string",
          "readOnly": true,
          "example": "https://support.purestorage.com/?cid=Alert_0007"
        },
        "notified": {
          "description": "The time the most recent alert notification was sent in milliseconds since the UNIX epoch.\n",
          "type": "integer",
          "format": "int64",
          "readOnly": true,
          "example": 1578440491109
        },
        "severity": {
          "description": "The severity level of the alert.\nValid values include `info`, `warning`, `critical`, and `hidden`.\n",
          "type": "string",
          "readOnly": true,
          "example": "critical"
        },
        "state": {
          "description": "The current state of the alert.\nValid values include `open`, `closing`, and `closed`.\n",
          "type": "string",
          "readOnly": true,
          "example": "open"
        },
        "summary": {
          "description": "A summary of the alert.",
          "type": "string",
          "readOnly": true,
          "example": "boot drive overutilization"
        },
        "updated": {
          "description": "The time the alert was last updated in milliseconds since the UNIX epoch.",
          "type": "integer",
          "format": "int64",
          "readOnly": true,
          "example": 1578440491109
        }
      }
    }
  ]
}