{ "openapi" : "3.1.0", "info" : { "title" : "Forward Networks: Checks API", "description" : "Enable or define automated checks that verify network policy and behavior", "contact" : { "email" : "support@forwardnetworks.com" }, "license" : { "name" : "MIT", "url" : "https://spdx.org/licenses/MIT" }, "version" : "${apiVersion}" }, "servers" : [ { "url" : "/" } ], "tags" : [ { "name" : "Checks", "description" : "Check Controller" } ], "paths" : { "/api/predefinedChecks" : { "get" : { "tags" : [ "Checks" ], "summary" : "Gets available Predefined checks", "operationId" : "getAvailablePredefinedChecksUsingGET", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AvailablePredefinedCheck" } } } } } }, "deprecated" : false, "security" : [ { "api_token" : [ ] } ] } }, "/api/snapshots/{snapshotId}/checks" : { "get" : { "tags" : [ "Checks" ], "summary" : "Gets checks (with status)", "operationId" : "getChecksUsingGET", "parameters" : [ { "name" : "snapshotId", "in" : "path", "description" : "snapshotId", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "type", "in" : "query", "description" : "Can be repeated to request multiple types (as in `?type=NQE&type=Predefined`) or omitted to request all types.", "required" : false, "allowEmptyValue" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "Isolation", "Reachability", "Existential", "QueryStringBased", "Predefined", "NQE" ] } } }, { "name" : "priority", "in" : "query", "description" : "Can be repeated to request multiple priorities (as in `?priority=HIGH&priority=LOW`) or omitted to request all priorities.", "required" : false, "allowEmptyValue" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "NOT_SET", "LOW", "MEDIUM", "HIGH" ] } } }, { "name" : "status", "in" : "query", "description" : "Can be repeated to request multiple statuses (as in `?status=FAIL&status=ERROR`) or omitted to request all statuses.\n\n**Note:** The response will never contain results with `status` NONE or PROCESSING. The server will wait to respond, if necessary, until processing finishes or times out.", "required" : false, "allowEmptyValue" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "NONE", "PASS", "FAIL", "ERROR", "TIMEOUT", "PROCESSING" ] } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NetworkCheckResult" } } } } }, "409" : { "description" : "The system is currently processing this Snapshot.\n\nNote: GET /networks/{networkId}/snapshots/latestProcessed can be used to determine when processing of the latest Snapshot is done or to identify an alternate Snapshot that has already been processed.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorInfo" } } } } }, "deprecated" : false, "security" : [ { "api_token" : [ ] } ] }, "post" : { "tags" : [ "Checks" ], "summary" : "Adds a check", "description" : "Note that the returned NetworkCheckResult will never have status of type NONE or PROCESSING", "operationId" : "addCheckUsingPOST", "parameters" : [ { "name" : "snapshotId", "in" : "path", "description" : "snapshotId", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "persistent", "in" : "query", "description" : "Whether to associate check with any later snapshots (including future snapshots) too", "required" : false, "allowEmptyValue" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "default" : true } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NewNetworkCheck" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NetworkCheckResult" } } } }, "409" : { "description" : "The system is currently processing this Snapshot.\n\nNote: GET /networks/{networkId}/snapshots/latestProcessed can be used to determine when processing of the latest Snapshot is done or to identify an alternate Snapshot that has already been processed.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorInfo" } } } } }, "deprecated" : false, "security" : [ { "api_token" : [ ] } ] }, "delete" : { "tags" : [ "Checks" ], "summary" : "Deactivates all checks", "operationId" : "deactivateChecksUsingDELETE", "parameters" : [ { "name" : "snapshotId", "in" : "path", "description" : "snapshotId", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } }, "deprecated" : false, "security" : [ { "api_token" : [ ] } ] } }, "/api/snapshots/{snapshotId}/checks/{checkId}" : { "get" : { "tags" : [ "Checks" ], "summary" : "Gets a check (with status)", "description" : "Note that the returned NetworkCheckResults will never have status of type NONE or PROCESSING", "operationId" : "getSingleCheckUsingGET", "parameters" : [ { "name" : "snapshotId", "in" : "path", "description" : "snapshotId", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "checkId", "in" : "path", "description" : "checkId", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NetworkCheckResultWithDiagnosis" } } } }, "409" : { "description" : "The system is currently processing this Snapshot.\n\nNote: GET /networks/{networkId}/snapshots/latestProcessed can be used to determine when processing of the latest Snapshot is done or to identify an alternate Snapshot that has already been processed.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorInfo" } } } } }, "deprecated" : false, "security" : [ { "api_token" : [ ] } ] }, "delete" : { "tags" : [ "Checks" ], "summary" : "Deactivates a check", "operationId" : "deactivateCheckUsingDELETE", "parameters" : [ { "name" : "snapshotId", "in" : "path", "description" : "snapshotId", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "checkId", "in" : "path", "description" : "checkId", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } }, "deprecated" : false, "security" : [ { "api_token" : [ ] } ] } } }, "components" : { "schemas" : { "AvailablePredefinedCheck" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "name" : { "type" : "string" }, "predefinedCheckType" : { "type" : "string", "enum" : [ "BGP_NEIGHBOR_ADJACENCY", "BGP_ROUTER_ID", "BGP_ROUTE_CONSISTENCY", "BGP_VPC_PARAMETER_CONSISTENCY", "EBGP_SELECTION_OVER_IBGP", "BGP_COMMUNITY_LIST", "NEXT_HOP_REACHABILITY", "NO_LOOP", "SHORTEST_PATH", "IP_UNIQUENESS", "HOSTNAME_CONSISTENCY", "HOSTNAME_UNIQUENESS", "VLAN_CONSISTENCY", "MTU_CONSISTENCY", "PORT_CHANNEL_CONSISTENCY", "DUPLEX_CONSISTENCY", "LINK_SPEED_CONSISTENCY", "SOFTWARE_VERSION_CONSISTENCY", "TRUNK_INTERFACE_WHITELIST", "VLAN_EXISTENCE", "LEARNED_MAC_CONSISTENCY", "FHRP_PEERING", "VPC_PARAMETER_CONSISTENCY", "VPC_INTERFACE_PARAMETER_CONSISTENCY", "VPC_DEDICATED_KEEPALIVE_LINK", "VPC_ROLE_PRIORITY", "SSH_RSA_KEY_LENGTH", "VPC_STP_PRIORITY", "VPC_MST_REGION_CONSISTENCY" ] } } }, "BypassFilter" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "DeviceFilter", "DeviceAliasFilter" ] } }, "discriminator" : { "propertyName" : "type", "mapping" : { "DeviceFilter" : "#/components/schemas/DeviceFilter", "DeviceAliasFilter" : "#/components/schemas/DeviceAliasFilter" } } }, "CheckDefinition" : { "required" : [ "checkType" ], "type" : "object", "properties" : { "checkType" : { "type" : "string", "enum" : [ "Existential", "Isolation", "Reachability", "QueryStringBased", "Predefined", "NQE" ] } }, "discriminator" : { "propertyName" : "checkType", "mapping" : { "Existential" : "#/components/schemas/ExistsCheck", "Exists" : "#/components/schemas/ExistsCheck", "ExistentialCheck" : "#/components/schemas/ExistsCheck", "Isolation" : "#/components/schemas/IsolationCheck", "IsolationCheck" : "#/components/schemas/IsolationCheck", "Reachability" : "#/components/schemas/ReachabilityCheck", "ReachabilityCheck" : "#/components/schemas/ReachabilityCheck", "QueryStringBased" : "#/components/schemas/QueryStringCheck", "Predefined" : "#/components/schemas/PredefinedCheck", "NQE" : "#/components/schemas/NqeCheck", "NetworkQuery" : "#/components/schemas/NqeCheck" } } }, "CheckDiagnosis" : { "type" : "object", "properties" : { "details" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DiagnosisDetail" } }, "detailsIncomplete" : { "type" : "boolean" }, "summary" : { "type" : "string" } } }, "DeviceAliasFilter" : { "required" : [ "type", "value" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "DeviceAliasFilter" ] }, "value" : { "type" : "string", "description" : "A Device Group name" } }, "description" : "A filter that matches any device in a Device Group" }, "DeviceFilter" : { "required" : [ "type", "value" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "DeviceFilter" ] }, "value" : { "type" : "string", "examples" : [ "nyc-dc01-fw01" ] } }, "description" : "A filter that matches one device by name or all devices (using value \"*\")" }, "DeviceVrfFilter" : { "required" : [ "device", "type", "vrf" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "DeviceVrfFilter" ] }, "device" : { "type" : "string", "examples" : [ "nyc-dc01-rtr-01" ] }, "vrf" : { "type" : "string", "examples" : [ "MY VRF" ] } }, "description" : "A filter that matches a device’s interfaces by VRF name" }, "DiagnosisDetail" : { "type" : "object", "properties" : { "query" : { "type" : "string" }, "references" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DiagnosisReference" } } } }, "DiagnosisReference" : { "type" : "object", "properties" : { "key" : { "type" : "string", "description" : "A name or identifier associated with the reference, like a device or interface name.", "examples" : [ "rtr-01 eth0" ] }, "value" : { "type" : "string", "description" : "The value associated with `key` that’s relevant to this violation, such as a link speed, MTU size, VLAN range, or IP address.", "examples" : [ "10.110.4.14" ] }, "files" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LineRange" } }, "description" : "Relevant line ranges in files collected from the device.", "examples" : [ { "rtr-01,configuration,16.txt" : [ { "start" : 6, "end" : 6 }, { "start" : 22, "end" : 29 } ] } ] } } }, "EndpointFilter" : { "required" : [ "location" ], "type" : "object", "properties" : { "headers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PacketHeaderFilter" } }, "location" : { "$ref" : "#/components/schemas/LocationFilter" }, "logicalNetwork" : { "type" : "string" } } }, "ErrorInfo" : { "required" : [ "apiUrl", "httpMethod", "message" ], "type" : "object", "properties" : { "httpMethod" : { "type" : "string", "examples" : [ "GET" ], "enum" : [ "GET", "HEAD", "POST", "PUT", "PATCH", "DELETE" ] }, "apiUrl" : { "type" : "string", "examples" : [ "/api/version" ] }, "message" : { "type" : "string", "description" : "A description of the error" }, "reason" : { "type" : "string" } } }, "ExistsCheck" : { "required" : [ "checkType", "filters" ], "type" : "object", "properties" : { "checkType" : { "type" : "string", "enum" : [ "Existential" ] }, "filters" : { "$ref" : "#/components/schemas/PathQuery" }, "headerFieldsWithDefaults" : { "type" : "array", "description" : "The header fields for which a default value is assumed if no valid is specified in the `from` clause. Defaults to `[\"url\"]`.", "items" : { "type" : "string", "enum" : [ "ip_tos", "tp_src", "app_id", "url", "user_id" ] } }, "noiseTypes" : { "type" : "array", "description" : "The noise types that should be included in the search results. Defaults to `[]`.", "items" : { "type" : "string", "enum" : [ "WRONG_GATEWAY", "INADMISSIBLE", "NETWORK_OR_BROADCAST_ADDRESS", "TO_L2_INTERFACE_MAC", "GLEAN" ] } }, "returnPath" : { "type" : "string", "enum" : [ "ANY", "SYMMETRIC" ] } } }, "FlowHopFilter" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "HostFilter", "DeviceFilter", "InterfaceFilter", "TunnelInterfaceFilter", "SecurityZoneFilter", "DeviceVrfFilter", "PacketFilter", "HostAliasFilter", "DeviceAliasFilter", "InterfaceAliasFilter", "PacketAliasFilter", "SubnetLocationFilter", "VrfFilter", "NotFilter" ] } }, "discriminator" : { "propertyName" : "type", "mapping" : { "HostFilter" : "#/components/schemas/HostFilter", "DeviceFilter" : "#/components/schemas/DeviceFilter", "InterfaceFilter" : "#/components/schemas/InterfaceFilter", "TunnelInterfaceFilter" : "#/components/schemas/TunnelInterfaceFilter", "SecurityZoneFilter" : "#/components/schemas/SecurityZoneFilter", "DeviceVrfFilter" : "#/components/schemas/DeviceVrfFilter", "PacketFilter" : "#/components/schemas/PacketFilter", "HostAliasFilter" : "#/components/schemas/HostAliasFilter", "DeviceAliasFilter" : "#/components/schemas/DeviceAliasFilter", "InterfaceAliasFilter" : "#/components/schemas/InterfaceAliasFilter", "PacketAliasFilter" : "#/components/schemas/PacketAliasFilter", "SubnetLocationFilter" : "#/components/schemas/SubnetLocationFilter", "VrfFilter" : "#/components/schemas/VrfFilter", "NotFilter" : "#/components/schemas/NotFilter" } } }, "HopFilter" : { "required" : [ "location", "transitType" ], "type" : "object", "properties" : { "headers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PacketHeaderFilter" } }, "location" : { "$ref" : "#/components/schemas/HopLocationFilter" }, "transitType" : { "type" : "string", "enum" : [ "through", "ingress", "egress" ] } } }, "HopLocationFilter" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "DeviceFilter", "InterfaceFilter", "TunnelInterfaceFilter", "SecurityZoneFilter", "DeviceVrfFilter", "DeviceAliasFilter", "InterfaceAliasFilter", "VrfFilter", "NotFilter" ] } }, "discriminator" : { "propertyName" : "type", "mapping" : { "DeviceFilter" : "#/components/schemas/DeviceFilter", "InterfaceFilter" : "#/components/schemas/InterfaceFilter", "TunnelInterfaceFilter" : "#/components/schemas/TunnelInterfaceFilter", "SecurityZoneFilter" : "#/components/schemas/SecurityZoneFilter", "DeviceVrfFilter" : "#/components/schemas/DeviceVrfFilter", "DeviceAliasFilter" : "#/components/schemas/DeviceAliasFilter", "InterfaceAliasFilter" : "#/components/schemas/InterfaceAliasFilter", "VrfFilter" : "#/components/schemas/VrfFilter", "NotFilter" : "#/components/schemas/NotFilter" } } }, "HostAliasFilter" : { "required" : [ "type", "value" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "HostAliasFilter" ] }, "value" : { "type" : "string", "description" : "A Host Group name" } }, "description" : "A filter that matches any host in a Host Group" }, "HostFilter" : { "required" : [ "type", "value" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "HostFilter" ] }, "value" : { "type" : "string", "examples" : [ "10.10.10.10" ] } }, "description" : "A filter that matches hosts by hostname, IP subnet address, or MAC address" }, "InterfaceAliasFilter" : { "required" : [ "type", "value" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "InterfaceAliasFilter" ] }, "value" : { "type" : "string", "description" : "An Interface Group name" } }, "description" : "A filter that matches any device interface in an Interface Group" }, "InterfaceFilter" : { "required" : [ "type", "value" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "InterfaceFilter" ] }, "value" : { "type" : "string", "examples" : [ "nyc-dc01-fw01 eth1" ] } }, "description" : "A filter that matches one device interface by name" }, "IsolationCheck" : { "required" : [ "checkType", "filters" ], "type" : "object", "properties" : { "checkType" : { "type" : "string", "enum" : [ "Isolation" ] }, "filters" : { "$ref" : "#/components/schemas/PathQuery" }, "headerFieldsWithDefaults" : { "type" : "array", "description" : "The header fields for which a default value is assumed if no valid is specified in the `from` clause. Defaults to `[\"url\"]`.", "items" : { "type" : "string", "enum" : [ "ip_tos", "tp_src", "app_id", "url", "user_id" ] } }, "noiseTypes" : { "type" : "array", "description" : "The noise types that should be included in the search results. Defaults to `[]`.", "items" : { "type" : "string", "enum" : [ "WRONG_GATEWAY", "INADMISSIBLE", "NETWORK_OR_BROADCAST_ADDRESS", "TO_L2_INTERFACE_MAC", "GLEAN" ] } } } }, "LineRange" : { "type" : "object", "properties" : { "start" : { "type" : "integer", "description" : "The 0-based index of the first line in the range.", "format" : "int32", "examples" : [ 23 ] }, "end" : { "type" : "integer", "description" : "The 0-based index of the last line in the range (inclusive).", "format" : "int32", "examples" : [ 27 ] } } }, "LocationFilter" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "HostFilter", "DeviceFilter", "InterfaceFilter", "TunnelInterfaceFilter", "SecurityZoneFilter", "DeviceVrfFilter", "HostAliasFilter", "DeviceAliasFilter", "InterfaceAliasFilter", "SubnetLocationFilter", "VrfFilter", "NotFilter" ] } }, "discriminator" : { "propertyName" : "type", "mapping" : { "HostFilter" : "#/components/schemas/HostFilter", "DeviceFilter" : "#/components/schemas/DeviceFilter", "InterfaceFilter" : "#/components/schemas/InterfaceFilter", "TunnelInterfaceFilter" : "#/components/schemas/TunnelInterfaceFilter", "SecurityZoneFilter" : "#/components/schemas/SecurityZoneFilter", "DeviceVrfFilter" : "#/components/schemas/DeviceVrfFilter", "HostAliasFilter" : "#/components/schemas/HostAliasFilter", "DeviceAliasFilter" : "#/components/schemas/DeviceAliasFilter", "InterfaceAliasFilter" : "#/components/schemas/InterfaceAliasFilter", "SubnetLocationFilter" : "#/components/schemas/SubnetLocationFilter", "VrfFilter" : "#/components/schemas/VrfFilter", "NotFilter" : "#/components/schemas/NotFilter" } } }, "NetworkCheckResult" : { "type" : "object", "properties" : { "creationDateMillis" : { "type" : "integer", "format" : "int64", "examples" : [ 1649277285118 ] }, "creator" : { "type" : "string", "description" : "The username of the user who created the check, or null if unknown or if the account was deleted", "examples" : [ "mary" ] }, "creatorId" : { "type" : "string" }, "definition" : { "$ref" : "#/components/schemas/CheckDefinition" }, "definitionDateMillis" : { "type" : "integer", "format" : "int64", "examples" : [ 1649277285118 ] }, "description" : { "type" : "string" }, "editDateMillis" : { "type" : "integer", "format" : "int64", "examples" : [ 1649277285118 ] }, "editor" : { "type" : "string", "description" : "The username of the user who last edited the check, or null if unknown, if the account was deleted, or if the check hasn't been edited", "examples" : [ "steven" ] }, "editorId" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "executionDateMillis" : { "type" : "integer", "format" : "int64", "examples" : [ 1649277285118 ] }, "executionDurationMillis" : { "type" : "integer", "format" : "int64" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "note" : { "type" : "string" }, "numViolations" : { "type" : "integer", "format" : "int64" }, "perfMonitoringEnabled" : { "type" : "boolean", "description" : "Whether performance monitoring is enabled for this check. Only supported for Existential intent checks. Performance monitoring must be independently enabled for each device along the check’s path(s)." }, "priority" : { "type" : "string", "enum" : [ "NOT_SET", "LOW", "MEDIUM", "HIGH" ] }, "status" : { "type" : "string", "enum" : [ "NONE", "PASS", "FAIL", "ERROR", "TIMEOUT", "PROCESSING" ] }, "tags" : { "type" : "array", "items" : { "type" : "string" } } } }, "NetworkCheckResultWithDiagnosis" : { "type" : "object", "properties" : { "creationDateMillis" : { "type" : "integer", "format" : "int64", "examples" : [ 1649277285118 ] }, "creator" : { "type" : "string", "description" : "The username of the user who created the check, or null if unknown or if the account was deleted", "examples" : [ "mary" ] }, "creatorId" : { "type" : "string" }, "definition" : { "$ref" : "#/components/schemas/CheckDefinition" }, "definitionDateMillis" : { "type" : "integer", "format" : "int64", "examples" : [ 1649277285118 ] }, "description" : { "type" : "string" }, "diagnosis" : { "$ref" : "#/components/schemas/CheckDiagnosis" }, "editDateMillis" : { "type" : "integer", "format" : "int64", "examples" : [ 1649277285118 ] }, "editor" : { "type" : "string", "description" : "The username of the user who last edited the check, or null if unknown, if the account was deleted, or if the check hasn't been edited", "examples" : [ "steven" ] }, "editorId" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "executionDateMillis" : { "type" : "integer", "format" : "int64", "examples" : [ 1649277285118 ] }, "executionDurationMillis" : { "type" : "integer", "format" : "int64" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "note" : { "type" : "string" }, "numViolations" : { "type" : "integer", "format" : "int64" }, "perfMonitoringEnabled" : { "type" : "boolean", "description" : "Whether performance monitoring is enabled for this check. Only supported for Existential intent checks. Performance monitoring must be independently enabled for each device along the check’s path(s)." }, "priority" : { "type" : "string", "enum" : [ "NOT_SET", "LOW", "MEDIUM", "HIGH" ] }, "status" : { "type" : "string", "enum" : [ "NONE", "PASS", "FAIL", "ERROR", "TIMEOUT", "PROCESSING" ] }, "tags" : { "type" : "array", "items" : { "type" : "string" } } } }, "NewNetworkCheck" : { "required" : [ "definition" ], "type" : "object", "properties" : { "definition" : { "$ref" : "#/components/schemas/CheckDefinition" }, "enabled" : { "type" : "boolean" }, "name" : { "type" : "string" }, "note" : { "type" : "string" }, "perfMonitoringEnabled" : { "type" : "boolean", "description" : "Whether performance monitoring is enabled for this check. Only supported for Existential intent checks. Performance monitoring must be independently enabled for each device along the check’s path(s)." }, "priority" : { "type" : "string", "enum" : [ "NOT_SET", "LOW", "MEDIUM", "HIGH" ] }, "tags" : { "type" : "array", "items" : { "type" : "string" } } } }, "NotFilter" : { "required" : [ "type" ], "type" : "object", "properties" : { "clause" : { "$ref" : "#/components/schemas/FlowHopFilter" }, "type" : { "type" : "string", "enum" : [ "NotFilter" ] } }, "description" : "A filter that inverts the filter in its `clause`" }, "NqeCheck" : { "required" : [ "checkType", "queryId" ], "type" : "object", "properties" : { "checkType" : { "type" : "string", "enum" : [ "NQE" ] }, "queryId" : { "type" : "string", "examples" : [ "FQ_6ac3682c92a74b778d98584aea8afa5fe40f2150" ] }, "params" : { "type" : "object", "additionalProperties" : { }, "description" : "Values for each parameter declared in the query. The parameter values are specified as a JSON object, with one property per parameter, where the property name matches the parameter name. The property value is the JSON representation of the parameter value. The JSON representation of a parameter value depends on the type of the value. For values of type `String`, `IpAddress`, `IpSubnet`, and `MacAddress`, the JSON representation is a JSON string. For values of type `Number`, the value is an integral JSON number. For values of type `Boolean`, the JSON representation is true or false. For values of type `List`, the JSON representation is an array of JSON values, each of which is a JSON representation for type `T`. For record values, the JSON representation is a JSON object with corresponding properties whose values are JSON representations corresponding to the properties' types. For enumerations, the JSON representation is a JSON string with the enum constant name. For `oneOf` values that contain data, the JSON representation is a JSON object with two properties, `alternative` and `value`, where the `alternative` property contains the alternative's name (a string) and the `value` property is a JSON representation of the data associated with this alternative.", "examples" : [ { "mtuThreshold" : 123, "ntpServers" : [ "10.22.2.3", "192.33.4.1" ] } ] } } }, "PacketAliasFilter" : { "required" : [ "type", "value" ], "type" : "object", "properties" : { "direction" : { "type" : "string", "enum" : [ "src", "dst" ] }, "type" : { "type" : "string", "enum" : [ "PacketAliasFilter" ] }, "value" : { "type" : "string", "description" : "A Packet Header Set name" } }, "description" : "A filter that matches any combination of packet header values that satisfy the criteria in a Header Set" }, "PacketFilter" : { "required" : [ "type", "values" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "PacketFilter" ] }, "values" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } }, "examples" : [ { "ipv4_dst" : [ "10.10.10.0/24" ] } ] } }, "description" : "A filter that matches a specific packet header value or range of values" }, "PacketHeaderFilter" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "PacketFilter", "PacketAliasFilter", "NotFilter" ] } }, "discriminator" : { "propertyName" : "type", "mapping" : { "PacketFilter" : "#/components/schemas/PacketFilter", "PacketAliasFilter" : "#/components/schemas/PacketAliasFilter", "NotFilter" : "#/components/schemas/NotFilter" } } }, "PathQuery" : { "type" : "object", "properties" : { "bypass" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BypassFilter" } }, "chain" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HopFilter" } }, "flowTypes" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "VALID", "LOOP", "POTENTIAL_LOOP", "BLACKHOLE", "DROPPED", "INADMISSIBLE", "UNREACHABLE", "IGNORED", "UNDELIVERED" ] } }, "forwardingTypes" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "L2", "L3", "DIRECT_L2", "FABRIC_PATH", "VXLAN", "MCAST_IP", "DIRECT_IP", "MPLS", "L2_PBR", "L3_PBR" ] } }, "from" : { "$ref" : "#/components/schemas/EndpointFilter" }, "mode" : { "type" : "string", "enum" : [ "PERMIT_ALL" ] }, "to" : { "$ref" : "#/components/schemas/EndpointFilter" } } }, "PredefinedCheck" : { "required" : [ "checkType" ], "type" : "object", "properties" : { "checkType" : { "type" : "string", "enum" : [ "Predefined" ] }, "params" : { "type" : "object" }, "predefinedCheckType" : { "type" : "string", "enum" : [ "BGP_NEIGHBOR_ADJACENCY", "BGP_ROUTER_ID", "BGP_ROUTE_CONSISTENCY", "BGP_VPC_PARAMETER_CONSISTENCY", "EBGP_SELECTION_OVER_IBGP", "BGP_COMMUNITY_LIST", "NEXT_HOP_REACHABILITY", "NO_LOOP", "SHORTEST_PATH", "IP_UNIQUENESS", "HOSTNAME_CONSISTENCY", "HOSTNAME_UNIQUENESS", "VLAN_CONSISTENCY", "MTU_CONSISTENCY", "PORT_CHANNEL_CONSISTENCY", "DUPLEX_CONSISTENCY", "LINK_SPEED_CONSISTENCY", "SOFTWARE_VERSION_CONSISTENCY", "TRUNK_INTERFACE_WHITELIST", "VLAN_EXISTENCE", "LEARNED_MAC_CONSISTENCY", "FHRP_PEERING", "VPC_PARAMETER_CONSISTENCY", "VPC_INTERFACE_PARAMETER_CONSISTENCY", "VPC_DEDICATED_KEEPALIVE_LINK", "VPC_ROLE_PRIORITY", "SSH_RSA_KEY_LENGTH", "VPC_STP_PRIORITY", "VPC_MST_REGION_CONSISTENCY" ] } } }, "QueryStringCheck" : { "required" : [ "checkType" ], "type" : "object", "properties" : { "checkType" : { "type" : "string", "enum" : [ "QueryStringBased" ] }, "forRequest" : { "type" : "string" }, "value" : { "type" : "string" } } }, "ReachabilityCheck" : { "required" : [ "checkType", "filters" ], "type" : "object", "properties" : { "checkType" : { "type" : "string", "enum" : [ "Reachability" ] }, "filters" : { "$ref" : "#/components/schemas/PathQuery" }, "headerFieldsWithDefaults" : { "type" : "array", "description" : "The header fields for which a default value is assumed if no valid is specified in the `from` clause. Defaults to `[\"url\"]`.", "items" : { "type" : "string", "enum" : [ "ip_tos", "tp_src", "app_id", "url", "user_id" ] } }, "noiseTypes" : { "type" : "array", "description" : "The noise types that should be included in the search results. Defaults to `[]`.", "items" : { "type" : "string", "enum" : [ "WRONG_GATEWAY", "INADMISSIBLE", "NETWORK_OR_BROADCAST_ADDRESS", "TO_L2_INTERFACE_MAC", "GLEAN" ] } } } }, "SecurityZoneFilter" : { "required" : [ "device", "type", "value" ], "type" : "object", "properties" : { "device" : { "type" : "string", "examples" : [ "nyc-dc01-rtr-01" ] }, "type" : { "type" : "string", "enum" : [ "SecurityZoneFilter" ] }, "value" : { "type" : "string", "examples" : [ "corp-trusted" ] } }, "description" : "A filter that matches one security zone on a firewall by name and can be used in the `from` or `to` property of a `PathQuery`" }, "SubnetLocationFilter" : { "required" : [ "type", "value" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "SubnetLocationFilter" ] }, "value" : { "type" : "string", "examples" : [ "10.10.10.64/30" ] }, "host" : { "type" : "string", "description" : "The hostname that resolves to the IP in `value` (metadata only; not used directly)", "examples" : [ "testing.example.com" ] }, "device" : { "type" : "string", "description" : "The device at which the subnet is located", "examples" : [ "nyc-dc01-rtr01" ] } }, "description" : "A filter that matches a specific IP address or IP subnet address at a specific location in the network. If the IP address is a multicast group address, this filter matches on the locations of the corresponding multicast Rendezvous Points (RPs) in the network." }, "TunnelInterfaceFilter" : { "required" : [ "type", "value" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "TunnelInterfaceFilter" ] }, "value" : { "type" : "string", "examples" : [ "nyc-dc01-rtr-01 ge3" ] } }, "description" : "A filter that matches one tunnel interface by name and has underlay semantics in the `from` or `to` property of a `PathQuery`" }, "VrfFilter" : { "required" : [ "type", "value" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "VrfFilter" ] }, "value" : { "type" : "string", "description" : "A VRF name. Use `DeviceVrfFilter` instead for a (device, VRF) pair.", "examples" : [ "MY VRF" ] } }, "description" : "A filter that matches device interfaces by VRF name" } }, "securitySchemes" : { "api_token" : { "type" : "http", "scheme" : "basic" } } } }