SettingsBody

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-settings-body-schema.json",
  "title": "SettingsBody",
  "description": "OpenSearch settings request body",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-analytics-api-openapi.yml#/components/schemas/SettingsBody",
  "type": "object",
  "properties": {
    "rollover": {
      "type": "object",
      "required": [
        "min_doc_count",
        "min_index_age"
      ],
      "properties": {
        "min_doc_count": {
          "description": "The minimum number of documents required to roll over the event index.",
          "type": "integer",
          "minimum": 1,
          "x-example": 25000000
        },
        "min_index_age": {
          "description": "The minimum age required to roll over the event index. Index age is the time between its creation and the present. Use d for day and h for hour, e.g. 30d or 96h.",
          "type": "string",
          "x-example": "1d"
        }
      }
    },
    "retention": {
      "type": "object",
      "required": [
        "min_index_age"
      ],
      "properties": {
        "min_index_age": {
          "description": "The minimum age required to delete the event index. Index age is the time between its creation and the present. Use d for day and h for hour, e.g. 30d or 96h.",
          "type": "string",
          "x-example": "90d"
        }
      }
    },
    "summary_retention": {
      "type": "object",
      "required": [
        "min_index_age"
      ],
      "properties": {
        "min_index_age": {
          "description": "The minimum age required to delete the summary index. Index age is the time between its creation and the present. Use d for day and h for hour, e.g. 366d or 8000h.",
          "type": "string",
          "x-example": "366d"
        }
      }
    },
    "audit_retention": {
      "type": "object",
      "required": [
        "min_index_age"
      ],
      "properties": {
        "min_index_age": {
          "description": "The minimum age required to delete the audit index. Index age is the time between its creation and the present. Use d for day and h for hour, e.g. 30d or 800h.",
          "type": "string",
          "x-example": "30d"
        }
      }
    },
    "heartbeat_retention": {
      "type": "object",
      "required": [
        "min_index_age"
      ],
      "properties": {
        "min_index_age": {
          "description": "The minimum age required to delete the heartbeat index. Index age is the time between its creation and the present. Use d for day and h for hour, e.g. 30d or 800h.",
          "type": "string",
          "x-example": "30d"
        }
      }
    },
    "metrics_retention": {
      "type": "object",
      "required": [
        "min_index_age"
      ],
      "properties": {
        "min_index_age": {
          "description": "The minimum age required to delete the metrics index. Index age is the time between its creation and the present. Use d for day and h for hour, e.g. 30d or 800h.",
          "type": "string",
          "x-example": "30d"
        }
      }
    }
  }
}