Qodex.ai

getOrgInventory - Send and Download

GET https://{{host}}/api/v1/orgs/:org_id/inventory

Response Parameters

Parameter|Type|Description serial|string|device serial model|string|device model type|string|device type, ap mac|string|MAC address name|string|device name if assigned id|string|device id siteid|string|site id if assigned, null if not assigned deviceprofileid|string|deviceprofile id if assigned, null if not assigned connected|boolean|whether the AP is connected createdtime|long|inventory created time, in epoch modifiedtime|long|inventory last modified time, in epoch

Query Options

  • Filtered Inventory by
    • model
    • serial
    • magic
    • site_id
    • type
    • mac
    • vc_mac
    • vc

Example: https://{{host}}/api/v1/orgs/:org_id/inventory?model=AP41

VC (Virtual-Chassis) Management

Ideally VC should be managed as a single device - where - one managed entity where config / monitoring is anchored against (with a stable identify MAC) - all members appears in the inventory

In our implementation, we strive to achieve that without manual user configurations by 1. during claim or adoption a VC, we require FPC0 to exist and will use its MAC as identify for the entire chassis 2. other VC members will be automatically populated when they’re all present

The perceivable result is 1. from /sites/:siteid/stats/devices/:fpc0mac API, you’d see the VC where modulestat contains the VC members 2. from /orgs/:orgid/inventory?vc=true API, you’d see all VC members with vc_mac pointing to the FPC0