API Updates for 24.8.0

Released: 2024-08-22

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

See also the API release notes for Forward Enterprise version 24.8.0.

Scheduled Breaking Changes

Networks:
In release 24.9, the lastAccessedAt property of Network and NetworkSnapshots will be removed. The secondsToExpiry property can be used to determine how much longer a temporary Workspace network will be available before expiration if it isn't used.

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 are no longer decommissioned manually. Instead, devices stop counting toward the licensed device limit 30 days after their most recent successful collection.

Affected operation:

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

New Operations

NQE Query Diffing:
A new API operation has been added to identify the differences in an NQE query’s results between two snapshots of a network.

New operation:

• POST /api/nqe-diffs/{before}/{after}

New Models

NQE Query Result Differences:

• NqeDiffEntry
• NqeDiffRequest
• NqeDiffResult 

Model Changes

CreateWorkspaceNetworkRequest:
The default value for retentionDays has been changed from null (permanent) to 7 days.

Affected operation:

• POST /api/networks/{networkId}/workspaces

Device:
Added platform value dell_sonic.

Affected operations:

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

DeviceSource, DeviceSourcePatch:
Added type value sonic_dell_enterprise_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}

JumpServer, JumpServerUpdate:
Added sshCert property to support certificate-based authentication.

Affected operations:

• GET /api/networks/{networkId}/jumpServers
• POST /api/networks/{networkId}/jumpServers
• PATCH /api/networks/{networkId}/jumpServers/{jumpServerId}

MissingDevice:
Added type and possibleTypes value sonic_dell_enterprise_ssh.

Affected operation:

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

Vulnerability:
Added os value dell_sonic.

Affected operation:

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