Request object to create an anomaly detector. Supports an optional start_on_create boolean — when true the director starts the detector immediately after creation in a single API call.
API GatewayAPI ManagementDeveloper PortalDeveloper ToolsIBM
Properties
Name
Type
Description
start_on_create
boolean
When true, the director starts the detector immediately after it is created. The response includes a `started` boolean indicating whether the start succeeded.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-anomaly-detector-create-request-schema.json",
"title": "AnomalyDetectorCreateRequest",
"description": "Request object to create an anomaly detector. Supports an optional start_on_create boolean — when true the director starts the detector immediately after creation in a single API call.",
"x-generated": "2026-10-29",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/ibm-api-connect-engagement-api-openapi.yml#/components/schemas/AnomalyDetectorCreateRequest",
"allOf": [
{
"$ref": "#/$defs/AnomalyDetectorRequest"
},
{
"type": "object",
"properties": {
"start_on_create": {
"type": "boolean",
"description": "When true, the director starts the detector immediately after it is created. The response includes a `started` boolean indicating whether the start succeeded.\n"
}
}
}
],
"$defs": {
"AnomalyDetectorRequest": {
"type": "object",
"description": "An anomaly detector configuration",
"additionalProperties": true
}
}
}
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.