InstanceRetentionPolicyWrite

Fields

PUT body. enabled: true is refused (422 enable_via_flow); false switches it off.

8 fields

artifacts_days

integer or null

audit_days

integer or null

clear

array of string or null

enabled

boolean or null

keep_last_runs

integer or null

purge_window_start_utc

integer or null

raw_events_days

integer or null

runs_days

integer or null

Raw schema (JSON)

{
  "description": "PUT body. ``enabled: true`` is refused (422 ``enable_via_flow``); ``false`` switches it off.",
  "properties": {
    "artifacts_days": {
      "anyOf": [
        {
          "maximum": 3650,
          "minimum": 7,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Artifacts Days"
    },
    "audit_days": {
      "anyOf": [
        {
          "maximum": 3650,
          "minimum": 365,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Audit Days"
    },
    "clear": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "maxItems": 6,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Clear"
    },
    "enabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Enabled"
    },
    "keep_last_runs": {
      "anyOf": [
        {
          "maximum": 1000,
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Keep Last Runs"
    },
    "purge_window_start_utc": {
      "anyOf": [
        {
          "maximum": 23,
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Purge Window Start Utc"
    },
    "raw_events_days": {
      "anyOf": [
        {
          "maximum": 3650,
          "minimum": 7,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Raw Events Days"
    },
    "runs_days": {
      "anyOf": [
        {
          "maximum": 3650,
          "minimum": 30,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Runs Days"
    }
  },
  "title": "InstanceRetentionPolicyWrite",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• PUT /api/v1/settings/retention-defaults — Update Retention Defaults

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON