API Updates for 24.9.0

We’re pleased to announce the following updates to the Forward Networks API as part of release 24.9.0.

See also the full release notes for Forward Enterprise version 24.9.0.

Scheduled Breaking Changes

• Networks: The lastAccessedAt property of Network and NetworkSnapshots has been removed. The secondsToExpiry property can be used instead to determine how much longer a temporary Workspace network will last without use.
  Affected operations:

  • GET /api/networks
  • GET /api/networks/{networkId}/snapshots

• Network Setup: In release 24.10, the optional decommission query parameter will be removed. Devices will no longer be decommissioned manually; they will automatically stop counting toward the licensed device limit 30 days after their last successful collection.
  Affected operation:

  • DELETE /api/networks/{networkId}/deviceSources/{deviceSourceName}

Operation Behavior Changes

• Network Locations: Locations can now be set for any modeled device, including devices typically anchored to other devices (e.g., virtual contexts and wireless access points). This is possible by including the snapshotId parameter in the request URL’s query string.
  Affected operation:
  • PATCH /api/networks/{networkId}/atlas

New Models

• NQE: New column filtering models introduced to support upper and/or lower bounds.
  • BetweenColumnFilter
  • DefaultColumnFilter

Model Changes

• ColumnFilter: Added the operator property.
  Affected operation:

  • POST /api/nqe

• Device: Updates to the type and platform values.

  • Added type value AWS_LOCAL_GW and platform value aws_local_gw
  • Added collectionError value BMP_SESSION_ALREADY_ESTABLISHED
  • Added platform value meraki_mr
    Affected operations:
    • GET /api/networks/{networkId}/devices
    • GET /api/snapshots/{snapshotId}/devices
    • GET /api/snapshots/{snapshotId}/devices/{deviceName}

• MissingDevice: Added type and possibleTypes value meraki_mr_api.
  Affected operation:

  • GET /api/snapshots/{snapshotId}/missingDevices

• Network, NetworkSnapshots: Removed the lastAccessedAt property.
  Affected operations:

  • GET /api/networks
  • GET /api/networks/{networkId}
  • GET /api/networks/{networkId}/snapshots

• PathHop: Added properties for additional details.

  • Added backfilledFrom property
  • Added deviceType value AWS_LOCAL_GW
    Affected operations:
    • GET /api/networks/{networkId}/paths
    • POST /api/networks/{networkId}/paths-bulk
    • POST /api/networks/{networkId}/paths-bulk-seq

• Vulnerability: Added os values for new device types.

  • Added os value aws_local_gw
  • Added os value meraki_mr
    Affected operation:
    • GET /api/snapshots/{snapshotId}/vulnerabilities