API Updates for 25.1.0

API Updates for Version 25.1.0

Released: 2025-01-21

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

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

Scheduled Breaking Changes

• Network Snapshots:

  • The collectionFailures and parsingFailures properties of SnapshotMetrics have been removed. Use deviceCollectionFailures and deviceProcessingFailures instead. These properties were deprecated in release 24.10.0.

    • Affected operations:
      • GET /api/snapshots/{snapshotId}/metrics

  • The numParsingFailureDevices property of SnapshotMetrics has been removed. Use numProcessingFailureDevices instead. This property was deprecated in release 24.10.0.

    • Affected operations:
      • GET /api/snapshots/{snapshotId}/metrics

• Network Setup:

  • The optional type property of DeviceCredentialUpdate has been removed. It was deprecated in release 24.10.0.

    • Affected operations:
      • PATCH /api/networks/{networkId}/deviceCredentials/{credentialId}

New Operations

• User Accounts:
  • GET /api/users
  • POST /api/users
  • GET /api/users/{userId}
  • PATCH /api/users/{userId}
  • DELETE /api/users/{userId}

Model Changes

• Device:

  • Added platform value aruba_cx_switch
  • Affected operations:
    • GET /api/networks/{networkId}/devices
    • GET /api/snapshots/{snapshotId}/devices
    • GET /api/snapshots/{snapshotId}/devices/{deviceName}

• DeviceCredentialUpdate:

  • Removed the optional type property
  • Affected operations:
    • PATCH /api/networks/{networkId}/deviceCredentials/{credentialId}

• DeviceSource, DeviceSourcePatch:

  • Added type value aruba_cx_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}

• JumpServer, JumpServerUpdate:

  • Added commandFormat value PANORAMA
  • Affected operations:
    • GET /api/networks/{networkId}/jumpServers
    • POST /api/networks/{networkId}/jumpServers
    • PATCH /api/networks/{networkId}/jumpServers/{jumpServerId}

• MissingDevice:

  • Added type and possibleTypes value aruba_cx_switch_ssh
  • Affected operations:
    • GET /api/snapshots/{snapshotId}/missingDevices

• SnapshotMetrics:

  • Removed the collectionFailures and parsingFailures properties
  • Removed the numParsingFailureDevices property
  • Affected operations:
    • GET /api/snapshots/{snapshotId}/metrics

• Vulnerability:

  • Added os value aruba_cx_switch
  • Affected operations:
    • GET /api/snapshots/{snapshotId}/vulnerabilities