openapi: 3.2.0 info: title: Mist Installer 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: Installer description: In a typical enterprise, a separate group of people, Installers, are responsible for install new devices. paths: /api/v1/installer/orgs/{org_id}/alarmtemplates: parameters: [] get: tags: - Installer summary: listInstallerAlarmTemplates description: Return alarm templates available to installer workflows in the organization. operationId: listInstallerAlarmTemplates parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: Installer List of Alarm Templates headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/installers_item' description: Installer access entries returned by list responses examples: - - id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168 name: AlarmTemplate 1 contentMediaType: application/json examples: Example: value: - id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168 name: AlarmTemplate 1 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/installers_item' description: Installer access entries returned by list responses examples: - - id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168 name: AlarmTemplate 1 contentMediaType: application/vnd.api+json examples: Example: value: - id: 684dfc5c-fe77-2290-eb1d-ef3d677fe168 name: AlarmTemplate 1 '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/installer/orgs/{org_id}/deviceprofiles: parameters: [] get: tags: - Installer summary: listInstallerDeviceProfiles description: Return device profiles that installers can use when provisioning recently claimed devices, optionally filtered by device type. operationId: listInstallerDeviceProfiles parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: type in: query description: 'Filter results by type. enum: `ap`, `gateway`, `switch`' style: form explode: true schema: allOf: - $ref: '#/components/schemas/device_type_default_ap' - description: 'Filter results by type. enum: `ap`, `gateway`, `switch`' responses: '200': description: Installer List of Device Profiles headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/installers_item' description: Installer access entries returned by list responses examples: - - id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9 name: DeviceProfile 1 contentMediaType: application/json examples: Example: value: - id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9 name: DeviceProfile 1 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/installers_item' description: Installer access entries returned by list responses examples: - - id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9 name: DeviceProfile 1 contentMediaType: application/vnd.api+json examples: Example: value: - id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9 name: DeviceProfile 1 '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/installer/orgs/{org_id}/devices: parameters: [] get: tags: - Installer summary: listInstallerListOfRecentlyClaimedDevices description: Return recently claimed devices visible to installer workflows, with optional filters for model, site name, or site identifier. operationId: listInstallerListOfRecentlyClaimedDevices parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: model in: query description: Filter results by device model style: form explode: true schema: type: string examples: - AP43 - name: site_name in: query description: Filter results by site name style: form explode: true schema: type: string examples: - SJ1 - name: site_id in: query description: Filter results by site identifier style: form explode: true schema: type: string contentEncoding: uuid examples: - 72771e6a-6f5e-4de4-a5b9-1266c4197811 - name: limit in: query description: Maximum number of results to return per page style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 100 - name: page in: query description: Select the page number to return when using page-based pagination; starts at `1` style: form explode: true schema: minimum: 1 type: integer contentEncoding: int32 default: 1 responses: '200': description: List of Devices Recently Claimed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/installer_device' description: Recently claimed devices available to installer workflows examples: - - connected: true deviceprofile_name: SJ1 height: 2.7 mac: 5c5b35000018 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 model: AP41 name: hallway orientation: 90 serial: FXLH2015150025 site_name: SJ1 x: 150 y: 300 contentMediaType: application/json examples: Example: value: - connected: true deviceprofile_name: SJ1 height: 2.7 mac: 5c5b35000018 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 model: AP41 name: hallway orientation: 90 serial: FXLH2015150025 site_name: SJ1 x: 150 y: 300 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/installer_device' description: Recently claimed devices available to installer workflows examples: - - connected: true deviceprofile_name: SJ1 height: 2.7 mac: 5c5b35000018 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 model: AP41 name: hallway orientation: 90 serial: FXLH2015150025 site_name: SJ1 x: 150 y: 300 contentMediaType: application/vnd.api+json examples: Example: value: - connected: true deviceprofile_name: SJ1 height: 2.7 mac: 5c5b35000018 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 model: AP41 name: hallway orientation: 90 serial: FXLH2015150025 site_name: SJ1 x: 150 y: 300 '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 post: tags: - Installer summary: claimInstallerDevices description: Claim devices into the organization inventory by activation code through the installer workflow. operationId: claimInstallerDevices 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: uniqueItems: true type: array items: type: string description: Request Body examples: - - 6JG8E-PTFV2-A9Z2N - DVH4V-SNMSZ-PDXBR contentMediaType: application/json examples: Example: value: - 6JG8E-PTFV2-A9Z2N - DVH4V-SNMSZ-PDXBR required: false responses: '200': description: OK - if any of entries are valid or there’s no errors headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_inventory' - description: Result of adding device claim codes to organization inventory examples: - added: - 6JG8E-PTFV2-A9Z2N duplicated: - DVH4V-SNMSZ-PDXBR error: - PO1025335ohoh inventory_added: - mac: 5c5b35000018 magic: 6JG8EPTFV2A9Z2N model: AP41 serial: FXLH2015150025 type: ap inventory_duplicated: - mac: 5c5b35000012 magic: DVH4VSNMSZPDXBR model: AP41 serial: FXLH2015150027 type: ap reason: - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you)) contentMediaType: application/json examples: Example: value: added: - 6JG8E-PTFV2-A9Z2N duplicated: - DVH4V-SNMSZ-PDXBR error: - PO1025335ohoh inventory_added: - mac: 5c5b35000018 magic: 6JG8EPTFV2A9Z2N model: AP41 serial: FXLH2015150025 type: ap inventory_duplicated: - mac: 5c5b35000012 magic: DVH4VSNMSZPDXBR model: AP41 serial: FXLH2015150027 type: ap reason: - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you)) application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_inventory' - description: Result of adding device claim codes to organization inventory examples: - added: - 6JG8E-PTFV2-A9Z2N duplicated: - DVH4V-SNMSZ-PDXBR error: - PO1025335ohoh inventory_added: - mac: 5c5b35000018 magic: 6JG8EPTFV2A9Z2N model: AP41 serial: FXLH2015150025 type: ap inventory_duplicated: - mac: 5c5b35000012 magic: DVH4VSNMSZPDXBR model: AP41 serial: FXLH2015150027 type: ap reason: - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you)) contentMediaType: application/vnd.api+json examples: Example: value: added: - 6JG8E-PTFV2-A9Z2N duplicated: - DVH4V-SNMSZ-PDXBR error: - PO1025335ohoh inventory_added: - mac: 5c5b35000018 magic: 6JG8EPTFV2A9Z2N model: AP41 serial: FXLH2015150025 type: ap inventory_duplicated: - mac: 5c5b35000012 magic: DVH4VSNMSZPDXBR model: AP41 serial: FXLH2015150027 type: ap reason: - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you)) '400': description: OK - if any of entries are valid or there’s no errors headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_inventory' - description: Result of adding device claim codes to organization inventory examples: - added: - 6JG8E-PTFV2-A9Z2N duplicated: - DVH4V-SNMSZ-PDXBR error: - PO1025335ohoh inventory_added: - mac: 5c5b35000018 magic: 6JG8EPTFV2A9Z2N model: AP41 serial: FXLH2015150025 type: ap inventory_duplicated: - mac: 5c5b35000012 magic: DVH4VSNMSZPDXBR model: AP41 serial: FXLH2015150027 type: ap reason: - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you)) contentMediaType: application/json examples: Example: value: added: - 6JG8E-PTFV2-A9Z2N duplicated: - DVH4V-SNMSZ-PDXBR error: - PO1025335ohoh inventory_added: - mac: 5c5b35000018 magic: 6JG8EPTFV2A9Z2N model: AP41 serial: FXLH2015150025 type: ap inventory_duplicated: - mac: 5c5b35000012 magic: DVH4VSNMSZPDXBR model: AP41 serial: FXLH2015150027 type: ap reason: - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you)) application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_inventory' - description: Result of adding device claim codes to organization inventory examples: - added: - 6JG8E-PTFV2-A9Z2N duplicated: - DVH4V-SNMSZ-PDXBR error: - PO1025335ohoh inventory_added: - mac: 5c5b35000018 magic: 6JG8EPTFV2A9Z2N model: AP41 serial: FXLH2015150025 type: ap inventory_duplicated: - mac: 5c5b35000012 magic: DVH4VSNMSZPDXBR model: AP41 serial: FXLH2015150027 type: ap reason: - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you)) contentMediaType: application/vnd.api+json examples: Example: value: added: - 6JG8E-PTFV2-A9Z2N duplicated: - DVH4V-SNMSZ-PDXBR error: - PO1025335ohoh inventory_added: - mac: 5c5b35000018 magic: 6JG8EPTFV2A9Z2N model: AP41 serial: FXLH2015150025 type: ap inventory_duplicated: - mac: 5c5b35000012 magic: DVH4VSNMSZPDXBR model: AP41 serial: FXLH2015150027 type: ap reason: - belongs to another org ('e2f543f7-d6e1-409f-a565-e77a1f098d3b' (other) != '0de5d6fc-219a-414d-a840-67d6b919ad8f' (you)) '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/installer/orgs/{org_id}/devices/{device_mac}: parameters: [] delete: tags: - Installer summary: unassignInstallerRecentlyClaimedDevice description: Unassign a recently claimed device from its current site so it can be provisioned again through the installer workflow. operationId: unassignInstallerRecentlyClaimedDevice parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: device_mac in: path description: '' required: true schema: pattern: ^[0-9a-fA-F]{12}$ type: string examples: - 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 put: tags: - Installer summary: provisionInstallerDevices description: 'Provision or replace an installer-managed device. If replacing_mac is in the request payload, other attributes are ignored, we attempt to replace existing device (with MAC address `replacing_mac`) with the inventory device being configured. The replacement device must be in the inventory but not assigned, and the replacing_mac device must be assigned to a site, and satisfy grace period requirements. The Device replaced will become unassigned.' operationId: provisionInstallerDevices parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: device_mac in: path description: '' required: true schema: pattern: ^[0-9a-fA-F]{12}$ type: string examples: - 0000000000ab requestBody: description: Request Body content: application/json: schema: allOf: - $ref: '#/components/schemas/installer_provision_device' - description: Request Body examples: - deviceprofile_name: SJ1 height: 2.7 name: SJ1-AP1 orientation: 90 site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811 site_name: SJ1 x: 150 y: 300 contentMediaType: application/json examples: Example: value: deviceprofile_name: SJ1 height: 2.7 name: SJ1-AP1 orientation: 90 site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811 site_name: SJ1 x: 150 y: 300 required: false responses: '200': description: OK headers: {} content: {} '400': description: Bad Request headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_detail_string' - description: Response containing a human-readable detail message examples: - '{"detail":"invalid replacing_mac"}' - '{"detail":"device already assigned"}' - '{"detail":"outside of grace period"}' - '{"detail":"replacing_mac device is unassigned"}' - '{"detail":"replacing_mac device outside of grace period"}' contentMediaType: application/json examples: Invalid Mac Given For Replacing Mac: value: detail: invalid replacing_mac Inventory Device Is Already Assigned: value: detail: device already assigned Outside Of Grace Period: value: detail: outside of grace period Replacing Mac Device Is Not Assigned To A Site: value: detail: replacing_mac device is unassigned Replacing Mac Device Last Modified Outside Of Grace Period: value: detail: replacing_mac device outside of grace period application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_detail_string' - description: Response containing a human-readable detail message examples: - '{"detail":"invalid replacing_mac"}' - '{"detail":"device already assigned"}' - '{"detail":"outside of grace period"}' - '{"detail":"replacing_mac device is unassigned"}' - '{"detail":"replacing_mac device outside of grace period"}' contentMediaType: application/vnd.api+json examples: Invalid Mac Given For Replacing Mac: value: detail: invalid replacing_mac Inventory Device Is Already Assigned: value: detail: device already assigned Outside Of Grace Period: value: detail: outside of grace period Replacing Mac Device Is Not Assigned To A Site: value: detail: replacing_mac device is unassigned Replacing Mac Device Last Modified Outside Of Grace Period: value: detail: replacing_mac device outside of grace period '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 headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_detail_string' - description: Response containing a human-readable detail message examples: - '{"detail":"replacing_mac inventory not found"}' - '{"detail":"replacing_mac device not found"}' contentMediaType: application/json examples: Replacing Mac Device Is Not In Org Inventory: value: detail: replacing_mac inventory not found Replacing Mac Device Not Found: value: detail: replacing_mac device not found application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_detail_string' - description: Response containing a human-readable detail message examples: - '{"detail":"replacing_mac inventory not found"}' - '{"detail":"replacing_mac device not found"}' contentMediaType: application/vnd.api+json examples: Replacing Mac Device Is Not In Org Inventory: value: detail: replacing_mac inventory not found Replacing Mac Device Not Found: value: detail: replacing_mac device not found '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/installer/orgs/{org_id}/devices/{device_mac}/locate: parameters: [] post: tags: - Installer summary: startInstallerLocateDevice description: Start locating an installer-managed device by blinking its LED. The locate state persists until Stop Locating Installer Device is called. operationId: startInstallerLocateDevice parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: device_mac in: path description: '' required: true schema: pattern: ^[0-9a-fA-F]{12}$ type: string examples: - 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 /api/v1/installer/orgs/{org_id}/devices/{device_mac}/unlocate: parameters: [] post: tags: - Installer summary: stopInstallerLocateDevice description: Stop the locate LED state for an installer-managed device. operationId: stopInstallerLocateDevice parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: device_mac in: path description: '' required: true schema: pattern: ^[0-9a-fA-F]{12}$ type: string examples: - 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 /api/v1/installer/orgs/{org_id}/devices/{device_mac}/{image_name}: parameters: [] delete: tags: - Installer summary: deleteInstallerDeviceImage description: Remove a previously uploaded image associated with an installer-managed device, such as an installation photo or device placement image. operationId: deleteInstallerDeviceImage parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: image_name in: path description: '' required: true schema: type: string - name: device_mac in: path description: '' required: true schema: pattern: ^[0-9a-fA-F]{12}$ type: string examples: - 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 post: tags: - Installer summary: addInstallerDeviceImage description: Upload an image associated with an installer-managed device using `multipart/form-data`. operationId: addInstallerDeviceImage parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: image_name in: path description: '' required: true schema: type: string - name: device_mac in: path description: '' required: true schema: pattern: ^[0-9a-fA-F]{12}$ type: string examples: - 0000000000ab requestBody: content: multipart/form-data: encoding: {} schema: type: object properties: auto_deviceprofile_assignment: type: boolean description: Whether to auto assign device to deviceprofile by name examples: - true csv: type: string description: Optional AP name-mapping CSV file contentEncoding: base64 file: type: string description: Ekahau or iBwave floorplan file to import contentEncoding: base64 json: allOf: - $ref: '#/components/schemas/map_import_json1' - description: Import options for the site map file contentMediaType: multipart/form-data required: false 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 /api/v1/installer/orgs/{org_id}/devices/{fpc0_mac}/vc: parameters: [] get: tags: - Installer summary: getInstallerDeviceVirtualChassis description: 'Return Virtual Chassis status for an installer-managed switch, including topology and member statistics. The response is a combined view of the Virtual Chassis state.' operationId: getInstallerDeviceVirtualChassis parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: fpc0_mac in: path description: FPC0 MAC address required: true schema: type: string examples: - aff827549235 responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_virtual_chassis_config' - description: Combined virtual chassis status, topology, and member statistics examples: - config_type: nonprovisioned id: 00000000-0000-0000-1000-52d9107af289 mac: 52d9107af289 members: - boot_partition: junos cpld_version: '6' cpu_stat: idle: 69 interrupt: 1 load_avg: - 0.8 - 1.09 - 1.07 system: 11 user: 19 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 0 mac: 52d9107af289 memory_stat: usage: 42 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 40.4 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW0000000000 temperatures: - celsius: 33 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/0 vc_mode: HiGiG vc_role: master vc_state: present version: 21.4R3-S4.18 - boot_partition: junos cpld_version: '6' cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.96 - 0.87 - 0.76 system: 6 user: 17 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 1 mac: d0dd4991652d memory_stat: usage: 18 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 21.2 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW3619300922 temperatures: - celsius: 32 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/0 vc_mode: HiGiG vc_role: backup vc_state: present version: 21.4R3-S4.18 model: EX2300-48P num_routing_engines: 1 org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8 serial: JW3619300157 site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b status: connected type: switch vc_mac: 52d9107af289 contentMediaType: application/json examples: Example: value: config_type: nonprovisioned id: 00000000-0000-0000-1000-52d9107af289 mac: 52d9107af289 members: - boot_partition: junos cpld_version: '6' cpu_stat: idle: 69 interrupt: 1 load_avg: - 0.8 - 1.09 - 1.07 system: 11 user: 19 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 0 mac: 52d9107af289 memory_stat: usage: 42 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 40.4 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW0000000000 temperatures: - celsius: 33 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/0 vc_mode: HiGiG vc_role: master vc_state: present version: 21.4R3-S4.18 - boot_partition: junos cpld_version: '6' cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.96 - 0.87 - 0.76 system: 6 user: 17 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 1 mac: d0dd4991652d memory_stat: usage: 18 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 21.2 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW3619300922 temperatures: - celsius: 32 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/0 vc_mode: HiGiG vc_role: backup vc_state: present version: 21.4R3-S4.18 model: EX2300-48P num_routing_engines: 1 org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8 serial: JW3619300157 site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b status: connected type: switch vc_mac: 52d9107af289 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_virtual_chassis_config' - description: Combined virtual chassis status, topology, and member statistics examples: - config_type: nonprovisioned id: 00000000-0000-0000-1000-52d9107af289 mac: 52d9107af289 members: - boot_partition: junos cpld_version: '6' cpu_stat: idle: 69 interrupt: 1 load_avg: - 0.8 - 1.09 - 1.07 system: 11 user: 19 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 0 mac: 52d9107af289 memory_stat: usage: 42 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 40.4 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW0000000000 temperatures: - celsius: 33 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/0 vc_mode: HiGiG vc_role: master vc_state: present version: 21.4R3-S4.18 - boot_partition: junos cpld_version: '6' cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.96 - 0.87 - 0.76 system: 6 user: 17 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 1 mac: d0dd4991652d memory_stat: usage: 18 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 21.2 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW3619300922 temperatures: - celsius: 32 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/0 vc_mode: HiGiG vc_role: backup vc_state: present version: 21.4R3-S4.18 model: EX2300-48P num_routing_engines: 1 org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8 serial: JW3619300157 site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b status: connected type: switch vc_mac: 52d9107af289 contentMediaType: application/vnd.api+json examples: Example: value: config_type: nonprovisioned id: 00000000-0000-0000-1000-52d9107af289 mac: 52d9107af289 members: - boot_partition: junos cpld_version: '6' cpu_stat: idle: 69 interrupt: 1 load_avg: - 0.8 - 1.09 - 1.07 system: 11 user: 19 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 0 mac: 52d9107af289 memory_stat: usage: 42 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 40.4 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW0000000000 temperatures: - celsius: 33 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/0 vc_mode: HiGiG vc_role: master vc_state: present version: 21.4R3-S4.18 - boot_partition: junos cpld_version: '6' cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.96 - 0.87 - 0.76 system: 6 user: 17 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 1 mac: d0dd4991652d memory_stat: usage: 18 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 21.2 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW3619300922 temperatures: - celsius: 32 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/0 vc_mode: HiGiG vc_role: backup vc_state: present version: 21.4R3-S4.18 model: EX2300-48P num_routing_engines: 1 org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8 serial: JW3619300157 site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b status: connected type: switch vc_mac: 52d9107af289 '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 post: tags: - Installer summary: createInstallerVirtualChassis description: 'For models (e.g. EX3400 and up) having dedicated VC ports, it is easier to form a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new VC and update the inventory. In case that the user would like to choose the dedicated switch as a VC master or for EX2300-C-12P and EX2300-C-12T which doesn''t have dedicated VC ports, below are procedures to automate the VC creation: 1. Power on the switch that is chosen as the VC master first. And then powering on the other member switches. 2. Claim or adopt all these switches under the same organization’s Inventory 3. Assign these switches into the same Site 4. Invoke vc command on the switch chosen to be the VC master. For EX2300-C-12P, VC ports will be created automatically. 5. Connect the cables to the VC ports for these switches 6. Wait for the VC to be formed. The Org’s inventory will be updated for the new VC.' operationId: createInstallerVirtualChassis parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: fpc0_mac in: path description: FPC0 MAC address required: true schema: type: string examples: - aff827549235 requestBody: description: Request Body content: application/json: schema: allOf: - $ref: '#/components/schemas/virtual_chassis_config' - description: Request Body examples: - '{"members":[{"mac":"aff827549235","vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"master"},{"mac":"8396cd006c8c","vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"backup"},{"mac":"8396cd00888c","vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"linecard"}]}' - '{"members":[{"mac":"aff827549235","member_id":0,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"master"},{"mac":"8396cd006c8c","member_id":1,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"linecard"},{"mac":"8396cd00888c","member_id":2,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"backup"}],"preprovisioned":true}' contentMediaType: application/json examples: create-a-VC-with-three-members: value: members: - mac: aff827549235 vc_ports: - xe-0/1/0 - xe-0/1/1 vc_role: master - mac: 8396cd006c8c vc_ports: - xe-0/1/0 - xe-0/1/1 vc_role: backup - mac: 8396cd00888c vc_ports: - xe-0/1/0 - xe-0/1/1 vc_role: linecard create-a-pre-provisioned-VC-with-three-members: value: members: - mac: aff827549235 member_id: 0 vc_ports: - xe-0/1/0 - xe-0/1/1 vc_role: master - mac: 8396cd006c8c member_id: 1 vc_ports: - xe-0/1/0 - xe-0/1/1 vc_role: linecard - mac: 8396cd00888c member_id: 2 vc_ports: - xe-0/1/0 - xe-0/1/1 vc_role: backup preprovisioned: true required: false responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_virtual_chassis_config' - description: Combined virtual chassis status, topology, and member statistics examples: - config_type: nonprovisioned id: 00000000-0000-0000-1000-52d9107af289 mac: 52d9107af289 members: - boot_partition: junos cpld_version: '6' cpu_stat: idle: 69 interrupt: 1 load_avg: - 0.8 - 1.09 - 1.07 system: 11 user: 19 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 0 mac: 52d9107af289 memory_stat: usage: 42 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 40.4 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW0000000000 temperatures: - celsius: 33 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/0 vc_mode: HiGiG vc_role: master vc_state: present version: 21.4R3-S4.18 - boot_partition: junos cpld_version: '6' cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.96 - 0.87 - 0.76 system: 6 user: 17 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 1 mac: d0dd4991652d memory_stat: usage: 18 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 21.2 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW3619300922 temperatures: - celsius: 32 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/0 vc_mode: HiGiG vc_role: backup vc_state: present version: 21.4R3-S4.18 model: EX2300-48P num_routing_engines: 1 org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8 serial: JW3619300157 site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b status: connected type: switch vc_mac: 52d9107af289 contentMediaType: application/json examples: Example: value: config_type: nonprovisioned id: 00000000-0000-0000-1000-52d9107af289 mac: 52d9107af289 members: - boot_partition: junos cpld_version: '6' cpu_stat: idle: 69 interrupt: 1 load_avg: - 0.8 - 1.09 - 1.07 system: 11 user: 19 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 0 mac: 52d9107af289 memory_stat: usage: 42 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 40.4 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW0000000000 temperatures: - celsius: 33 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/0 vc_mode: HiGiG vc_role: master vc_state: present version: 21.4R3-S4.18 - boot_partition: junos cpld_version: '6' cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.96 - 0.87 - 0.76 system: 6 user: 17 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 1 mac: d0dd4991652d memory_stat: usage: 18 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 21.2 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW3619300922 temperatures: - celsius: 32 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/0 vc_mode: HiGiG vc_role: backup vc_state: present version: 21.4R3-S4.18 model: EX2300-48P num_routing_engines: 1 org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8 serial: JW3619300157 site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b status: connected type: switch vc_mac: 52d9107af289 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_virtual_chassis_config' - description: Combined virtual chassis status, topology, and member statistics examples: - config_type: nonprovisioned id: 00000000-0000-0000-1000-52d9107af289 mac: 52d9107af289 members: - boot_partition: junos cpld_version: '6' cpu_stat: idle: 69 interrupt: 1 load_avg: - 0.8 - 1.09 - 1.07 system: 11 user: 19 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 0 mac: 52d9107af289 memory_stat: usage: 42 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 40.4 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW0000000000 temperatures: - celsius: 33 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/0 vc_mode: HiGiG vc_role: master vc_state: present version: 21.4R3-S4.18 - boot_partition: junos cpld_version: '6' cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.96 - 0.87 - 0.76 system: 6 user: 17 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 1 mac: d0dd4991652d memory_stat: usage: 18 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 21.2 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW3619300922 temperatures: - celsius: 32 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/0 vc_mode: HiGiG vc_role: backup vc_state: present version: 21.4R3-S4.18 model: EX2300-48P num_routing_engines: 1 org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8 serial: JW3619300157 site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b status: connected type: switch vc_mac: 52d9107af289 contentMediaType: application/vnd.api+json examples: Example: value: config_type: nonprovisioned id: 00000000-0000-0000-1000-52d9107af289 mac: 52d9107af289 members: - boot_partition: junos cpld_version: '6' cpu_stat: idle: 69 interrupt: 1 load_avg: - 0.8 - 1.09 - 1.07 system: 11 user: 19 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 0 mac: 52d9107af289 memory_stat: usage: 42 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 40.4 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW0000000000 temperatures: - celsius: 33 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/0 vc_mode: HiGiG vc_role: master vc_state: present version: 21.4R3-S4.18 - boot_partition: junos cpld_version: '6' cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.96 - 0.87 - 0.76 system: 6 user: 17 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 1 mac: d0dd4991652d memory_stat: usage: 18 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 21.2 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW3619300922 temperatures: - celsius: 32 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/0 vc_mode: HiGiG vc_role: backup vc_state: present version: 21.4R3-S4.18 model: EX2300-48P num_routing_engines: 1 org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8 serial: JW3619300157 site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b status: connected type: switch vc_mac: 52d9107af289 '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: - Installer summary: updateInstallerVirtualChassisMember description: 'The VC creation and adding member switch API will update the device’ s virtual chassis config which is applied after VC is formed to create JUNOS pre-provisioned virtual chassis configuration. ## Change to use preprovisioned VC To switch the VC to use preprovisioned VC, enable preprovisioned in virtual_chassis config. Both vc_role master and backup will be matched to routing-engine role in Junos preprovisioned VC config. In this config, fpc0 has to be the same as the mac of device_id. Use renumber if you want to replace fpc0 which involves device_id change. Notice: to configure preprovisioned VC, every member of the VC must be in the inventory. ## Add new members For models (e.g. EX4300 and up) having dedicated VC ports, it is easier to add new member switches into a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new members and update the inventory. For EX2300 VC, adding new members requires to follow the procedures below: 1. Powering on the new member switches and ensuring cables are not connected to any VC ports. 2. Claim or adopt all new member switches under the VC’s organization Inventory 3. Assign all new member switches to the same Site as the VC 4. Invoke vc command to add switches to the VC. 5. Connect the cables to the VC ports for these switches 6. After a while, the Org’s Inventory shows this new switches has been added into the VC. ## Removing member switch To remove a member switch from the VC, following the procedures below: 1. Ensuring the VC is connected to the cloud first 2. Unplug the cable from the VC port of the switch 3. Waiting for the VC state (vc_state) of this switch is changed to not-present 4. Invoke update_vc with remove to remove this switch from the VC 5. The Org’s Inventory shows the switch is removed. Please notice that member ID 0 (fpc0) cannot be removed. When a VC has two switches left, unplugging the cable may result in the situation that fpc0 becomes a line card (LC). When this situation is happening, please re-plug in the cable, wait for both switches becoming present (show virtual-chassis) and then removing the cable again. ## Renumber a member switch When a member switch doesn''t'' work properly and needed to be replaced, the renumber API could be used. The following two types of renumber are supported: 1. Replace a non-fpc0 member switch 2. Replace fpc0. When fpc0 is replaced, PAPI device config and JUNOS config will be both updated. For renumber to work, the following procedures are needed: 1. Ensuring the VC is connected to the cloud and the state of the member switch to be replaced must be non present. 2. Adding the new member switch to the VC 3. Waiting for the VC state (vc_state) of this VC to be updated to API server 4. Invoke vc with renumber to replace the new member switch from fpc X to ## Perprovision VC members By specifying "preprovision" op, you can convert the current VC to pre-provisioned mode, update VC members as well as specify vc_ports when adding new members for device models without dedicated vc ports. Use renumber for fpc0 replacement which involves device_id change. Note: 1. vc_ports is used for adding new members and not needed if * the device model has dedicated vc ports, or * no new member is added 2. New VC members to be added should exist in the same Site as the VC Update Device’s VC config can achieve similar purpose by directly modifying current virtual_chassis config. However, it cannot fulfill requests to enabling vc_ports on new members that are yet to belong to current VC.' operationId: updateInstallerVirtualChassisMember parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: fpc0_mac in: path description: FPC0 MAC address required: true schema: type: string examples: - aff827549235 requestBody: description: Request Body content: application/json: schema: allOf: - $ref: '#/components/schemas/virtual_chassis_update' - description: Request Body examples: - '{"members":[{"mac":"aff827549235","member_id":2,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"linecard"},{"mac":"8396cd00777c","member_id":3,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"linecard"}],"op":"add"}' - '{"member":0,"members":[{"mac":"string","member_id":0,"vc_ports":["xe-0/1/0","xe-0/1/1"],"vc_role":"master"}],"new-member":0,"op":"add"}' - '{"members":[{"member":2},{"member":3}],"op":"remove"}' - '{"member":3,"new-member":2,"op":"renumber"}' contentMediaType: application/json examples: adding-two-new-switches-as-line-cards-into-the-VC: value: members: - mac: aff827549235 member_id: 2 vc_ports: - xe-0/1/0 - xe-0/1/1 vc_role: linecard - mac: 8396cd00777c member_id: 3 vc_ports: - xe-0/1/0 - xe-0/1/1 vc_role: linecard op: add convert-to-pre-provisioned-VC: value: member: 0 members: - mac: string member_id: 0 vc_ports: - xe-0/1/0 - xe-0/1/1 vc_role: master new-member: 0 op: add removing-two-switches-from-VC: value: members: - member: 2 - member: 3 op: remove renumber-member-ID-3-to-member-ID-2: value: member: 3 new-member: 2 op: renumber required: false responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_virtual_chassis_config' - description: Combined virtual chassis status, topology, and member statistics examples: - config_type: nonprovisioned id: 00000000-0000-0000-1000-52d9107af289 mac: 52d9107af289 members: - boot_partition: junos cpld_version: '6' cpu_stat: idle: 69 interrupt: 1 load_avg: - 0.8 - 1.09 - 1.07 system: 11 user: 19 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 0 mac: 52d9107af289 memory_stat: usage: 42 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 40.4 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW0000000000 temperatures: - celsius: 33 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/0 vc_mode: HiGiG vc_role: master vc_state: present version: 21.4R3-S4.18 - boot_partition: junos cpld_version: '6' cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.96 - 0.87 - 0.76 system: 6 user: 17 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 1 mac: d0dd4991652d memory_stat: usage: 18 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 21.2 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW3619300922 temperatures: - celsius: 32 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/0 vc_mode: HiGiG vc_role: backup vc_state: present version: 21.4R3-S4.18 model: EX2300-48P num_routing_engines: 1 org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8 serial: JW3619300157 site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b status: connected type: switch vc_mac: 52d9107af289 contentMediaType: application/json examples: Example: value: config_type: nonprovisioned id: 00000000-0000-0000-1000-52d9107af289 mac: 52d9107af289 members: - boot_partition: junos cpld_version: '6' cpu_stat: idle: 69 interrupt: 1 load_avg: - 0.8 - 1.09 - 1.07 system: 11 user: 19 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 0 mac: 52d9107af289 memory_stat: usage: 42 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 40.4 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW0000000000 temperatures: - celsius: 33 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/0 vc_mode: HiGiG vc_role: master vc_state: present version: 21.4R3-S4.18 - boot_partition: junos cpld_version: '6' cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.96 - 0.87 - 0.76 system: 6 user: 17 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 1 mac: d0dd4991652d memory_stat: usage: 18 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 21.2 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW3619300922 temperatures: - celsius: 32 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/0 vc_mode: HiGiG vc_role: backup vc_state: present version: 21.4R3-S4.18 model: EX2300-48P num_routing_engines: 1 org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8 serial: JW3619300157 site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b status: connected type: switch vc_mac: 52d9107af289 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_virtual_chassis_config' - description: Combined virtual chassis status, topology, and member statistics examples: - config_type: nonprovisioned id: 00000000-0000-0000-1000-52d9107af289 mac: 52d9107af289 members: - boot_partition: junos cpld_version: '6' cpu_stat: idle: 69 interrupt: 1 load_avg: - 0.8 - 1.09 - 1.07 system: 11 user: 19 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 0 mac: 52d9107af289 memory_stat: usage: 42 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 40.4 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW0000000000 temperatures: - celsius: 33 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/0 vc_mode: HiGiG vc_role: master vc_state: present version: 21.4R3-S4.18 - boot_partition: junos cpld_version: '6' cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.96 - 0.87 - 0.76 system: 6 user: 17 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 1 mac: d0dd4991652d memory_stat: usage: 18 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 21.2 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW3619300922 temperatures: - celsius: 32 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/0 vc_mode: HiGiG vc_role: backup vc_state: present version: 21.4R3-S4.18 model: EX2300-48P num_routing_engines: 1 org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8 serial: JW3619300157 site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b status: connected type: switch vc_mac: 52d9107af289 contentMediaType: application/vnd.api+json examples: Example: value: config_type: nonprovisioned id: 00000000-0000-0000-1000-52d9107af289 mac: 52d9107af289 members: - boot_partition: junos cpld_version: '6' cpu_stat: idle: 69 interrupt: 1 load_avg: - 0.8 - 1.09 - 1.07 system: 11 user: 19 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 0 mac: 52d9107af289 memory_stat: usage: 42 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 40.4 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW0000000000 temperatures: - celsius: 33 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 1 neighbor_port_id: vcp-1/1/0 port_id: vcp-0/1/0 vc_mode: HiGiG vc_role: master vc_state: present version: 21.4R3-S4.18 - boot_partition: junos cpld_version: '6' cpu_stat: idle: 76 interrupt: 0 load_avg: - 0.96 - 0.87 - 0.76 system: 6 user: 17 fans: - airflow: out name: Fan Tray 0 Fan 0 rpm: 0 status: ok - airflow: out name: Fan Tray 1 Fan 0 rpm: 0 status: ok fpc_idx: 1 mac: d0dd4991652d memory_stat: usage: 18 model: EX2300-48P pics: - index: 0 model_number: EX2300-48P port_groups: - count: 48 type: GE - index: 1 model_number: EX2300-48P port_groups: - count: 4 type: SFP/SFP+ poe: max_power: 750 power_draw: 21.2 status: AT_MODE poe_version: 2.1.1.19.3 (type1) psus: - name: Power Supply 0 status: ok recovery_version: 21.4R3-S4.18 serial: JW3619300922 temperatures: - celsius: 32 name: CPU Sensor status: ok - celsius: 29 name: PSU Sensor status: ok type: fpc uboot_version: U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800) 1.3.2 uptime: 27636720 vc_links: - neighbor_module_idx: 0 neighbor_port_id: vcp-0/1/0 port_id: vcp-1/1/0 vc_mode: HiGiG vc_role: backup vc_state: present version: 21.4R3-S4.18 model: EX2300-48P num_routing_engines: 1 org_id: 1e9a61a9-bc42-42ca-bf67-1ad87443d9b8 serial: JW3619300157 site_id: ab0aca7a-d45c-469b-b3bb-4fe240642d0b status: connected type: switch vc_mac: 52d9107af289 '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/installer/orgs/{org_id}/rftemplates: parameters: [] get: tags: - Installer summary: listInstallerRfTemplatesNames description: Return RF template names available to installer workflows for site creation or updates. operationId: listInstallerRfTemplatesNames parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: Installer List of RF Templates headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/installers_item' description: Installer access entries returned by list responses examples: - - id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2 name: RFTemplate 1 contentMediaType: application/json examples: Example: value: - id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2 name: RFTemplate 1 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/installers_item' description: Installer access entries returned by list responses examples: - - id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2 name: RFTemplate 1 contentMediaType: application/vnd.api+json examples: Example: value: - id: bb8a9017-1e36-5d6c-6f2b-551abe8a76a2 name: RFTemplate 1 '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/installer/orgs/{org_id}/sitegroups: parameters: [] get: tags: - Installer summary: listInstallerSiteGroups description: Return site groups that installers can assign when creating or updating sites. operationId: listInstallerSiteGroups parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: Installer List of Site Groups headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/installers_item' description: Installer access entries returned by list responses examples: - - id: 581328b6-e382-f54e-c9dc-999983183a34 name: SiteGroup 1 contentMediaType: application/json examples: Example: value: - id: 581328b6-e382-f54e-c9dc-999983183a34 name: SiteGroup 1 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/installers_item' description: Installer access entries returned by list responses examples: - - id: 581328b6-e382-f54e-c9dc-999983183a34 name: SiteGroup 1 contentMediaType: application/vnd.api+json examples: Example: value: - id: 581328b6-e382-f54e-c9dc-999983183a34 name: SiteGroup 1 '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/installer/orgs/{org_id}/sites: parameters: [] get: tags: - Installer summary: listInstallerSites description: Return sites visible to installer workflows for device assignment and map operations. operationId: listInstallerSites parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: List of Sites headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/installer_site' description: Sites available to installer workflows examples: - - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014 country_code: US id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b latlng: lat: 37.295833 lng: -122.032946 name: Mist Office rftemplate_name: rftemplate1 sitegroup_names: - sg1 - sg2 timezone: America/Los_Angeles contentMediaType: application/json examples: Example: value: - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014 country_code: US id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b latlng: lat: 37.295833 lng: -122.032946 name: Mist Office rftemplate_name: rftemplate1 sitegroup_names: - sg1 - sg2 timezone: America/Los_Angeles application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/installer_site' description: Sites available to installer workflows examples: - - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014 country_code: US id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b latlng: lat: 37.295833 lng: -122.032946 name: Mist Office rftemplate_name: rftemplate1 sitegroup_names: - sg1 - sg2 timezone: America/Los_Angeles contentMediaType: application/vnd.api+json examples: Example: value: - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014 country_code: US id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b latlng: lat: 37.295833 lng: -122.032946 name: Mist Office rftemplate_name: rftemplate1 sitegroup_names: - sg1 - sg2 timezone: America/Los_Angeles '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/installer/orgs/{org_id}/sites/{site_name}: parameters: [] put: tags: - Installer summary: createOrUpdateInstallerSites description: Use `site_name` to create a site when it does not exist, or to update installer-editable fields on an existing site. Installers use these sites for device assignment, and grace-period rules also apply when updating an existing site. operationId: createOrUpdateInstallerSites parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: site_name in: path description: '' required: true schema: type: string requestBody: description: Request Body content: application/json: schema: allOf: - $ref: '#/components/schemas/installer_site' - description: Request Body examples: - address: 1601 S. Deanza Blvd., Cupertino, CA, 95014 country_code: US latlng: lat: 37.295833 lng: -122.032946 name: string rftemplate_name: rftemplate1 sitegroup_names: - sg1 - sg2 timezone: America/Los_Angeles contentMediaType: application/json examples: Example: value: address: 1601 S. Deanza Blvd., Cupertino, CA, 95014 country_code: US latlng: lat: 37.295833 lng: -122.032946 name: string rftemplate_name: rftemplate1 sitegroup_names: - sg1 - sg2 timezone: America/Los_Angeles required: false 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 /api/v1/installer/orgs/{org_id}/sites/{site_name}/maps: parameters: [] get: tags: - Installer summary: listInstallerMaps description: Return maps for an installer-managed site, used for floorplan selection and AP placement during provisioning. operationId: listInstallerMaps parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: site_name in: path description: '' required: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/map' description: Maps or floorplans returned by the API examples: - - created_time: 0 flags: {} group_idx: 1 group_name: East Wing height: 0 height_m: 0 id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 latlng_br: lat: string lng: string latlng_tl: lat: string lng: string locked: true modified_time: 0 name: string occupancy_limit: 0 org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 orientation: 0 origin_x: 0 origin_y: 0 ppm: 0 site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 sitesurvey_path: - coordinate: string id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 name: string nodes: - edges: N2: string name: string position: x: 0 y: 0 thumbnail_url: string type: image url: string view: roadmap wall_path: coordinate: string nodes: - edges: N2: string name: string position: x: 0 y: 0 wayfinding: micello: account_key: string default_level_id: 0 map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 snap_to_path: true wayfinding_path: coordinate: string nodes: - edges: N2: string name: string position: x: 0 y: 0 width: 0 width_m: 0 contentMediaType: application/json examples: Example: value: - created_time: 0 flags: {} group_idx: 1 group_name: East Wing height: 0 height_m: 0 id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 latlng_br: lat: string lng: string latlng_tl: lat: string lng: string locked: true modified_time: 0 name: string occupancy_limit: 0 org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 orientation: 0 origin_x: 0 origin_y: 0 ppm: 0 site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 sitesurvey_path: - coordinate: string id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 name: string nodes: - edges: N2: string name: string position: x: 0 y: 0 thumbnail_url: string type: image url: string view: roadmap wall_path: coordinate: string nodes: - edges: N2: string name: string position: x: 0 y: 0 wayfinding: micello: account_key: string default_level_id: 0 map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 snap_to_path: true wayfinding_path: coordinate: string nodes: - edges: N2: string name: string position: x: 0 y: 0 width: 0 width_m: 0 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/map' description: Maps or floorplans returned by the API examples: - - created_time: 0 flags: {} group_idx: 1 group_name: East Wing height: 0 height_m: 0 id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 latlng_br: lat: string lng: string latlng_tl: lat: string lng: string locked: true modified_time: 0 name: string occupancy_limit: 0 org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 orientation: 0 origin_x: 0 origin_y: 0 ppm: 0 site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 sitesurvey_path: - coordinate: string id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 name: string nodes: - edges: N2: string name: string position: x: 0 y: 0 thumbnail_url: string type: image url: string view: roadmap wall_path: coordinate: string nodes: - edges: N2: string name: string position: x: 0 y: 0 wayfinding: micello: account_key: string default_level_id: 0 map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 snap_to_path: true wayfinding_path: coordinate: string nodes: - edges: N2: string name: string position: x: 0 y: 0 width: 0 width_m: 0 contentMediaType: application/vnd.api+json examples: Example: value: - created_time: 0 flags: {} group_idx: 1 group_name: East Wing height: 0 height_m: 0 id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 latlng_br: lat: string lng: string latlng_tl: lat: string lng: string locked: true modified_time: 0 name: string occupancy_limit: 0 org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 orientation: 0 origin_x: 0 origin_y: 0 ppm: 0 site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 sitesurvey_path: - coordinate: string id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 name: string nodes: - edges: N2: string name: string position: x: 0 y: 0 thumbnail_url: string type: image url: string view: roadmap wall_path: coordinate: string nodes: - edges: N2: string name: string position: x: 0 y: 0 wayfinding: micello: account_key: string default_level_id: 0 map_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 snap_to_path: true wayfinding_path: coordinate: string nodes: - edges: N2: string name: string position: x: 0 y: 0 width: 0 width_m: 0 '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/installer/orgs/{org_id}/sites/{site_name}/maps/import: parameters: [] post: tags: - Installer summary: importInstallerMap description: Import a site floorplan and optional placement data from multipart files. The request can include an image file, optional JSON, and optional CSV data to create the map and assign or place APs when names or MAC addresses match. operationId: importInstallerMap parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: site_name in: path description: '' required: true schema: type: string requestBody: content: multipart/form-data: encoding: {} schema: type: object properties: auto_deviceprofile_assignment: type: boolean description: Whether to auto assign device to deviceprofile by name examples: - true csv: type: string description: Optional AP name-mapping CSV file contentEncoding: base64 file: type: string description: Ekahau or iBwave floorplan file to import contentEncoding: base64 json: allOf: - $ref: '#/components/schemas/map_import_json1' - description: Import options for the site map file contentMediaType: multipart/form-data required: false responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_map_import' - description: Result of importing map files and matching AP placements examples: - '{"aps":[{"action":"assigned-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}' - '{"aps":[{"action":"assigned-named-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}' - '{"aps":[{"action":"placed","floorplan_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}' contentMediaType: application/json examples: Assigned And Placed: value: aps: - action: assigned-placed floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9 height: 3 mac: 5c5b35000001 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 orientation: 45 floorplans: - action: imported id: cbdb7f0b-3be0-4872-88f9-58790b509c23 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 name: map1 site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b summary: num_ap_assigned: 1 num_inv_assigned: 1 num_map_assigned: 1 Assigned Named And Placed: value: aps: - action: assigned-named-placed floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9 mac: 5c5b35000001 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 orientation: 45 floorplans: - action: imported id: cbdb7f0b-3be0-4872-88f9-58790b509c23 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 name: map1 site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b summary: num_ap_assigned: 1 num_inv_assigned: 1 num_map_assigned: 1 Placed: value: aps: - action: placed floorplan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 height: 3 mac: 5c5b35000001 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 orientation: 45 floorplans: - action: imported id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 name: map1 site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b summary: num_ap_assigned: 1 num_inv_assigned: 1 num_map_assigned: 1 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_map_import' - description: Result of importing map files and matching AP placements examples: - '{"aps":[{"action":"assigned-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}' - '{"aps":[{"action":"assigned-named-placed","floorplan_id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"cbdb7f0b-3be0-4872-88f9-58790b509c23","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}' - '{"aps":[{"action":"placed","floorplan_id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","height":3,"mac":"5c5b35000001","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":45}],"floorplans":[{"action":"imported","id":"b069b358-4c97-5319-1f8c-7c5ca64d6ab1","map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","name":"map1"}],"site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","summary":{"num_ap_assigned":1,"num_inv_assigned":1,"num_map_assigned":1}}' contentMediaType: application/vnd.api+json examples: Assigned And Placed: value: aps: - action: assigned-placed floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9 height: 3 mac: 5c5b35000001 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 orientation: 45 floorplans: - action: imported id: cbdb7f0b-3be0-4872-88f9-58790b509c23 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 name: map1 site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b summary: num_ap_assigned: 1 num_inv_assigned: 1 num_map_assigned: 1 Assigned Named And Placed: value: aps: - action: assigned-named-placed floorplan_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9 mac: 5c5b35000001 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 orientation: 45 floorplans: - action: imported id: cbdb7f0b-3be0-4872-88f9-58790b509c23 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 name: map1 site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b summary: num_ap_assigned: 1 num_inv_assigned: 1 num_map_assigned: 1 Placed: value: aps: - action: placed floorplan_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 height: 3 mac: 5c5b35000001 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 orientation: 45 floorplans: - action: imported id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 map_id: 845a23bf-bed9-e43c-4c86-6fa474be7ae5 name: map1 site_id: 4ac1dcf4-9d8b-7211-65c4-057819f0862b summary: num_ap_assigned: 1 num_inv_assigned: 1 num_map_assigned: 1 '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/installer/orgs/{org_id}/sites/{site_name}/maps/{map_id}: parameters: [] delete: tags: - Installer summary: deleteInstallerMap description: Remove a map or floorplan from an installer-managed site. This removes the map used for AP placement, but does not delete the site. operationId: deleteInstallerMap parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: site_name in: path description: '' required: true schema: type: string - name: map_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 post: tags: - Installer summary: createInstallerMap description: Define a map or floorplan for an installer-managed site, including metadata used for AP placement and site visualization. operationId: createInstallerMap parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: site_name in: path description: '' required: true schema: type: string - name: map_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/map' - description: Request Body examples: - height: 0 latlng_br: lat: string lng: string latlng_tl: lat: string lng: string locked: true name: string orientation: 0 origin_x: 0 origin_y: 0 ppm: 0 sitesurvey_path: - coordinate: string name: string nodes: - edges: N2: string name: string position: x: 0 y: 0 type: image view: roadmap wall_path: coordinate: string nodes: - edges: N2: string name: string position: x: 0 y: 0 wayfinding: micello: account_key: string default_level_id: 0 snap_to_path: true wayfinding_path: coordinate: string nodes: - edges: N2: string name: string position: x: 0 y: 0 width: 0 contentMediaType: application/json examples: Example: value: height: 0 latlng_br: lat: string lng: string latlng_tl: lat: string lng: string locked: true name: string orientation: 0 origin_x: 0 origin_y: 0 ppm: 0 sitesurvey_path: - coordinate: string name: string nodes: - edges: N2: string name: string position: x: 0 y: 0 type: image view: roadmap wall_path: coordinate: string nodes: - edges: N2: string name: string position: x: 0 y: 0 wayfinding: micello: account_key: string default_level_id: 0 snap_to_path: true wayfinding_path: coordinate: string nodes: - edges: N2: string name: string position: x: 0 y: 0 width: 0 required: false responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/map' - description: Map or floorplan metadata for a site or organization contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/map' - description: Map or floorplan metadata for a site or organization contentMediaType: application/vnd.api+json '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: - Installer summary: updateInstallerMap description: Modify map or floorplan metadata for an installer-managed site, including dimensions, orientation, and placement-related settings. operationId: updateInstallerMap parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: site_name in: path description: '' required: true schema: type: string - name: map_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/map' - description: Request Body contentMediaType: application/json required: false responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/map' - description: Map or floorplan metadata for a site or organization contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/map' - description: Map or floorplan metadata for a site or organization contentMediaType: application/vnd.api+json '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/installer/sites/{site_name}/optimize: parameters: [] get: tags: - Installer summary: optimizeInstallerRrm description: Trigger RF optimization after installation is complete, such as after APs have been placed on maps and powered on. This starts RRM before the next automatic optimization schedule. operationId: optimizeInstallerRrm parameters: - name: site_name in: path description: '' required: true schema: type: string 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 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 virtual_chassis_config_member_vc_role2: title: virtual_chassis_config_member_vc_role2 enum: - backup - linecard - master type: string description: 'Role of this member in the Virtual Chassis. enum: `backup`, `linecard`, `master`.' map_geofence: title: map_geofence type: object properties: name: type: string description: Display name for the map geofence examples: - example vertices: type: array items: $ref: '#/components/schemas/map_geofence_vertice' description: Polygon points that define the geofence boundary description: Geofence drawn on a map virtual_chassis_member_update_vc_role2: title: virtual_chassis_member_update_vc_role2 enum: - backup - linecard - master type: string description: 'Required if `op`==`add` or `op`==`preprovision`; role of the member in the Virtual Chassis. enum: `backup`, `linecard`, `master`.' map: title: map type: object properties: created_time: type: number description: Timestamp when the map was created readOnly: true flags: type: object additionalProperties: type: integer format: int32 description: Name/val pair objects for location engine to use readOnly: true examples: - assetHoldTime: 5 storeTime: 10 for_site: type: boolean description: Whether this map belongs to a site scope readOnly: true geofences: type: array items: $ref: '#/components/schemas/map_geofence' description: Location boundary definitions configured on this map group_idx: type: integer description: Optional floor or group ordering index for this map contentEncoding: int32 examples: - 1 group_name: type: string description: Optional floor or group display name for this map examples: - East Wing height: type: integer description: When `type`==`image`, height of the map image in pixels contentEncoding: int32 examples: - 1500 height_m: type: number description: Physical height of the map in meters id: type: string description: Unique identifier of the map contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f latlng_br: allOf: - $ref: '#/components/schemas/latlng_br1' - description: When `type`==`google`, bottom-right map bounds coordinate latlng_tl: allOf: - $ref: '#/components/schemas/latlng_tl1' - description: When `type`==`google`, top-left map bounds coordinate locked: type: boolean description: Whether this map is considered locked down default: false modified_time: type: number description: Timestamp when the map was last modified readOnly: true name: type: string description: The name of the map examples: - Mist Office occupancy_limit: type: integer description: Maximum occupancy configured for this map contentEncoding: int32 org_id: type: string description: Organization associated with this map contentEncoding: uuid readOnly: true examples: - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61 orientation: maximum: 359 minimum: 0 type: integer description: Map orientation in degrees; 0 means up is north, 90 means up is west contentEncoding: int32 default: 0 examples: - 30 origin_x: type: integer description: User-annotated X origin, pixels contentEncoding: int32 examples: - 35 origin_y: type: integer description: User-annotated Y origin, pixels contentEncoding: int32 examples: - 60 ppm: type: number description: When `type`==`image`, pixels per meter for the map image examples: - 40.94 site_id: type: string description: Site associated with this map, when scoped to a site contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 sitesurvey_path: minItems: 0 type: array items: $ref: '#/components/schemas/map_sitesurvey_path_items' description: Site survey path geometry for this map thumbnail_url: type: string description: When `type`==`image`, URL for the thumbnail image or preview readOnly: true examples: - https://url/to/image.png type: allOf: - $ref: '#/components/schemas/map_type2' - description: Map type, such as `image` or `google` examples: - image url: type: string description: When `type`==`image`, URL for the map image readOnly: true examples: - https://url/to/image.png view: allOf: - oneOf: - {} - $ref: '#/components/schemas/map_view2' - description: 'If `type`==`google`, map tile view to display. enum: `hybrid`, `roadmap`, `satellite`, `terrain`.' wall_path: allOf: - $ref: '#/components/schemas/map_wall_path2' - description: Wall path geometry for this map wayfinding: allOf: - $ref: '#/components/schemas/map_wayfinding2' - description: Navigation pathfinding settings for this map wayfinding_path: allOf: - $ref: '#/components/schemas/map_wayfinding_path2' - description: Wayfinding path geometry for this map width: type: integer description: When `type`==`image`, width of the map image in pixels contentEncoding: int32 examples: - 1250 width_m: type: number description: Physical width of the map in meters description: Map or floorplan metadata for a site or organization module_stat_item_psus_item: title: module_stat_item_psus_item type: object properties: name: type: string description: Power supply label reported by the device examples: - Power Supply 0 status: type: string description: Operational status reported for the power supply examples: - ok description: Power supply status for a device module module_stat_item_pics_item: title: module_stat_item_pics_item type: object properties: index: type: integer description: PIC index within the device module contentEncoding: int32 model_number: type: string description: Model number reported for the PIC port_groups: type: array items: $ref: '#/components/schemas/module_stat_item_pics_item_port_groups_item' description: Port groups provided by this PIC description: Physical Interface Card summary for a device module 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 map_view2: title: map_view2 enum: - hybrid - roadmap - satellite - terrain type: string description: 'If `type`==`google`, map tile view to display. enum: `hybrid`, `roadmap`, `satellite`, `terrain`.' response_virtual_chassis_config: title: response_virtual_chassis_config type: object properties: config_type: type: string description: Provisioning mode of the virtual chassis configuration readOnly: true id: type: string description: Unique value identifying the virtual chassis device record contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f locating: type: boolean description: Whether locate mode is active for the virtual chassis device readOnly: true mac: type: string description: Device MAC address for the virtual chassis device record members: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/stats_switch_module_stat_item' description: Virtual chassis member module statistics and topology details model: type: string description: Switch model for the virtual chassis device record readOnly: true num_routing_engines: type: integer description: Number of routing engines in the virtual chassis contentEncoding: int32 examples: - 1 org_id: type: string description: Organization identifier for the virtual chassis device contentEncoding: uuid readOnly: true examples: - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61 serial: type: string description: Device serial number reported for the virtual chassis readOnly: true site_id: type: string description: Identifier of the site containing the virtual chassis contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 status: type: string description: Connection status of the virtual chassis device readOnly: true type: type: string description: Device type for the virtual chassis record vc_mac: type: string description: Virtual Chassis MAC address used to identify the VC device readOnly: true description: Combined virtual chassis status, topology, and member statistics map_import_json1: title: map_import_json1 required: - vendor_name type: object properties: import_all_floorplans: type: boolean description: Whether to import all floorplans from the uploaded map JSON default: false import_height: type: boolean description: Whether to import height metadata from the uploaded map JSON default: true import_orientation: type: boolean description: Whether to import orientation metadata from the uploaded map JSON default: true vendor_name: allOf: - $ref: '#/components/schemas/map_import_json_vendor_name2' - description: 'Map import vendor for the uploaded JSON. enum: `ekahau`, `ibwave`.' examples: - ekahau description: Import options for the site map file response_map_import_ap_action2: title: response_map_import_ap_action2 enum: - assigned-named-placed - assigned-placed - ignored - named-placed - placed type: string description: 'Import action applied to this AP. enum: `assigned-named-placed`, `assigned-placed`, `ignored`, `named-placed`, `placed`.' map_node_position2: title: map_node_position2 required: - x - y type: object properties: x: type: number description: Horizontal coordinate of the map node examples: - 746 y: type: number description: Vertical coordinate of the map node examples: - 104 description: Coordinates of this map node cpu_stat1: title: cpu_stat1 type: object properties: idle: type: - number - 'null' description: Percentage of CPU time that is idle readOnly: true interrupt: type: - number - 'null' description: Percentage of CPU time being used by interrupts readOnly: true load_avg: type: array items: type: number description: Load averages for the last 1, 5, and 15 minutes system: type: - number - 'null' description: Percentage of CPU time being used by system processes readOnly: true usage: type: - number - 'null' description: Overall CPU usage percentage readOnly: true user: type: - number - 'null' description: Percentage of CPU time being used by user processes readOnly: true description: Processor utilization statistics for the switch module module_stat_item_poe1: title: module_stat_item_poe1 type: object properties: max_power: type: number description: Total PoE power budget available to the module, in watts examples: - 250 power_draw: type: number description: Current PoE power draw on the module, in watts examples: - 120.3 status: type: string description: Operational status of PoE on the module description: Power over Ethernet telemetry for the switch module installer_site: title: installer_site required: - address - country_code - latlng - name type: object properties: address: type: string description: Street or postal address for the installer site examples: - 1601 S. Deanza Blvd., Cupertino, CA, 95014 country_code: type: string description: ISO country code for the installer site examples: - US id: type: string description: Unique identifier of the installer site contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f latlng: allOf: - $ref: '#/components/schemas/lat_lng4' - description: Geographic coordinates of the installer site name: type: string description: Display name of the installer site examples: - Mist Office rftemplate_name: type: string description: RF template name applied to the installer site examples: - rftemplate1 sitegroup_names: type: array items: type: string description: Names of site groups associated with the installer site examples: - - sg1 - sg2 timezone: type: string description: Time zone configured for the installer site examples: - America/Los_Angeles description: Site definition available to installer workflows map_node: title: map_node required: - name type: object properties: edges: type: object additionalProperties: type: string description: Adjacent node IDs and path weights for this map node examples: - N1: '1' name: type: string description: Map node identifier or display name examples: - N1 position: allOf: - $ref: '#/components/schemas/map_node_position2' - description: Coordinates of this map node description: Node in a map path graph response_inventory_inventory_added_items: title: response_inventory_inventory_added_items required: - mac - magic - model - serial - type type: object properties: mac: type: string description: Device MAC address for the claimed inventory item examples: - 5c5b35000018 magic: type: string description: Activation code or claim code associated with the inventory item examples: - 6JG8EPTFV2A9Z2N model: type: string description: Device model for the claimed inventory item examples: - AP41 serial: type: string description: Device serial number for the claimed inventory item examples: - FXLH2015150025 type: type: string description: Device type for the claimed inventory item examples: - ap description: Inventory device added by the claim operation response_map_import_ap: title: response_map_import_ap required: - action - floorplan_id - mac - map_id - orientation type: object properties: action: allOf: - $ref: '#/components/schemas/response_map_import_ap_action2' - description: 'Import action applied to this AP. enum: `assigned-named-placed`, `assigned-placed`, `ignored`, `named-placed`, `placed`.' floorplan_id: type: string description: Floorplan identifier where the AP placement was imported contentEncoding: uuid height: type: number description: Mounting height for the AP on the imported floorplan mac: type: string description: AP MAC address matched from the import file map_id: type: string description: Map identifier associated with the imported AP placement contentEncoding: uuid orientation: type: integer description: AP orientation in degrees on the imported floorplan contentEncoding: int32 reason: type: string description: Explanation of why the AP import action was not completed, when provided description: AP placement result from a map import stats_switch_module_stat_item: title: stats_switch_module_stat_item type: object properties: backup_version: type: - string - 'null' description: Backup software version stored on the switch module readOnly: true bios_version: type: - string - 'null' description: BIOS firmware version reported for the switch module readOnly: true boot_partition: type: string description: Active boot partition used by the switch module cpld_version: type: - string - 'null' description: CPLD firmware version reported for the switch module readOnly: true cpu_stat: allOf: - $ref: '#/components/schemas/cpu_stat1' - description: Processor utilization statistics for the switch module errors: type: array items: $ref: '#/components/schemas/module_stat_item_errors_items' description: Hardware error records reported for the switch module fans: uniqueItems: true type: array items: $ref: '#/components/schemas/module_stat_item_fans_items' description: Cooling fan status records for the switch module fpc_idx: type: integer description: FPC index identifying this switch module contentEncoding: int32 readOnly: true fpga_version: type: - string - 'null' description: FPGA firmware version reported for the switch module readOnly: true last_seen: type: - number - 'null' description: Time when Mist last observed this switch module, in epoch seconds readOnly: true examples: - 1470417522 locating: type: boolean description: Whether the switch module locator indicator is active mac: type: string description: Switch module MAC address reported by Mist examples: - fc3342123456 memory_stat: allOf: - $ref: '#/components/schemas/memory_stat1' - description: Utilization statistics for switch module memory model: type: - string - 'null' description: Switch module model name reported by Mist readOnly: true examples: - EX4300-48P optics_cpld_version: type: - string - 'null' description: Optics CPLD firmware version reported for the switch module readOnly: true pending_version: type: - string - 'null' description: Pending software version staged for the switch module readOnly: true pics: type: array items: $ref: '#/components/schemas/module_stat_item_pics_item' description: Physical Interface Card status records for the switch module poe: allOf: - $ref: '#/components/schemas/module_stat_item_poe1' - description: Power over Ethernet telemetry for the switch module poe_version: type: - string - 'null' description: PoE controller firmware version reported for the switch module readOnly: true power_cpld_version: type: - string - 'null' description: Power CPLD firmware version reported for the switch module readOnly: true psus: uniqueItems: true type: array items: $ref: '#/components/schemas/module_stat_item_psus_item' description: Power supply status records for the switch module re_fpga_version: type: - string - 'null' description: Routing Engine FPGA firmware version reported for the switch module readOnly: true recovery_version: type: - string - 'null' description: Recovery software version stored on the switch module readOnly: true serial: type: - string - 'null' description: Switch module serial number reported by Mist readOnly: true examples: - PX8716230021 status: type: - string - 'null' description: Connection status reported for the switch module readOnly: true temperatures: uniqueItems: true type: array items: $ref: '#/components/schemas/module_stat_item_temperatures_item' description: Temperature sensor readings for the switch module tmc_fpga_version: type: - string - 'null' description: TMC FPGA firmware version reported for the switch module readOnly: true type: type: - string - 'null' description: Module type reported for the switch module readOnly: true uboot_version: type: - string - 'null' description: U-Boot firmware version reported for the switch module readOnly: true uptime: type: - integer - 'null' description: Elapsed time since the switch module last booted, in seconds contentEncoding: int32 readOnly: true vc_links: uniqueItems: true type: array items: $ref: '#/components/schemas/module_stat_item_vc_links_item' description: Virtual chassis link records for the switch module vc_mode: type: - string - 'null' description: Virtual chassis mode reported for the switch module readOnly: true vc_role: type: - string - 'null' description: 'enum: `master`, `backup`, `linecard`' readOnly: true examples: - master vc_state: type: - string - 'null' description: Virtual chassis state reported for the switch module readOnly: true version: type: - string - 'null' description: Software version running on the switch module readOnly: true description: Hardware module status and firmware inventory for a switch map_wayfinding2: title: map_wayfinding2 type: object properties: micello: allOf: - $ref: '#/components/schemas/map_wayfinding_micello2' - description: External Micello wayfinding integration settings for this map snap_to_path: type: boolean description: Whether wayfinding should snap routes to configured paths description: Navigation pathfinding settings for this map installer_device_ble_stat2: title: installer_device_ble_stat2 type: object properties: major: type: integer description: iBeacon major value reported by the device contentEncoding: int32 examples: - 12345 minors: type: array items: type: integer contentEncoding: int32 description: iBeacon minor values reported by the device uuid: type: string description: iBeacon UUID advertised by the device contentEncoding: uuid examples: - ada72f8f-1643-e5c6-94db-f2a5636f1a64 description: BLE beacon statistics reported by the device lat_lng4: title: lat_lng4 required: - lat - lng type: object properties: lat: type: number description: Geographic latitude in decimal degrees examples: - 37.295833 lng: type: number description: Geographic longitude in decimal degrees examples: - -122.032946 description: Geographic coordinates of the installer site latlng_br1: title: latlng_br1 type: object properties: lat: type: string description: Bottom-right latitude for the Google map bounds lng: type: string description: Bottom-right longitude for the Google map bounds description: When `type`==`google`, bottom-right map bounds coordinate module_stat_item_temperatures_item: title: module_stat_item_temperatures_item type: object properties: celsius: type: number description: Temperature reading for the sensor, in degrees Celsius examples: - 45 name: type: string description: Temperature sensor label reported by the device examples: - CPU status: type: string description: Operational status reported for the temperature sensor examples: - ok description: Temperature sensor reading for a device module device_type_default_ap: title: device_type_default_ap enum: - ap - gateway - switch type: string description: 'enum: `ap`, `gateway`, `switch`' response_map_import_floorplan: title: response_map_import_floorplan required: - action - id - map_id - name type: object properties: action: type: string description: Import action applied to this floorplan id: type: string description: Floorplan identifier returned by the import contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f map_id: type: string description: Map identifier associated with the imported floorplan contentEncoding: uuid name: type: string description: Floorplan name imported from the map file reason: type: string description: Explanation of why the floorplan import action was not completed, when provided description: Floorplan result from a map import latlng_tl1: title: latlng_tl1 type: object properties: lat: type: string description: Top-left latitude for the Google map bounds lng: type: string description: Top-left longitude for the Google map bounds description: When `type`==`google`, top-left map bounds coordinate map_geofence_vertice: title: map_geofence_vertice type: object properties: X: type: number description: Geofence vertex X coordinate in map units examples: - 700 Y: type: number description: Geofence vertex Y coordinate in map units examples: - 100 description: Vertex coordinate for a map geofence polygon response_inventory: title: response_inventory type: object properties: added: type: array items: type: string description: Claim codes accepted into organization inventory duplicated: type: array items: type: string description: Claim codes already present in organization inventory error: type: array items: type: string description: Claim codes rejected by the inventory add operation inventory_added: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/response_inventory_inventory_added_items' description: Detailed inventory records added by the claim operation inventory_duplicated: uniqueItems: true type: array items: $ref: '#/components/schemas/response_inventory_inventory_duplicated_items' description: Detailed inventory records already present during the claim operation reason: uniqueItems: true type: array items: type: string description: Error reasons for claim codes that could not be added description: Result of adding device claim codes to organization inventory map_wayfinding_path2: title: map_wayfinding_path2 type: object properties: coordinate: type: string description: Wayfinding path coordinate space examples: - actual nodes: minItems: 0 type: array items: $ref: '#/components/schemas/map_node' description: Path nodes used for wayfinding routes description: Wayfinding path geometry for this map installer_device: title: installer_device type: object properties: ble_stat: allOf: - $ref: '#/components/schemas/installer_device_ble_stat2' - description: BLE beacon statistics reported by the device connected: type: boolean description: Whether the device is currently connected to Mist examples: - true deviceprofile_name: type: string description: Device profile name associated with this installer device examples: - SJ1 ext_ip: type: string description: External IP address observed for device management traffic examples: - 12.34.56.78 height: type: number description: Mounting height recorded for map placement examples: - 2.7 ip: type: string description: Management IP address currently reported for the device examples: - 192.168.1.111 last_seen: type: - number - 'null' description: Timestamp when the device was last seen by Mist readOnly: true examples: - 1470417522 mac: type: string description: Device MAC address shown to installers examples: - 5c5b35000018 map_id: type: string description: Map where the installer placed this device contentEncoding: uuid examples: - 845a23bf-bed9-e43c-4c86-6fa474be7ae5 model: type: string description: Device model reported for this installer device examples: - AP41 name: type: string description: Device name configured through the installer workflow examples: - hallway orientation: type: integer description: Device orientation in degrees from 0 to 359, where 0 is up and 90 is right contentEncoding: int32 examples: - 90 serial: type: string description: Device serial number reported to installer workflows examples: - FXLH2015150025 site_name: type: string description: Site name associated with this installer device examples: - SJ1 uptime: type: integer description: Device uptime, in seconds contentEncoding: int32 examples: - 12345 vc_mac: type: - string - 'null' description: Virtual Chassis MAC address when this device is part of a VC version: type: string description: Software version currently running on the device examples: - 0.10.24362 x: type: number description: Horizontal map position of the device, in pixels examples: - 150 y: type: number description: Vertical map position of the device, in pixels examples: - 300 description: Recently claimed device visible to installer workflows module_stat_item_vc_links_item: title: module_stat_item_vc_links_item type: object properties: neighbor_module_idx: type: integer description: Index of the neighboring module connected through this virtual chassis link contentEncoding: int32 examples: - 1 neighbor_port_id: type: string description: Port identifier on the neighboring module for this virtual chassis link examples: - vcp-255/1/0 port_id: type: string description: Local port identifier for this virtual chassis link examples: - vcp-255/1/0 description: Virtual chassis link endpoint for a device module response_map_import: title: response_map_import required: - aps - floorplans - site_id - summary type: object properties: aps: uniqueItems: true type: array items: $ref: '#/components/schemas/response_map_import_ap' description: AP placement results produced by the map import floorplans: uniqueItems: true type: array items: $ref: '#/components/schemas/response_map_import_floorplan' description: Floorplan import results produced by the map import for_site: type: boolean description: Whether this map import response is scoped to a site readOnly: true site_id: type: string description: Site associated with the map import result contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 summary: allOf: - $ref: '#/components/schemas/response_map_import_summary' - description: Counts summarizing assignments made during the map import description: Result of importing map files and matching AP placements virtual_chassis_member_update: title: virtual_chassis_member_update type: object properties: mac: type: string description: Required if `op`==`add` or `op`==`preprovision`; MAC address of the member to add or preprovision member: type: integer description: Required if `op`==`remove`; member ID to remove from the Virtual Chassis contentEncoding: int32 member_id: type: integer description: Required if `op`==`preprovision`. Optional if `op`==`add`; target member ID for the Virtual Chassis member contentEncoding: int32 vc_ports: type: array items: type: string description: Required if `op`==`add` or `op`==`preprovision`; port names to use as Virtual Chassis ports vc_role: allOf: - $ref: '#/components/schemas/virtual_chassis_member_update_vc_role2' - description: 'Required if `op`==`add` or `op`==`preprovision`; role of the member in the Virtual Chassis. enum: `backup`, `linecard`, `master`.' description: Member update for a Virtual Chassis add, remove, or preprovision operation module_stat_item_pics_item_port_groups_item: title: module_stat_item_pics_item_port_groups_item type: object properties: count: type: integer description: Number of ports in this PIC port group contentEncoding: int32 type: type: string description: Port media or interface type for this PIC port group description: Port group summary for a PIC memory_stat1: title: memory_stat1 required: - usage type: object properties: usage: type: number description: Current memory utilization percentage for the device or master Routing Engine description: Utilization statistics for switch module memory map_type2: title: map_type2 enum: - google - image type: string description: Map type, such as `image` or `google` examples: - image virtual_chassis_update: title: virtual_chassis_update type: object properties: member: type: integer description: Only if `op`==`renumber`; existing member ID to renumber contentEncoding: int32 members: type: array items: $ref: '#/components/schemas/virtual_chassis_member_update' description: Member updates for add, remove, or preprovision operations new-member: type: integer description: Only if `op`==`renumber`; new member ID to assign contentEncoding: int32 op: allOf: - $ref: '#/components/schemas/virtual_chassis_update_op2' - description: 'Action to perform on the Virtual Chassis. enum: `add`, `preprovision`, `remove`, `renumber`.' remove_inventory: type: boolean description: Only if `op`==`preprovision`. When removing members from a pre-provisioned VC, set to `true` to delete the inventory records for removed members (e.g. for RMA). Members being removed must be in "not-present" state. default: false description: Virtual Chassis member update request module_stat_item_fans_items: title: module_stat_item_fans_items type: object properties: airflow: type: string description: Direction of airflow reported for the fan examples: - out name: type: string description: Fan label reported by the device examples: - Fan 0 rpm: type: integer description: Current fan speed in revolutions per minute contentEncoding: int32 status: type: string description: Operational status reported for the fan examples: - ok description: Cooling fan telemetry for a device module map_wall_path2: title: map_wall_path2 type: object properties: coordinate: type: string description: Wall path coordinate space examples: - actual nodes: minItems: 0 type: array items: $ref: '#/components/schemas/map_node' description: Path nodes that define the wall geometry description: Wall path geometry for this map module_stat_item_errors_items: title: module_stat_item_errors_items required: - since - type type: object properties: feature: type: string description: Affected feature associated with this module error condition examples: - Mist-Management minimum_version: type: string description: Minimum software version associated with this module error examples: - 128T-6.0.0-1 reason: type: string description: Human-readable reason for the module error condition since: type: integer description: Epoch timestamp when the module error condition began contentEncoding: int32 examples: - 1657497600 type: type: string description: Module error type code reported by the device examples: - FW_UPGRADE_REQUIRED_BY_FEATURE description: Error condition reported for a device module response_map_import_summary: title: response_map_import_summary required: - num_ap_assigned - num_inv_assigned - num_map_assigned type: object properties: num_ap_assigned: type: integer description: Number of AP placements assigned during the map import contentEncoding: int32 num_inv_assigned: type: integer description: Number of inventory records assigned to the site during the map import contentEncoding: int32 num_map_assigned: type: integer description: Number of map floorplans assigned during the map import contentEncoding: int32 description: Counts summarizing assignments made during the map import map_sitesurvey_path_items: title: map_sitesurvey_path_items type: object properties: coordinate: type: string description: Site survey path coordinate space examples: - actual id: type: string description: Unique identifier of the site survey path contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f name: type: string description: Display name of the site survey path examples: - Default nodes: minItems: 0 type: array items: $ref: '#/components/schemas/map_node' description: Path nodes included in the site survey path description: Site survey path definition on a map installers_item: title: installers_item type: object properties: id: type: string description: Unique identifier of the installer access entry contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f name: type: string description: Display name of the installer access entry examples: - 'Entry #1' description: Installer access entry with scope and role details virtual_chassis_config: title: virtual_chassis_config type: object properties: locating: type: boolean description: Whether the Virtual Chassis is currently in locate mode readOnly: true members: type: array items: $ref: '#/components/schemas/virtual_chassis_config_member' description: Virtual Chassis members and their expected roles and VC ports preprovisioned: type: boolean description: Whether to create the Virtual Chassis in pre-provisioned mode default: false description: Virtual Chassis creation or configuration request response_detail_string: title: response_detail_string type: object properties: detail: type: string description: Human-readable detail message returned by the API description: Response containing a human-readable detail message response_inventory_inventory_duplicated_items: title: response_inventory_inventory_duplicated_items required: - mac - magic - model - serial - type type: object properties: mac: type: string description: Device MAC address for the duplicate inventory item examples: - 5c5b35000012 magic: type: string description: Activation code or claim code associated with the duplicate inventory item examples: - DVH4VSNMSZPDXBR model: type: string description: Device model for the duplicate inventory item examples: - AP41 serial: type: string description: Device serial number for the duplicate inventory item examples: - FXLH2015150027 type: type: string description: Device type for the duplicate inventory item examples: - ap description: Inventory device already present during the claim operation map_wayfinding_micello2: title: map_wayfinding_micello2 type: object properties: account_key: type: string description: Micello account key used for wayfinding examples: - adasdf default_level_id: type: integer description: Default Micello floor or level identifier for wayfinding contentEncoding: int32 examples: - 5 map_id: type: string description: Micello map identifier used for wayfinding examples: - c660f81dd250c description: External Micello wayfinding integration settings for this map 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 virtual_chassis_config_member: title: virtual_chassis_config_member required: - mac - vc_role type: object properties: locating: type: boolean description: Whether this Virtual Chassis member is currently in locate mode readOnly: true mac: type: string description: Member MAC address; for FPC0 this matches the device MAC address member_id: type: integer description: Member ID used for a pre-provisioned Virtual Chassis contentEncoding: int32 vc_ports: uniqueItems: true type: array items: type: string description: Port names to use as Virtual Chassis ports on this member vc_role: allOf: - $ref: '#/components/schemas/virtual_chassis_config_member_vc_role2' - description: 'Role of this member in the Virtual Chassis. enum: `backup`, `linecard`, `master`.' description: Virtual Chassis member configuration 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 virtual_chassis_update_op2: title: virtual_chassis_update_op2 enum: - add - preprovision - remove - renumber type: string description: 'Action to perform on the Virtual Chassis. enum: `add`, `preprovision`, `remove`, `renumber`.' map_import_json_vendor_name2: title: map_import_json_vendor_name2 enum: - ekahau - ibwave type: string description: 'Map import vendor for the uploaded JSON. enum: `ekahau`, `ibwave`.' examples: - ekahau installer_provision_device: title: installer_provision_device required: - name type: object properties: deviceprofile_name: type: string description: Profile name applied to the device during installer provisioning examples: - SJ1 for_site: type: boolean description: Whether this installer provisioning request is scoped to a site readOnly: true height: type: number description: Mounting height recorded for map placement examples: - 2.7 map_id: type: string description: Identifier of the map where the device should be placed contentEncoding: uuid examples: - 845a23bf-bed9-e43c-4c86-6fa474be7ae5 name: type: string description: Device name to set during installer provisioning examples: - SJ1-AP1 orientation: type: integer description: Device orientation in degrees from 0 to 359, where 0 is up and 90 is right contentEncoding: int32 examples: - 90 replacing_mac: type: string description: Only if replacing an existing device; MAC address of the device being replaced examples: - 5c5b3500003 role: type: string description: Optional role for switch / gateway site_id: type: string description: Identifier of the destination site for installer provisioning contentEncoding: uuid examples: - 72771e6a-6f5e-4de4-a5b9-1266c4197811 site_name: type: string description: Destination site name for installer provisioning examples: - SJ1 x: type: number description: Horizontal map position for the device, in pixels examples: - 150 y: type: number description: Vertical map position for the device, in pixels examples: - 300 description: Installer payload for provisioning or replacing a device 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