Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsSetting

getOrgSettings

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

Return organization-wide settings, including feature flags, automatic device assignment rules, management connectivity, packet capture, security controls, and integration configuration.

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

Response Body

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

{  "auto_device_naming": {    "enable": true,    "rules": [      {        "match_device": "ap",        "prefix": "MIST-",        "src": "lldp_port_desc"      }    ]  },  "auto_deviceprofile_assignment": {    "enable": true,    "rules": [      {        "expression": "string",        "model": "string",        "prefix": "string",        "src": "name",        "subnet": "string",        "suffix": "string",        "value": "string"      }    ]  },  "auto_site_assignment": {    "enable": true,    "rules": [      {        "expression": "string",        "model": "string",        "prefix": "string",        "src": "name",        "subnet": "string",        "suffix": "string",        "value": "string"      }    ]  },  "cacerts": [    "string"  ],  "cloudshark": {    "apitoken": "string",    "url": "string"  },  "created_time": 0,  "device_cert": {    "cert": "string",    "key": "string"  },  "device_updown_threshold": 0,  "disable_pcap": true,  "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "installer": {    "allow_all_sites": true,    "extra_site_ids": [      "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"    ],    "grace_period": 0  },  "mgmt": {    "mxtunnel_ids": [      "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"    ],    "use_mxtunnel": true,    "use_wxtunnel": true  },  "modified_time": 0,  "msp_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "name": "string",  "password_policy": {    "enabled": true,    "expiry_in_days": 180,    "min_length": 8,    "requires_special_char": true,    "requires_two_factor_auth": true  },  "pcap": {    "bucket": "string",    "max_pkt_len": 0  },  "pcap_bucket_verified": true,  "remote_syslog": {    "enabled": true,    "send_to_all_servers": true,    "servers": [      {        "facility": "conflict-log",        "host": "string",        "port": 0,        "protocol": "udp",        "severity": "any",        "tag": "string"      }    ]  },  "security": {    "disable_local_ssh": true,    "fips_zeroize_password": "string",    "limit_ssh_access": true  },  "tags": [    "string"  ],  "ui_idle_timeout": 0}

deleteOrgWirelessClientsBlocklist DELETE

Clear the organization wireless client blocklist by removing all blocked client MAC addresses.

updateOrgSettings PUT

Update organization-wide settings such as automatic device assignment rules, management connectivity, packet capture, password policy, security controls, tags, and integration options.