How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Forward Networks Checks API

Enable or define automated checks that verify network policy and behavior

Forward Networks Checks API is one of 20 APIs that Forward Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Checks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 26.6.

Requests are made against a single base URL, /api.

6 operations 3 paths 42 schemas 2 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.6
Base URL
https://fwd.app/api
Authentication
HTTP Basic
License
Resource Areas
1

Authentication & Security 1

Forward Networks Checks API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (api_token).

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 2 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Checks 6

Enable or define automated checks that verify network policy and behavior

GET
/predefinedChecks
Get available Predefined checks
getAvailablePredefinedChecks → 200
GET
/snapshots/{snapshotId}/checks
Get checks (with status)
getChecks 4 params → 200409
POST
/snapshots/{snapshotId}/checks
Add a check
addCheck 2 params body → 200409
DELETE
/snapshots/{snapshotId}/checks
Deactivate all checks
deactivateChecks 1 param → 200
GET
/snapshots/{snapshotId}/checks/{checkId}
Get a check (with status)
getCheck 2 params → 200409
DELETE
/snapshots/{snapshotId}/checks/{checkId}
Deactivate a check
deactivateCheck 2 params → 200

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are NetworkCheckResult (20 properties), NewNetworkCheck (7 properties), PathQuery (7 properties), ExistsCheck (5 properties). Each schema is shown below with its type and property counts.

SubnetLocationFilter
object
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 fi…
4 properties 2 required
DeviceFilter
object
A filter that matches one device by name or all devices (using value "")
2 properties 2 required
ReachabilityCheck
object
4 properties 2 required
HostFilter
object
A filter that matches hosts by hostname, IP subnet address, or MAC address
2 properties 2 required
BypassFilter
object
1 property 1 required
PathQuery
object
7 properties
HopFilter
object
3 properties 2 required
NqeCheck
object
3 properties 2 required
CheckType
string
HopLocationFilter
object
1 property 1 required
DiagnosisDetail
object
2 properties
SecurityZoneFilter
object
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
3 properties 3 required
QueryStringCheck
object
3 properties 1 required
NoiseType
string
NotFilter
object
A filter that inverts the filter in its clause
2 properties 1 required
PredefinedCheck
object
3 properties 1 required
EndpointFilter
object
3 properties 1 required
DeviceVrfFilter
object
A filter that matches a device’s interfaces by VRF name
3 properties 3 required
DiagnosisReference
object
3 properties
TunnelInterfaceFilter
object
A filter that matches one tunnel interface by name and has underlay semantics in the from or to property of a PathQuery
2 properties 2 required
NetworkCheckResultWithDiagnosis
ErrorInfo
object
4 properties 3 required
NewNetworkCheck
object
7 properties 1 required
NetworkCheckResult
object
20 properties
AvailablePredefinedCheck
object
3 properties
CheckDefinition
object
1 property 1 required
LocationFilter
object
1 property 1 required
InterfaceFilter
object
A filter that matches one device interface by name
2 properties 2 required
CheckStatus
string
CheckPriority
string
VrfFilter
object
A filter that matches device interfaces by VRF name
2 properties 2 required
PacketAliasFilter
object
A filter that matches any combination of packet header values that satisfy the criteria in a Header Set
3 properties 2 required
PacketHeaderFilter
object
1 property 1 required
CheckDiagnosis
object
3 properties
LineRange
object
2 properties
PacketFilter
object
A filter that matches a specific packet header value or range of values
2 properties 2 required
DeviceAliasFilter
object
A filter that matches any device in a Device Group
2 properties 2 required
IsolationCheck
object
4 properties 2 required
ExistsCheck
object
5 properties 2 required
HostAliasFilter
object
A filter that matches any host in a Host Group
2 properties 2 required
InterfaceAliasFilter
object
A filter that matches any device interface in an Interface Group
2 properties 2 required
PredefinedCheckType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

forward-networks-checks-api-openapi.yml Raw ↑

Other APIs Forward Networks publishes across the network.

Forward Networks Aliases API
Forward Networks Classic Devices API
Forward Networks Credentials API
Forward Networks Current Version API
Forward Networks Device Tags API
Forward Networks Jump Servers API
Forward Networks Network Collection API
Forward Networks Network Devices API
Forward Networks Network Endpoints API
Forward Networks Network Locations API
Forward Networks Network Snapshots API
Forward Networks Network Topology API
Where this information came from

This is an independent, third-party profile of Forward Networks Checks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.