GatewayScanCreateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-gateway-scan-create-request-schema.json",
  "title": "GatewayScanCreateRequest",
  "description": "Create request for a new gateway scan",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-compliance-api-openapi.yml#/components/schemas/GatewayScanCreateRequest",
  "type": "object",
  "required": [
    "path"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Identifier of a gateway scan."
    },
    "scan_title": {
      "type": "string",
      "description": "Title for the scan"
    },
    "scan_id": {
      "type": "string",
      "description": "Identifier of an existing or scheduled scan"
    },
    "cron_expression": {
      "type": "string",
      "description": "Cron expression (minute hour * * dayOfWeek)"
    },
    "cron_object": {
      "$ref": "#/$defs/CronObject"
    },
    "is_cron_active": {
      "type": "boolean",
      "default": true,
      "description": "Whether cron schedule is active"
    },
    "last_run": {
      "type": "string",
      "format": "date-time",
      "description": "Last execution time"
    },
    "next_run": {
      "type": "string",
      "format": "date-time",
      "description": "Next scheduled execution time"
    },
    "path": {
      "type": "string",
      "description": "Gateway path URL"
    },
    "config": {
      "$ref": "#/$defs/GatewayConfigDefinition"
    },
    "availability_zone": {
      "type": "string",
      "description": "Availability zone of the gateway"
    },
    "gateway_service": {
      "type": "string",
      "description": "Title or name of the gateway service"
    }
  },
  "additionalProperties": true,
  "$defs": {
    "CronObject": {
      "type": "object",
      "description": "Cron configuration for scheduled scans",
      "additionalProperties": false,
      "properties": {
        "minute": {
          "type": "integer",
          "description": "Minute (0–59)"
        },
        "hour": {
          "type": "integer",
          "description": "Hour (0–23)"
        },
        "frequency": {
          "type": "string",
          "description": "Frequency (daily or specific day of week)"
        }
      },
      "required": [
        "minute",
        "hour",
        "frequency"
      ]
    },
    "GatewayConfigDefinition": {
      "type": "object",
      "description": "Configuration definition for the scan",
      "additionalProperties": true
    }
  }
}