Skip to main content

API Release Notes - 24.4.0

  • April 24, 2024
  • 0 replies
  • 18 views

davetee
Community Manager
Forum|alt.badge.img

24.4.0 - Apr 11

Released: 2024-04-11

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

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


Breaking change preannouncements

  • BUG-9714 NQE: In release 24.7, the commitId property of NqeQueryRunRequest will be required in conjunction with queryId to run a query that has been deleted from the Org repository.
    • Affected operation:
      • POST /api/nqe

Specification changes

  • BUG-10631 Authentication: Renamed the Basic authentication security scheme ("Email/Password" → "api_token") to eliminate a specification validation error. API behavior did not change.

Retired operations

  • FWD-31290 Network Devices: GET /api/snapshots/…/devices (deprecated since release 23.11)

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

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

  • FWD-31298 Path Search: GET /api/snapshots/…/paths (deprecated since release 23.9)

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

      → GET /api/networks/{networkId}/paths[?snapshotId={snapshotId}]

    • POST /api/snapshots/{snapshotId}/pathsBulk

      → POST /api/networks/{networkId}/paths-bulk[?snapshotId={snapshotId}]

    • POST /api/snapshots/{snapshotId}/pathsBulkSeq

      → POST /api/networks/{networkId}/paths-bulk-seq[?snapshotId={snapshotId}]


Model changes

  • CollectorState

    • FWD-36440 Deprecated the hasDevicesConfiguredisOnline, and isIdle properties for removal in release 24.7
    • Affected operations:
      • GET /api/networks/{networkId}/collector/status
  • ExistsCheck

    • FWD-35330 Removed the andBack property (deprecated since release 24.1)
    • FWD-35397 Designated checkType as required (for IsolationCheck and ReachabilityCheck too)
    • Affected operations:
      • GET /api/snapshots/{snapshotId}/checks
      • POST /api/snapshots/{snapshotId}/checks
      • GET /api/snapshots/{snapshotId}/checks/{checkId}