AlertRule

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-alert-rule-schema.json",
  "title": "AlertRule",
  "description": "The alert rule.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-budget-api-openapi.yml#/components/schemas/AlertRule",
  "properties": {
    "budgetId": {
      "description": "The OCID of the budget.",
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only the String type is supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing a defined tag key and value, scoped to a namespace.\nExample: `{\"CostCenter\": \"42\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
      "type": "object"
    },
    "description": {
      "description": "The description of the alert rule.",
      "type": "string"
    },
    "displayName": {
      "description": "The name of the alert rule. Avoid entering confidential information.",
      "type": "string"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
      "type": "object"
    },
    "id": {
      "description": "The OCID of the alert rule.",
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current state of the alert rule.",
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/LifecycleState"
    },
    "message": {
      "description": "Custom message sent when an alert is triggered.",
      "type": "string"
    },
    "recipients": {
      "description": "The delimited list of email addresses to receive the alert when it triggers.\nDelimiter characters can be a comma, space, TAB, or semicolon.\n",
      "type": "string"
    },
    "threshold": {
      "description": "The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000.\n",
      "type": "number",
      "exclusiveMinimum": 0
    },
    "thresholdType": {
      "description": "The type of threshold.",
      "enum": [
        "PERCENTAGE",
        "ABSOLUTE"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/ThresholdType"
    },
    "timeCreated": {
      "description": "The time the budget was created.",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The time the budget was updated.",
      "format": "date-time",
      "type": "string"
    },
    "type": {
      "description": "The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or\nFORECAST (the alert triggers based on predicted usage).\n",
      "enum": [
        "ACTUAL",
        "FORECAST"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/AlertType"
    },
    "version": {
      "description": "The version of the alert rule. Starts from 1 and increments by 1.",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "budgetId",
    "displayName",
    "type",
    "threshold",
    "thresholdType",
    "recipients",
    "timeCreated",
    "timeUpdated",
    "lifecycleState"
  ]
}