API Updates for 24.12.0

Release Date: 2024-12-17

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

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

Scheduled Breaking Changes

Network Snapshots

The following properties are deprecated and scheduled for removal in release 25.1. Use the updated properties instead:

• collectionFailures → Use deviceCollectionFailures
• parsingFailures → Use deviceProcessingFailures
• numParsingFailureDevices → Use numProcessingFailureDevices

Affected operation:

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

Network Setup

The type property of DeviceCredentialUpdate is deprecated and will be removed in release 25.1.

Affected operation:

• PATCH /api/networks/{networkId}/deviceCredentials/{credentialId}

Model Changes

Device

Added platform value: versa_switch

Affected operations:

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

DeviceSource, DeviceSourcePatch

Added type values:

• cisco_ndo_api
• versa_switch_ssh

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}

MissingDevice

Added type and possibleTypes value: versa_switch_ssh

Affected operation:

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

Vulnerability

Added OS value: versa_switch

Affected operation:

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

Notable Changes to Unpublished APIs

The following change affects unpublished APIs (no stability guarantees):

• Removed GET /api/networks/{networkId}/external-sources?v=1.

Alternative operations:

• GET /api/networks/{networkId}/end-host-scanners
• GET /api/networks/{networkId}/external-sources?v=2