openapi: 3.2.0 info: title: Mist Orgs API description: '> Version: **2607.1.1** > > Date: **August 17, 2026** NOTE: Some important API changes will be introduced.' contact: name: Thomas Munzer email: tmunzer@juniper.net version: 2607.1.1 servers: - url: https://api.mist.com variables: {} - url: https://api.gc1.mist.com variables: {} - url: https://api.ac2.mist.com variables: {} - url: https://api.gc2.mist.com variables: {} - url: https://api.gc4.mist.com variables: {} - url: https://api.eu.mist.com variables: {} - url: https://api.gc3.mist.com variables: {} - url: https://api.ac6.mist.com variables: {} - url: https://api.gc6.mist.com variables: {} - url: https://api.ac5.mist.com variables: {} - url: https://api.gc5.mist.com variables: {} - url: https://api.gc7.mist.com variables: {} security: - apiToken: [] - csrfToken: [] tags: - name: Orgs description: An organization usually represents a customer - which has inventories, licenses. An Organization can contain multiple sites. A site usually represents a deployment at the same location (a campus, an office). paths: /api/v1/orgs: parameters: [] post: tags: - Orgs summary: createOrg description: Create a Mist organization with organization-level defaults such as display name, support-access setting, default alarm template, and admin session lifetime. operationId: createOrg parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/org' - examples: - alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 allow_mist: true name: string session_expiry: 1440 contentMediaType: application/json examples: Example: value: alarmtemplate_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 allow_mist: true name: string session_expiry: 1440 required: false responses: '200': description: Org Infos headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/org' - description: Mist organization containing sites, devices, users, and organization-level settings examples: - 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 contentMediaType: application/json examples: Example: value: 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 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/org' - description: Mist organization containing sites, devices, users, and organization-level settings examples: - 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 contentMediaType: application/vnd.api+json examples: Example: value: 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 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/orgs/{org_id}: parameters: [] delete: tags: - Orgs summary: deleteOrg description: Delete an organization and its organization-level resources. Use MSP organization assignment endpoints when only changing MSP ownership or association. This action is only allowed when the Organization Inventory is empty. operationId: deleteOrg parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: OK headers: {} content: {} '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false get: tags: - Orgs summary: getOrg description: Return organization details, including name, MSP ownership, organization group membership, support-access setting, and session settings. operationId: getOrg parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: Org Infos headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/org' - description: Mist organization containing sites, devices, users, and organization-level settings examples: - 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 contentMediaType: application/json examples: Example: value: 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 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/org' - description: Mist organization containing sites, devices, users, and organization-level settings examples: - 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 contentMediaType: application/vnd.api+json examples: Example: value: 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 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false put: tags: - Orgs summary: updateOrg description: Update organization-level settings such as display name, support-access setting, organization groups, default alarm template, or admin session lifetime. operationId: updateOrg parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab requestBody: description: Request Body content: application/json: schema: allOf: - $ref: '#/components/schemas/org' - description: Request Body examples: - alarmtemplate_id: 1984805d-2be2-4aec-a8d4-3ddf67fab0df allow_mist: true name: string orggroup_ids: [] session_expiry: 1440 contentMediaType: application/json examples: Example: value: alarmtemplate_id: 1984805d-2be2-4aec-a8d4-3ddf67fab0df allow_mist: true name: string orggroup_ids: [] session_expiry: 1440 required: false responses: '200': description: Org Infos headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/org' - description: Mist organization containing sites, devices, users, and organization-level settings examples: - 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 contentMediaType: application/json examples: Example: value: 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 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/org' - description: Mist organization containing sites, devices, users, and organization-level settings examples: - 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 contentMediaType: application/vnd.api+json examples: Example: value: 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 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/orgs/{org_id}/clone: parameters: [] post: tags: - Orgs summary: cloneOrg description: 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. operationId: cloneOrg parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab requestBody: description: Request Body content: application/json: schema: allOf: - $ref: '#/components/schemas/name_string' - description: Request Body examples: - name: New Org contentMediaType: application/json examples: Example: value: name: New Org required: false responses: '200': description: Org Infos headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/org' - description: Mist organization containing sites, devices, users, and organization-level settings examples: - 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 contentMediaType: application/json examples: Example: value: 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 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/org' - description: Mist organization containing sites, devices, users, and organization-level settings examples: - 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 contentMediaType: application/vnd.api+json examples: Example: value: 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 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false components: schemas: response_http403: title: response_http403 type: object properties: detail: type: string description: Human-readable explanation of the permission error examples: - You do not have permission to perform this action. description: Standard HTTP 403 permission error response response_http400: title: response_http400 type: object properties: detail: type: string description: Human-readable explanation of the bad request error examples: - 'JSON parse error - Expecting value: line 5 column 8 (char 56)' description: Standard HTTP 400 bad request error response response_http404: title: response_http404 type: object properties: id: type: string description: Missing resource identifier, when the API includes one description: Standard HTTP 404 not found error response response_http401: title: response_http401 type: object properties: detail: type: string description: Human-readable explanation of the authentication error examples: - Authentication credentials were not provided. description: Standard HTTP 401 authentication error response response_http429: title: response_http429 type: object properties: detail: type: string description: Human-readable explanation of the rate limit error examples: - Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold description: Standard HTTP 429 rate limit error response name_string: title: name_string type: object properties: name: type: string description: Value to create or update as the target resource name description: Request body containing a name value org: title: org required: - name type: object properties: alarmtemplate_id: type: - string - 'null' description: Org-level alarm template ID used as the default for sites contentEncoding: uuid allow_mist: type: boolean description: Whether Mist support access is allowed for this organization default: true created_time: type: number description: Epoch timestamp when the organization was created readOnly: true id: type: string description: Unique identifier of the organization contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f modified_time: type: number description: Epoch timestamp when the organization was last modified readOnly: true msp_id: type: string description: Managed service provider account that owns this organization, when applicable contentEncoding: uuid readOnly: true examples: - b9d42c2e-88ee-41f8-b798-f009ce7fe909 msp_logo_url: type: string description: logo uploaded by the MSP with advanced tier, only present if provided contentEncoding: uri readOnly: true examples: - https://example.com/logo/b9d42c2e-88ee-41f8-b798-f009ce7fe909.jpeg msp_name: type: string description: Name of the msp the org belongs to readOnly: true examples: - MSP name: type: string description: Display name of the organization examples: - Org orggroup_ids: type: array items: type: string contentEncoding: uuid description: Organization group IDs that include this organization session_expiry: maximum: 20160 minimum: 10 type: integer description: Admin session lifetime for the organization, in minutes contentEncoding: int32 default: 1440 description: Mist organization containing sites, devices, users, and organization-level settings securitySchemes: apiToken: type: apiKey description: "Preferred authentication method for automation and integrations. Send the API token in the HTTP `Authorization` header.\n\n**Format**:\n `Authorization: Token {apitoken}`\n\n**Notes**:\n* An API token generated for a specific admin has the same privileges as that admin\n* An API token is automatically removed if it is not used for more than 90 days\n* SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed." name: Authorization in: header csrfToken: type: apiKey description: 'Session-based authentication for browser or login/password flows. After a successful [Login]($e/Admins%20Login/login) request, Mist returns a `csrftoken` cookie. Send that value in the `X-CSRFToken` header on later API requests that use the login session. **Format**: ``` X-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx ``` For automation, API Token authentication is preferred.' name: X-CSRFToken in: header