API Release Notes - 24.7.0

Scheduled Breaking Changes

1. Networks:

   • Change: In release 24.9, the lastAccessedAt property will be removed from Network and NetworkSnapshots.
   • Replacement: Use secondsToExpiry instead.
   • Affected Operations:
     • GET /api/networks
     • GET /api/networks/{networkId}/snapshots

2. Network Setup:

   • Change: In release 24.10 the optional decommission query parameter will be removed.
   • New Behavior: Devices automatically stop counting toward the licensed device limit 30 days after their last successful collection.
   • Affected Operations:
     • DELETE /api/networks/{networkId}/deviceSources/{deviceSourceName}

Query Parameter Changes

1. Path Search:

   • Change: Added the from parameter.
   • Affected Operation:
     • GET /api/networks/{networkId}/paths

2. Network Setup:

   • Change: The decommission parameter is now ignored.
   • New Behavior: Devices automatically stop counting toward the licensed device limit 30 days after their last successful collection.
   • Affected Operation:
     • DELETE /api/networks/{networkId}/deviceSources/{deviceSourceName}

Model Changes

1. CollectorState:

   • Change: Removed hasDevicesConfigured, isOnline, and isIdle.
   • Affected Operations:
     • GET /api/networks/{networkId}/collector/status

2. Device:

   • Change: Added platform value cisco_wireless.
   • Affected Operations:
     • GET /api/networks/{networkId}/devices
     • GET /api/snapshots/{snapshotId}/devices
     • GET /api/snapshots/{snapshotId}/devices/{deviceName}

3. DeviceSource and DeviceSourcePatch:

   • Changes: Added type values checkpoint_ssh_nonexpert and cisco_wireless_api.
   • 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}

4. JumpServer and JumpServerUpdate:

   • Change: Added sshKey property.
   • Affected Operations:
     • GET /api/networks/{networkId}/jumpServers
     • POST /api/networks/{networkId}/jumpServers
     • PATCH /api/networks/{networkId}/jumpServers/{jumpServerId}

5. MissingDevice:

   • Changes: Added type and possibleTypes values checkpoint_ssh_nonexpert and cisco_wireless_api.
   • Affected Operation:
     • GET /api/snapshots/{snapshotId}/missingDevices

6. NqeCheck:

   • Change: Removed the commitId property.
   • Affected Operations:
     • GET /api/snapshots/{snapshotId}/checks
     • POST /api/snapshots/{snapshotId}/checks
     • PATCH /api/snapshots/{snapshotId}/checks/{checkId}

7. NqeQueryRunRequest:

   • Change: Made the commitId property required for deleted NQE queries.
   • Affected Operation:
     • POST /api/nqe

8. PathSearchQuery:

   • Change: Added the from property.
   • Affected Operations:
     • POST /api/networks/{networkId}/paths-bulk
     • POST /api/networks/{networkId}/paths-bulk-seq

9. Vulnerability:

   • Change: Added os value cisco_wireless.
   • Affected Operation:
     • GET /api/snapshots/{snapshotId}/vulnerabilities

Notable Changes to Unpublished APIs

1. Device Decommissioning:

   • Change: Removed support for device decommissioning.
   • Removed: POST /api/licensed-devices?action=decommission

2. License Retrieval:

   • Change: Moved operation for license retrieval.
   • Removed: GET /api/license
   • Added: GET /api/licenses

3. License Activation (On-Prem Deployments Only):

   • Change: Moved operation for license activation.
   • Removed: PUT /api/vm/activeLicense
   • Added: POST /api/licenses