Dashboard

GET /dashboard/dcim

Get DCIM statistics

Status Codes:

• 200 OK – DCIM statistics

• 503 Service Unavailable – No dashboard data source configured

GET /dashboard/ipam

Get IPAM statistics

Status Codes:

• 200 OK – IPAM statistics

• 503 Service Unavailable – No dashboard data source configured

GET /dashboard/provision-status

Get device counts by provision_status

Status Codes:

• 200 OK – Provision status statistics

• 503 Service Unavailable – No dashboard data source configured

Response JSON Object:

• configured (integer)

• configuring (integer)

• decommissioning (integer)

• dell (integer)

• discovered (integer)

• hpe (integer)

• misc (object)

• provisioned (integer)

• provisioning (integer)

• ready (integer)

• supermicro (integer)

• total (integer)

GET /dashboard/site

Get site dashboard data

Retrieve complete dashboard data for the site in NETBOX_SITE_NAME, from whichever provider is active (NetBox plugin or core inventory).

Status Codes:

• 200 OK – Dashboard data

• 400 Bad Request – NETBOX_SITE_NAME not configured

• 404 Not Found – Site not found

• 503 Service Unavailable – No dashboard data source configured

Response JSON Object:

• dns.domain (string)

• dns.internal_primary (string)

• dns.internal_secondary (string)

• dns.primary (string)

• id (string)

• location.city (string)

• location.data_center_zone (string)

• location.rack (string)

• location.state (string)

• name (string)

• ntp.primary (string)

• ntp.secondary (string)

• ntp.tertiary (string)

• site_info.facility_id (string)

• site_info.site_type_name (string)

• site_info.tier_certification (string)

• statistics.environment (string)

• statistics.postal_code (string)

• statistics.power_capacity (number) – kW (placeholder: 0.0)

• statistics.total_capacity (integer) – Total racks

• statistics.total_nodes (integer) – Total devices

• statistics.total_vlans (integer)

• statistics.zone_counter (string)

• status (string)