API Updates for 24.10.0

We’re excited to share the latest updates and improvements in the Forward Networks API, now available in the 24.10.0 release. For complete release details, see the full release notes.

Specification Changes

• OpenAPI Specification Update: Updated the OpenAPI specification from version 3.0.1 to 3.1.0. The primary change is that example values for parameters and properties are now in an examples array instead of the example property. This update also allows for improved descriptions and examples in many model properties (details here).

Scheduled Breaking Changes

The following breaking changes are scheduled for upcoming releases:

• Network Setup: Removed the optional decommission query parameter. Devices no longer require manual decommissioning and will stop counting toward the licensed device limit 30 days after their most recent successful collection.

  • Affected operation:
    • DELETE /api/networks/{networkId}/deviceSources/{deviceSourceName}

• Network Snapshots: Deprecated collectionFailures and parsingFailures properties, scheduled for removal in release 25.1. Use deviceCollectionFailures and deviceProcessingFailures instead.

  • Affected operation:
    • GET /api/snapshots/{snapshotId}/metrics

• Network Snapshots: Deprecated the numParsingFailureDevices property, scheduled for removal in release 25.1. Use numProcessingFailureDevices instead.

  • Affected operation:
    • GET /api/snapshots/{snapshotId}/metrics

• Network Setup: Deprecated the optional type property of DeviceCredentialUpdate, scheduled for removal in release 25.1.

  • Affected operation:
    • PATCH /api/networks/{networkId}/deviceCredentials/{credentialId}

New Models

• Synthetic Devices: Added SyntheticNatEntry for use with InternetNode.

Model Changes

The following models have been updated to enhance API functionality:

• Device

  • Added: collectionError values TRANSIENT_SLOW_READ_RATE_DETECTED and SOME_OID_FAILED
  • Added: platform value huawei_switch and vendor value HUAWEI
  • Added: platform value mist_ap
  • Removed: Extraneous platform values such as vcenter_api, nsx_t, and bluecat
  • Affected operations:
    • GET /api/networks/{networkId}/devices
    • GET /api/snapshots/{snapshotId}/devices
    • GET /api/snapshots/{snapshotId}/devices/{deviceName}

• DeviceCredentialUpdate

  • Deprecated: The type property is now optional and deprecated for removal in release 25.1.
  • Affected operation: PATCH /api/networks/{networkId}/deviceCredentials/{credentialId}

• DeviceSource, DeviceSourcePatch

  • Added: type values huawei_switch_ssh and mist_dashboard_api
  • Affected operations:
    • GET /api/networks/{networkId}/deviceSources
    • POST /api/networks/{networkId}/deviceSources
    • GET /api/networks/{networkId}/deviceSources/{deviceSourceName}
    • PUT /api/networks/{networkId}/deviceSources/{deviceSourceName}
    • PATCH /api/networks/{networkId}/deviceSources/{deviceSourceName}

• Encryptor

  • Updated: Made the underlayConnection property optional.
  • Affected operations:
    • GET /api/networks/{networkId}/encryptors
    • PUT /api/networks/{networkId}/encryptors
    • GET /api/networks/{networkId}/encryptors/{deviceName}
    • PUT /api/networks/{networkId}/encryptors/{deviceName}
    • PATCH /api/networks/{networkId}/encryptors/{deviceName}

• InternetNode

  • Added: translations property.
  • Affected operations:
    • GET /api/networks/{networkId}/internet-node
    • PUT /api/networks/{networkId}/internet-node

• MissingDevice

  • Added: type and possibleTypes values huawei_switch_ssh
  • Removed: Extraneous type and possibleTypes values, such as vcenter_api, aws_api, and bluecat_https
  • Affected operation: GET /api/snapshots/{snapshotId}/missingDevices

• NewNetworkCheck, NetworkCheckResult, NetworkCheckResultWithDiagnosis

  • Added: perfMonitoringEnabled property.
  • Affected operations:
    • GET /api/snapshots/{snapshotId}/checks
    • POST /api/snapshots/{snapshotId}/checks
    • GET /api/snapshots/{snapshotId}/checks/{checkId}

• SnapshotMetrics

  • Added: deviceCollectionFailures and deviceProcessingFailures properties
  • Deprecated: collectionFailures and parsingFailures properties, scheduled for removal in release 25.1
  • Added: endpointCollectionFailures, endpointProcessingFailures, and numProcessingFailureDevices properties
  • Deprecated: numParsingFailureDevices property, scheduled for removal in release 25.1
  • Affected operation: GET /api/snapshots/{snapshotId}/metrics

• Vulnerability

  • Added: os value huawei_switch and vendor value HUAWEI
  • Added: os value mist_ap
  • Removed: Extraneous os values, such as unknown, aws_subnet, and nsx_t
  • Affected operation: GET /api/snapshots/{snapshotId}/vulnerabilities