Skip to content

List active whitelistings (legacy)

Return the MAC addresses of the context's active whitelistings.

Legacy API

This page describes the legacy Sign In API. New integrations use the Sign In API with an Organization API key. The same operation there: List active whitelistings.

GET /v1/org/{organizationId}/contexts/sign-in/{contextId}/modules/whitelistings/active

Returns the MAC addresses of the context’s active whitelistings: the whitelistings that have not ended, whether or not the device is online. Useful for reconciling an asset-management system against the whitelist.

ParameterInTypeRequiredDescription
organizationIdPathstringYesOrganization ID.
contextIdPathstringYesSign-In Context ID.
x-auth-tokenHeaderstringYesContext API key.

Request example

cURL
curl "$API_HOST/v1/org/$ORG_ID/contexts/sign-in/$CTX_ID/modules/whitelistings/active" \
-H "x-auth-token: $NETGRAPH_API_TOKEN"

A JSON array of the MAC addresses of the context’s active whitelistings.

Response example

200
[
"AA:BB:CC:00:00:01",
"AA:BB:CC:00:00:07"
]