Skip to main content

Documentation index for AI agents: llms.txt. Every page here is also served as markdown: add .md to its address, or request it with Accept: text/markdown.

ApiMonitorConfig data model

The ApiMonitorConfig shape in the Visual Sentinel REST API.

Fields

FieldTypeRequiredDescription
assertionsarray of objectNoMax items 100.
assertions[].pathstringYesMax length 1024.
assertions[].operatorstringYesOne of: equals, not_equals, contains, not_contains, exists, not_exists, greaterThan, lessThan, matches, type.
assertions[].valuestring or number or boolean or nullNo
assertions[].valueTypestringNoOne of: string, number, boolean, null.
assertions[].targetstringNoOne of: body, header, status. Default: body.
responseSlonumber or nullNoDefault: null.
responseFormatstringNoOne of: json, text, xml, auto. Default: json.
saveResponseBodybooleanNoDefault: true.
maxResponseBodySizeintegerNoDefault: 10240. Minimum 1024, maximum 51200.
graphqlobjectNo
graphql.querystringYesMin length 1, max length 20480.
graphql.variablesmap of JsonValueNo

Used by

Generated from the OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json.