Pure Storage · Schema

Alert

Alert schema from Pure1 Public REST API

StorageData StorageFlash StorageEnterprise StorageCloud StorageObject StorageFile StorageBlock StorageKubernetes StorageInfrastructure
View JSON Schema on GitHub

JSON Schema

pure1-cloud-api-alert-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Alert",
  "description": "Alert schema from Pure1 Public REST API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-alert-schema.json",
  "allOf": [
    {
      "description": "A built-in resource that exists on one or multiple arrays.\n",
      "allOf": [
        {
          "$ref": "#/components/schemas/_resource"
        },
        {
          "$ref": "#/components/schemas/_arrays"
        }
      ]
    },
    {
      "description": "An alert from an array.\n",
      "type": "object",
      "properties": {
        "actual": {
          "description": "Actual condition at the time of the alert.",
          "type": "string",
          "example": "empty"
        },
        "category": {
          "description": "Category of the alert. Valid values are `array`, `hardware`, and\n`software`.\n",
          "type": "string",
          "example": "array"
        },
        "closed": {
          "description": "Time when the alert was closed, in milliseconds since UNIX epoch.\n",
          "type": "integer",
          "format": "int64",
          "example": 1502729489760
        },
        "code": {
          "description": "Code associated with the alert.",
          "type": "integer",
          "example": 100
        },
        "component_name": {
          "description": "Name of the component alerted about.",
          "type": "string",
          "example": "drive1"
        },
        "component_type": {
          "description": "Type of the component alerted about.",
          "type": "string",
          "example": "drive"
        },
        "created": {
          "description": "Time when the alert was created, in milliseconds since UNIX epoch.\n",
          "type": "integer",
          "format": "int64",
          "example": 1502729489760
        },
        "description": {
          "description": "Short description of the alert.",
          "type": "string",
          "example": "Some sort of failure."
        },
        "expected": {
          "description": "Expected state/threshold under normal conditions.",
          "type": "string",
          "example": "healthy"
        },
        "knowledge_base_url": {
          "description": "URL of the relevant Knowledge Base page.",
          "type": "string",
          "example": "https://support.purestorage.com/"
        },
        "notified": {
          "description": "Time when the user was notified of the alert, in milliseconds since\nUNIX epoch.\n",
          "type": "integer",
          "format": "int64",
          "example": 1502729489760
        },
        "origin": {
          "description": "Origin of the alert. Valid values are `array` and `Pure1`.",
          "type": "string",
          "example": "array"
        },
        "severity": {
          "description": "Current severity level. Valid values are `info`, `warning`, `critical`,\nand `hidden`.\n",
          "type": "string",
          "example": "critical"
        },
        "state": {
          "description": "Current state of the alert. Valid values are `open`, `closing`,\nand `closed`.\n",
          "type": "string",
          "example": "open"
        },
        "summary": {
          "description": "Summary of the alert.",
          "type": "string",
          "example": "Test alert."
        },
        "updated": {
          "description": "Time when the alert was last updated, in milliseconds since UNIX epoch.\n",
          "type": "integer",
          "format": "int64",
          "example": 1502729489760
        }
      }
    }
  ]
}