API Updates for 24.11.0

We’re excited to share the latest updates and improvements in the Forward Networks API, now available in the 24.11.0 release. For complete release details, see the full release notes.

Scheduled Breaking Changes

• Network Snapshots:

  • The collectionFailures and parsingFailures properties have been deprecated and will be removed in release 25.1. Use deviceCollectionFailures and deviceProcessingFailures instead.
    Affected operations:

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

  • The numParsingFailureDevices property has been deprecated and will be removed in release 25.1. Use numProcessingFailureDevices instead.
    Affected operations:

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

• Network Setup:

  • The optional type property of DeviceCredentialUpdate is deprecated and will be removed in release 25.1.
    Affected operations:
    • PATCH /api/networks/{networkId}/deviceCredentials/{credentialId}

Model Changes

• Device:

  • Added collectionError value API_SERVER_FAILED_TO_RESPOND for collection from AWS.
  • Added platform value f5_os_hypervisor.
    Affected operations:
    • GET /api/networks/{networkId}/devices
    • GET /api/snapshots/{snapshotId}/devices
    • GET /api/snapshots/{snapshotId}/devices/{deviceName}

• DeviceSource, DeviceSourcePatch:

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

• InterfaceFunction:

  • Added securityZone property.
    Affected operations:
    • GET /api/networks/{networkId}/paths
    • POST /api/networks/{networkId}/paths-bulk
    • POST /api/networks/{networkId}/paths-bulk-seq

• InternetNodePatch:

  • Added translations property.
    Affected operation:
    • PATCH /api/networks/{networkId}/internet-node

• MissingDevice:

  • Added type and possibleTypes value f5_os_hypervisor_ssh.
    Affected operation:
    • GET /api/snapshots/{snapshotId}/missingDevices

• Vulnerability:

  • Added os value f5_os_hypervisor.
    Affected operation:
    • GET /api/snapshots/{snapshotId}/vulnerabilities

Notable Changes to Unpublished APIs

This section describes changes to API operations that are not published in the Forward Networks API documentation and therefore have no stability guarantees. It is included as a courtesy to those who may be interested.

• Added the deviceName property back to each connectivity test result JSON object. This property was mistakenly removed in release 24.10.
  Affected operation:
  • GET /api/networks/{networkId}/connectivityTests