Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
Orgs

createOrg

POST
/api/v1/orgs

Create a Mist organization with organization-level defaults such as display name, support-access setting, default alarm template, and admin session lifetime.

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

Request Body

application/json

Mist organization containing sites, devices, users, and organization-level settings

alarmtemplate_id?|

Org-level alarm template ID used as the default for sites

Formatuuid
allow_mist?boolean

Whether Mist support access is allowed for this organization

Defaulttrue
name*string

Display name of the organization

orggroup_ids?array<>

Organization group IDs that include this organization

session_expiry?integer

Admin session lifetime for the organization, in minutes

Formatint32
Range10 <= value <= 20160
Default1440

Response Body

curl -X POST "https://example.com/api/v1/orgs" \  -H "Content-Type: application/json" \  -d '{    "alarmtemplate_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "allow_mist": true,    "name": "string",    "session_expiry": 1440  }'
{  "alarmtemplate_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "allow_mist": true,  "created_time": 0,  "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "modified_time": 0,  "msp_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "name": "string",  "orggroup_ids": [    "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"  ],  "session_expiry": 1440}

cloneOrg POST

Create an Org by cloning from another one. Org Settings, Templates, Wxlan Tags, Wxlan Tunnels, Wxlan Rules, Org Wlans will be copied. Sites and Site Groups will not be copied, and therefore, the copied template will not be applied to any site/sitegroups.

getOrg GET

Return organization details, including name, MSP ownership, organization group membership, support-access setting, and session settings.