PatchCampaignRunBody

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/calypsoai-com/json-schema/calypsoai-com-patch-campaign-run-body-schema.json",
  "title": "PatchCampaignRunBody",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/calypsoai-com-campaign-runs-api-openapi.yml#/components/schemas/PatchCampaignRunBody",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Name"
    },
    "preserve": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "If true, the campaign run and its associated data will be preserved from deletion.",
      "title": "Preserve"
    },
    "remediationSettings": {
      "anyOf": [
        {
          "$ref": "#/$defs/CampaignRunRemediationSettings"
        },
        {
          "type": "null"
        }
      ],
      "description": "Determines if the campaign run will automatically create a remediation for vulnerabilities found"
    },
    "startAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "New time to start the campaign run",
      "title": "Startat"
    },
    "status": {
      "anyOf": [
        {
          "const": "cancelled",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "If received, the campaign run will be prevented from running in the future.",
      "title": "Status"
    }
  },
  "type": "object",
  "$defs": {
    "CampaignRunRemediationSettings": {
      "properties": {
        "autorun": {
          "default": false,
          "description": "Run remediation once available.",
          "title": "Autorun",
          "type": "boolean"
        }
      },
      "title": "CampaignRunRemediationSettings",
      "type": "object"
    }
  }
}