OrgsDevice Profiles

listOrgDeviceProfiles

GET
/api/v1/orgs/{org_id}/deviceprofiles

List org-level device profiles, which define reusable AP, switch, or gateway configuration subsets that can be applied to matching devices.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Query Parameters

type?string

Filter results by one device profile type. Use a single value; comma-separated values are not supported. enum: ap, gateway, switch

Default"ap"

Value in

  • "ap"
  • "gateway"
  • "switch"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/deviceprofiles"

[  {    "aeroscout": {      "enabled": true,      "host": "string"    },    "created_time": 0,    "disable_eth1": true,    "disable_module": true,    "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "ip_config": {      "dns": [        "string"      ],      "dns_suffix": [        "string"      ],      "gateway": "192.168.0.1",      "gateway6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",      "ip": "192.168.0.1",      "ip6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",      "mtu": 1500,      "netmask": "192.168.0.1",      "netmask6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",      "type": "static",      "type6": "static",      "vlan_id": 1    },    "mesh": {      "enabled": true,      "group": 1,      "role": "base"    },    "modified_time": 0,    "name": "string",    "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "poe_passthrough": true,    "switch_config": {      "enabled": true,      "eth0": {        "port_vlan_id": 1,        "vlan_ids": [          1,          10        ]      },      "eth1": {        "port_vlan_id": 1,        "vlan_ids": [          10        ]      },      "eth2": {        "port_vlan_id": 1,        "vlan_ids": [          10        ]      },      "eth3": {        "port_vlan_id": 1,        "vlan_ids": [          10        ]      },      "module": {        "port_vlan_id": 1,        "vlan_ids": [          10        ]      },      "wds": {        "port_vlan_id": 1,        "vlan_ids": [          10        ]      }    },    "type": "ap",    "usb_config": {      "cacert": "string",      "enabled": true,      "host": "string",      "type": "imagotag",      "verify_cert": true    }  }]