OrgsSetting

updateOrgSettings

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

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

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

Request Body

application/json

Request Body

Organization-wide feature, integration, management, and security settings

allow_mist?boolean

whether to allow Mist to look at this org

Defaultfalse
ap_updown_threshold?|

Enable threshold-based device down delivery for AP devices only. When configured it takes effect for AP devices and device_updown_threshold is ignored.

Range0 <= value <= 240
Default0
api_policy?

Policy for hiding API secrets and passwords in responses

auto_device_naming?

Automatic device naming rules for claimed devices

auto_deviceprofile_assignment?

Automatic device profile assignment rules for claimed devices

auto_site_assignment?

Automatic site assignment rules for claimed devices

auto_upgrade?

AP automatic firmware upgrade policy for the organization

cacerts?array<string>

Legacy CA certificate list used to verify client certificates. If cacerts_configs is provided and non-empty, this field is ignored.

cacerts_configs?array<>

Preferred per-issuer CA certificate configuration with optional OCSP and CRL settings. When provided and non-empty, cacerts is ignored.

celona?

Integration settings for Celona

cloudshark?

Packet capture integration settings for CloudShark

device_cert?

Common device certificate used by organization settings

device_updown_threshold?|

Enable threshold-based device down delivery via

  • device-updowns webhooks topic,
  • Mist Alert Framework; e.g. send AP/SW/GW down event only if AP/SW/GW Up is not seen within the threshold in minutes; 0 - 240, default is 0 (trigger immediate)
Range0 <= value <= 240
Default0
disable_pcap?boolean

Whether to disallow Mist to analyze pcap files (this is required for marvis pcap)

Defaultfalse
disable_remote_shell?boolean

Whether to disable remote shell access for an entire org

Defaultfalse
gateway_mgmt?

Gateway management defaults for the organization

gateway_tunnel_updown_threshold?|

enable threshold-based gateway tunnel (secure edge tunnels) up-down delivery.

Range0 <= value
gateway_updown_threshold?|

Enable threshold-based device down delivery for Gateway devices only. When configured it takes effect for GW devices and device_updown_threshold is ignored.

Range0 <= value <= 240
Default0
installer?

Access settings for organization installer workflows

jcloud?

Integration settings for JCloud

jcloud_ra?

Routing Assurance integration settings for JCloud

juniper?

Linked Juniper account information for this organization

juniper_srx?

SRX integration settings for Juniper devices

junos_shell_access?

Role-based Junos web-shell access settings

marvis?

AI assistant and self-driving feature settings for Marvis

mgmt?

Tunnel settings for organization management connectivity

mist_nac?

NAC settings for Mist Access Assurance

mxedge_mgmt?

Management settings for Mist Edge devices

optic_port_config?

Configuration defaults for optic ports

password_policy?

Admin credential policy settings for the organization

pcap?

Packet capture settings for the organization

security?

Organization security controls such as local SSH restrictions

simple_alert?

Basic alert delivery settings for the organization

ssr?

Session Smart Router settings for the organization

switch?

Configuration defaults for switches in this organization

switch_mgmt?

Management settings for switches in this organization

switch_updown_threshold?|

Enable threshold-based device down delivery for Switch devices only. When configured it takes effect for SW devices and device_updown_threshold is ignored.

Default0
synthetic_test?

Configuration for organization synthetic tests

tags?array<string>

Labels associated with these organization settings

ui_idle_timeout?integer

Automatically logout the user when UI session is inactive. 0 means disabled

Range0 <= value <= 480
Default0
ui_no_tracking?boolean

Whether to disable UI usage tracking (e.g. Fullstory, Pendo) for the whole organization

Defaultfalse
vpn_options?

Options for organization VPN behavior

wan_pma?

PMA feature settings for WAN Assurance

wired_pma?

PMA feature settings for Wired Assurance

wireless_pma?

PMA feature settings for Wireless Assurance

Response Body

application/json

curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/setting" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"  },  "device_cert": {    "cert": "string",    "key": "string"  },  "disable_pcap": true,  "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": 365,    "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": "change-log",        "host": "string",        "port": 0,        "protocol": "udp",        "severity": "critical",        "tag": "string"      }    ]  },  "security": {    "disable_local_ssh": true,    "fips_zeroize_password": "string",    "limit_ssh_access": true  },  "tags": [    "string"  ],  "ui_idle_timeout": 0}