API Updates for 25.5.0

Release Date: May 20, 2025

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

For platform-wide updates, see the full Forward Enterprise 25.5.0 Release Notes.

Breaking Changes

Compact System-Generated IDs

Device credentials (CLI, HTTP, and SNMP), jump servers, and internet proxies now use a new compact, system-generated ID format. This update enhances consistency and efficiency across the API.

Most customers should not experience disruption. However, if you have stored credential, jump server, or proxy IDs externally (outside the Forward Platform), you will need to update them.

Affected API Endpoints:

• CLI Credentials

  • GET, PATCH: /api/networks/{networkId}/cli-credentials

  • GET, PATCH, DELETE: /api/networks/{networkId}/cli-credentials/{credentialId}

• HTTP Credentials

  • GET, PATCH: /api/networks/{networkId}/http-credentials

  • GET, PATCH, DELETE: /api/networks/{networkId}/http-credentials/{credentialId}

• Legacy Device Credentials

  • GET, PATCH: /api/networks/{networkId}/deviceCredentials

  • PATCH, DELETE: /api/networks/{networkId}/deviceCredentials/{credentialId}

• Device Sources

  • GET, POST: /api/networks/{networkId}/deviceSources

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

• Jump Servers

  • GET: /api/networks/{networkId}/jumpServers

  • PATCH, DELETE: /api/networks/{networkId}/jumpServers/{jumpServerId}

Scheduled Breaking Changes

Deprecation of Legacy Device Credential Endpoints

The legacy deviceCredentials API endpoints are scheduled for removal in release 25.7. Please migrate to the cli-credentials and http-credentials endpoints.

Endpoints to be removed in 25.7:

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

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

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

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

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

Model Changes

Device

• Added a new processingError value: MODELING_EXCEPTION

  • This helps distinguish devices that encountered modeling issues during processing.

Affected API Endpoints:

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

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

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