API Updates for 25.3.0

Release Date: March 18, 2025

We’re pleased to announce the following updates to the Forward Networks API as part of release 25.3.0. This release includes scheduled breaking changes, model updates, and improvements to how device credentials are handled.

For platform-wide changes, see the full Forward Enterprise 25.3.0 Release Notes.

Scheduled Breaking Changes

DeviceCredential and JumpServer ID Handling

The optional id property for device credentials and jump servers will no longer be allowed in API requests. Going forward, the system will always auto-generate IDs for new entries.

Affected API Endpoints:

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

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

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

This change was first announced in the OpenAPI specification for release 24.10.

Credential Segregation by Protocol

Device credentials will be separated into CLI credentials (for SSH/telnet) and HTTP credentials (for HTTP/HTTPS). New API endpoints for managing each type will be introduced in future releases. Current credential APIs will continue to function for at least three major releases, in line with our API change policy.

Affected API Endpoints:

• 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

DeviceCredential

• The password field is now formally required in the schema (behavior remains unchanged).
  Affected API Endpoints:

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

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

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

NqeQueryRunRequestOptions

• Added a new property: itemFormat.
  Affected API Endpoint:

• POST /api/nqe

NqeSimpleValue

• Renamed model: NqeCellValue → CellValue (no functional change).
  Affected API Endpoint:

• POST /api/nqe