Scan

API GatewayAPI ManagementDeveloper PortalDeveloper ToolsIBM

Properties

Name	Type	Description
type	string
api_version	string
id	string
name	string
title	string
summary	string
scope	string
collection	object
config	array
documents	array
documents_scanned	integer
progress	integer
reports	array
scan_result	string
status	integer
scan_type	string
tagged_rulesets	object
raw_tags	object
enforcement_config	object
is_gateway_scan	boolean
metadata	object
created_at	string
updated_at	string
url	string
is_cron_active	boolean	Indicates if the scan schedule is active
last_run	string	Timestamp of the last scheduled scan execution
next_run	string	Timestamp of the next scheduled scan execution
cron_expression	string	Cron expression defining the scan schedule
cron_object	object	Parsed cron schedule object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-scan-schema.json",
  "title": "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/Scan",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "type": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "scan"
      ]
    },
    "api_version": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "2.0.0"
      ]
    },
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "title": {
      "type": "string",
      "maxLength": 1023
    },
    "summary": {
      "type": "string",
      "maxLength": 65535
    },
    "scope": {
      "type": "string"
    },
    "collection": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "parent_id": {
          "type": "string"
        },
        "parent_name": {
          "type": "string"
        },
        "parent_title": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "catalog",
            "space",
            "org"
          ]
        },
        "location": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "config": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "documents": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "documents_scanned": {
      "type": "integer"
    },
    "progress": {
      "type": "integer"
    },
    "reports": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "created_at": {
            "type": "string"
          },
          "report_url": {
            "type": "string",
            "format": "uri"
          },
          "scan_result": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "errors": {
                "type": "string"
              },
              "warnings": {
                "type": "string"
              },
              "infos": {
                "type": "string"
              },
              "hints": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "scan_result": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "scan_type": {
      "type": "string"
    },
    "tagged_rulesets": {
      "type": "object",
      "additionalProperties": true
    },
    "raw_tags": {
      "type": "object",
      "additionalProperties": true
    },
    "enforcement_config": {
      "type": "object",
      "additionalProperties": true
    },
    "is_gateway_scan": {
      "type": "boolean"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "format": "uri"
    },
    "is_cron_active": {
      "type": "boolean",
      "x-bhendi-db-type": "transient",
      "description": "Indicates if the scan schedule is active"
    },
    "last_run": {
      "type": "string",
      "format": "date-time",
      "x-bhendi-db-type": "transient",
      "description": "Timestamp of the last scheduled scan execution"
    },
    "next_run": {
      "type": "string",
      "format": "date-time",
      "x-bhendi-db-type": "transient",
      "description": "Timestamp of the next scheduled scan execution"
    },
    "cron_expression": {
      "type": "string",
      "x-bhendi-db-type": "transient",
      "description": "Cron expression defining the scan schedule"
    },
    "cron_object": {
      "type": "object",
      "additionalProperties": true,
      "x-bhendi-db-type": "transient",
      "description": "Parsed cron schedule object"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/ibm-api-connect-scan"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.