Skip to main content

API Updates for 25.8.0

  • August 22, 2025
  • 0 replies
  • 10 views

kevinbrasher
Employee

Released: 2025-08-19

 

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

For more details, see the full Forward Enterprise API 25.8.0 release notes.

 


 

Breaking changes

 

None.

 


 

Scheduled breaking changes

  • Network Setup – Legacy /deviceSources operations are deprecated for removal in release 25.9. Use the /classic-devices operations instead.

    • Affected operations:

      • GET/POST/DELETE /api/networks/{networkId}/deviceSources

      • GET/PUT/PATCH/DELETE /api/networks/{networkId}/deviceSources/{deviceSourceName}

  • Network Devices – Snapshot-scoped device operations are deprecated for removal in release 25.9. Use /api/networks/{networkId}/devices/... and /missing-devices instead.

    • Affected operations:

      • GET /api/snapshots/{snapshotId}/devices/{deviceName}

      • GET /api/snapshots/{snapshotId}/devices/{deviceName}/files

      • GET /api/snapshots/{snapshotId}/devices/{deviceName}/files/{fileName}

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

  • Network Snapshots – The needsProcessing property in SnapshotMetrics is deprecated for removal in release 25.10. Use snapshotState == "UNPROCESSED" instead.

    • Affected operations:

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

  • Vulnerability Analysis – The snapshot-scoped vulnerability operation is deprecated for removal in release 25.10. Use the network-scoped operation instead.

    • Affected operations:

      • GET /api/snapshots/{snapshotId}/vulnerabilitiesGET /api/networks/{networkId}/vulnerabilities[?snapshotId={snapshotId}]

 


 

Model changes

  • Device – Added type="ALKIRA_CLOUD", vendor="ALKIRA", and platform="alkira_portal".

    • Affected operations:

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

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

      • GET /api/snapshots/{snapshotId}/devices/{deviceName}

  • PathHop – Added deviceType="ALKIRA_CLOUD".

    • Affected operations:

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

      • POST /api/networks/{networkId}/paths-bulk

      • POST /api/networks/{networkId}/paths-bulk-seq

  • Vulnerability, VulnerabilityDeprecated – Added vendor="ALKIRA".

    • Affected operations:

      • GET /api/networks/{networkId}/vulnerabilities[?snapshotId={snapshotId}]

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

 


 

Notable changes to unpublished APIs

  • Snapshot invalidation – The operation has moved to an action-style URL:

    • POST /api/snapshots/{snapshotId}/invalidatePOST /api/snapshots/{snapshotId}?action=invalidate[&reprocess=true]

  • Snapshot-optional URLs – Several snapshot-scoped operations now support network-scoped URLs where snapshotId is optional. If omitted, the latest processed Snapshot is automatically used and identified in the Network-Snapshot response header. The old snapshot-scoped URLs will stop working in release 25.9.

    • Examples include:

      • GET /api/snapshots/{snapshotId}/deviceDisplayNamesGET /api/networks/{networkId}/devices?view=displayNames[&snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/devices?for=uiGET /api/networks/{networkId}/devices?for=ui[&snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/devices-without-snapshotsGET /api/networks/{networkId}/devices-without-snapshots[?snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/devices/{deviceName}?for=uiGET /api/networks/{networkId}/devices/{deviceName}?for=ui[&snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/devices/{deviceName}/bgp-peers/vrfsGET /api/networks/{networkId}/devices/{deviceName}/bgp-peer-vrfs[?snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/devices/{deviceName}/files?for=uiGET /api/networks/{networkId}/devices/{deviceName}/files?for=ui[&snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/devices/{deviceName}/hostsGET /api/networks/{networkId}/devices/{deviceName}/hosts[?snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/devices/{deviceName}/interfacesGET /api/networks/{networkId}/devices/{deviceName}/interfaces[?snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/devices/{deviceName}/interfaces/{interfaceName}GET /api/networks/{networkId}/devices/{deviceName}/interfaces/{interfaceName}[?snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/devices/{deviceName}/bgp-advertisementsGET /api/networks/{networkId}/devices/{deviceName}/bgp-advertisements[?snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/devices/{deviceName}/vrfs/{vrfName}GET /api/networks/{networkId}/devices/{deviceName}/vrfs/{vrfName}[?snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/hosts/{hostSpecifier}GET /api/networks/{networkId}/hosts/{hostSpecifier}[?snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/vrfsGET /api/networks/{networkId}/vrfs[?snapshotId={snapshotId}]

      • GET /api/snapshots/{snapshotId}/vrfs/{vrfName}GET /api/networks/{networkId}/vrfs/{vrfName}[?snapshotId={snapshotId}]