{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Orgs Clients - Wired API", "version": "2604.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Orgs Clients - Wired", "type": "folder" }, "items": [ { "info": { "name": "countOrgWiredClients", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/wired_clients/count", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "distinct", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Count by Distinct Attributes of Clients\n\nNote: For list of available `type` values, please refer to [List Client Events Definitions](/#operations/listClientEventsDefinitions)" }, { "info": { "name": "searchOrgWiredClients", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/wired_clients/search", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "auth_state", "value": "", "type": "query", "description": "Authentication state" }, { "name": "auth_method", "value": "", "type": "query", "description": "Authentication method" }, { "name": "source", "value": "", "type": "query", "description": "source from where the client was learned (lldp, mac)" }, { "name": "site_id", "value": "", "type": "query", "description": "Site ID" }, { "name": "device_mac", "value": "", "type": "query", "description": "Device mac (Gateway/Switch) where the client has connected to" }, { "name": "mac", "value": "", "type": "query", "description": "Partial / full Client MAC Address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported" }, { "name": "port_id", "value": "", "type": "query", "description": "Port id where the client has connected to" }, { "name": "vlan", "value": "", "type": "query", "description": "VLAN" }, { "name": "ip", "value": "", "type": "query" }, { "name": "manufacture", "value": "", "type": "query", "description": "Client manufacturer" }, { "name": "text", "value": "", "type": "query", "description": "Partial / full Client MAC Address, hostname or username. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*ddeeff`) are not supported" }, { "name": "nacrule_id", "value": "", "type": "query", "description": "nacrule_id" }, { "name": "dhcp_hostname", "value": "", "type": "query", "description": "DHCP Hostname" }, { "name": "dhcp_fqdn", "value": "", "type": "query", "description": "DHCP FQDN" }, { "name": "dhcp_client_identifier", "value": "", "type": "query", "description": "DHCP Client Identifier" }, { "name": "dhcp_vendor_class_identifier", "value": "", "type": "query", "description": "DHCP Vendor Class Identifier" }, { "name": "dhcp_request_params", "value": "", "type": "query", "description": "DHCP Request Parameters" }, { "name": "limit", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "sort", "value": "", "type": "query", "description": "On which field the list should be sorted, -prefix represents DESC order" }, { "name": "search_after", "value": "", "type": "query", "description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed." } ] }, "docs": "Search for Wired Clients in org\n\nNote: For list of available `type` values, please refer to [List Client Events Definitions](/#operations/listClientEventsDefinitions)" } ] } ], "bundled": true }