openapi: 3.2.0 info: title: Mist Orgs JSI API description: '> Version: **2607.1.1** > > Date: **August 17, 2026** NOTE: Some important API changes will be introduced.' contact: name: Thomas Munzer email: tmunzer@juniper.net version: 2607.1.1 servers: - url: https://api.mist.com variables: {} - url: https://api.gc1.mist.com variables: {} - url: https://api.ac2.mist.com variables: {} - url: https://api.gc2.mist.com variables: {} - url: https://api.gc4.mist.com variables: {} - url: https://api.eu.mist.com variables: {} - url: https://api.gc3.mist.com variables: {} - url: https://api.ac6.mist.com variables: {} - url: https://api.gc6.mist.com variables: {} - url: https://api.ac5.mist.com variables: {} - url: https://api.gc5.mist.com variables: {} - url: https://api.gc7.mist.com variables: {} security: - apiToken: [] - csrfToken: [] tags: - name: Orgs JSI description: 'Juniper Support Insight is a free service provided to all Mist customers. You can adopt your devices via a few lines CLI commands. Allowing you to * get some basic information about the adopted devices * web shell into device (write privilege required) \n* upgrade (write privilege required)' paths: /api/v1/orgs/{org_id}/jsi/devices: parameters: [] get: tags: - Orgs JSI summary: listOrgJsiDevices description: List organization devices connected to Juniper Support Insights (JSI), optionally filtered by model, serial number, or MAC address. operationId: listOrgJsiDevices parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - 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 - name: model in: query description: Filter results by device model style: form explode: true schema: type: string examples: - AP43 - name: serial in: query description: Filter results by device serial number style: form explode: true schema: type: string examples: - FXLH2015150025 - name: mac in: query description: Filter results by MAC address style: form explode: true schema: type: string examples: - 5c5b350e0001 responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/jse_device' description: JSE devices returned for an organization examples: - - ext_ip: 73.92.124.103 last_seen: 1654636867 mac: c15353123096 model: EX2300-C-12P serial: DGCOO0015 contentMediaType: application/json examples: Example: value: - ext_ip: 73.92.124.103 last_seen: 1654636867 mac: c15353123096 model: EX2300-C-12P serial: DGCOO0015 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/jse_device' description: JSE devices returned for an organization examples: - - ext_ip: 73.92.124.103 last_seen: 1654636867 mac: c15353123096 model: EX2300-C-12P serial: DGCOO0015 contentMediaType: application/vnd.api+json examples: Example: value: - ext_ip: 73.92.124.103 last_seen: 1654636867 mac: c15353123096 model: EX2300-C-12P serial: DGCOO0015 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/orgs/{org_id}/jsi/devices/outbound_ssh_cmd: parameters: [] get: tags: - Orgs JSI summary: adoptOrgJsiDevice description: Return the outbound SSH registration command used to onboard Junos devices to Juniper Support Insights (JSI). operationId: adoptOrgJsiDevice parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_device_config_cmd' - description: Device configuration command response examples: - cmd: 'set system services ssh... ... set system services outbound-ssh client mist ...' contentMediaType: application/json examples: Example: value: cmd: 'set system services ssh... ... set system services outbound-ssh client mist ...' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_device_config_cmd' - description: Device configuration command response examples: - cmd: 'set system services ssh... ... set system services outbound-ssh client mist ...' contentMediaType: application/vnd.api+json examples: Example: value: cmd: 'set system services ssh... ... set system services outbound-ssh client mist ...' '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/orgs/{org_id}/jsi/devices/{device_mac}/shell: parameters: [] post: tags: - Orgs JSI summary: createOrgJsiDeviceShellSession description: Create a WebSocket-backed shell session for a JSI-connected device identified by MAC address. operationId: createOrgJsiDeviceShellSession 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: application/json: schema: allOf: - $ref: '#/components/schemas/websocket_session_with_url' - description: Response containing a WebSocket session handle and connection URL contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/websocket_session_with_url' - description: Response containing a WebSocket session handle and connection URL 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/orgs/{org_id}/jsi/inventory: parameters: [] get: tags: - Orgs JSI summary: listOrgJsiPastPurchases description: 'This gets all devices purchased from the accounts associated with the Org * Fetch Install base devices for all linked accounts and associated account of the linked accounts. * The primary and the associated account ids will be queries from SFDC by passing the linked account * Returns only the device centric details of the Install base device. No customer specific information will be returned.' operationId: listOrgJsiPastPurchases parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - 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 - name: model in: query description: Filter results by one or more device models. Supports comma-separated values style: form explode: true schema: type: string examples: - AP43 - name: serial in: query description: Filter results by device serial number style: form explode: true schema: type: string examples: - FXLH2015150025 responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/js_inventory_item' description: JSI inventory items returned for an organization examples: - - device_name: name1 end_of_sale_time: 1561507200 eos_time: 1672012800 master: true model: EX2300-24MP org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a serial: XN3123300095 sku: EX2300 status: connected suggested_version: Latest 21.4R3-Sx type: switch version: 23.4R2-S4.11 version_eos_time: 1672012800 version_time: 1561507200 warranty: Enhanced Hardware Warranty warranty_time: 1672012800 warranty_type: Enhanced Hardware Warranty contentMediaType: application/json examples: Example: value: - device_name: name1 end_of_sale_time: 1561507200 eos_time: 1672012800 master: true model: EX2300-24MP org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a serial: XN3123300095 sku: EX2300 status: connected suggested_version: Latest 21.4R3-Sx type: switch version: 23.4R2-S4.11 version_eos_time: 1672012800 version_time: 1561507200 warranty: Enhanced Hardware Warranty warranty_time: 1672012800 warranty_type: Enhanced Hardware Warranty application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/js_inventory_item' description: JSI inventory items returned for an organization examples: - - device_name: name1 end_of_sale_time: 1561507200 eos_time: 1672012800 master: true model: EX2300-24MP org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a serial: XN3123300095 sku: EX2300 status: connected suggested_version: Latest 21.4R3-Sx type: switch version: 23.4R2-S4.11 version_eos_time: 1672012800 version_time: 1561507200 warranty: Enhanced Hardware Warranty warranty_time: 1672012800 warranty_type: Enhanced Hardware Warranty contentMediaType: application/vnd.api+json examples: Example: value: - device_name: name1 end_of_sale_time: 1561507200 eos_time: 1672012800 master: true model: EX2300-24MP org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a serial: XN3123300095 sku: EX2300 status: connected suggested_version: Latest 21.4R3-Sx type: switch version: 23.4R2-S4.11 version_eos_time: 1672012800 version_time: 1561507200 warranty: Enhanced Hardware Warranty warranty_time: 1672012800 warranty_type: Enhanced Hardware Warranty '400': description: Bad Request - no Juniper Account Linked headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_detail_string' - description: Response containing a human-readable detail message examples: - detail: no juniper account linked contentMediaType: application/json examples: No Juniper Account Linked: value: detail: no juniper account linked application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_detail_string' - description: Response containing a human-readable detail message examples: - detail: no juniper account linked contentMediaType: application/vnd.api+json examples: No Juniper Account Linked: value: detail: no juniper account linked '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/orgs/{org_id}/jsi/inventory/count: parameters: [] get: tags: - Orgs JSI summary: countOrgJsiAssetsAndContracts description: Count devices purchased from the accounts associated with the Org operationId: countOrgJsiAssetsAndContracts parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: distinct in: query description: 'Field used to group this count response. enum: `account_id`, `claimed`, `has_support`, `end_of_sale_time`, `eos_time`, `version_time`, `model`, `sku`, `status`, `type`, `version`, `warranty_type`' style: form explode: true schema: allOf: - $ref: '#/components/schemas/jsi_inventory_count_distinct' - description: 'Field used to group this count response. enum: `account_id`, `claimed`, `has_support`, `end_of_sale_time`, `eos_time`, `version_time`, `model`, `sku`, `status`, `type`, `version`, `warranty_type`' - 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 responses: '200': description: Result of Count headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_count' - description: Distinct count response for time-bounded search results examples: - distinct: string end: 0 limit: 0 results: - count: 0 property: string start: 0 total: 0 contentMediaType: application/json examples: Example: value: distinct: string end: 0 limit: 0 results: - count: 0 property: string start: 0 total: 0 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_count' - description: Distinct count response for time-bounded search results examples: - distinct: string end: 0 limit: 0 results: - count: 0 property: string start: 0 total: 0 contentMediaType: application/vnd.api+json examples: Example: value: distinct: string end: 0 limit: 0 results: - count: 0 property: string start: 0 total: 0 '400': description: Bad Request - no Juniper Account Linked headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_detail_string' - description: Response containing a human-readable detail message examples: - detail: no juniper account linked contentMediaType: application/json examples: No Juniper Account Linked: value: detail: no juniper account linked application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_detail_string' - description: Response containing a human-readable detail message examples: - detail: no juniper account linked contentMediaType: application/vnd.api+json examples: No Juniper Account Linked: value: detail: no juniper account linked '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/orgs/{org_id}/jsi/inventory/search: parameters: [] get: tags: - Orgs JSI summary: searchOrgJsiAssetsAndContracts description: 'This gets all devices purchased from the accounts associated with the Org * Fetch Install base devices for all linked accounts and associated account of the linked accounts. * The primary and the associated account ids will be queries from SFDC by passing the linked account * Returns only the device centric details of the Install base device. No customer specific information will be returned.' operationId: searchOrgJsiAssetsAndContracts parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: claimed in: query description: Device claim status, `true` for claimed devices, `false` for all devices. Accepts multiple comma-separated boolean values. style: form explode: true schema: type: boolean examples: - 'true' examples: Untitled Example2: value: true - name: model in: query description: Filter results by device model. Accepts multiple comma-separated values. style: form explode: true schema: type: string examples: - QFX10000-36Q,QFX10000-30C - AP43 examples: Untitled Example1: value: QFX10000-36Q,QFX10000-30C Untitled Example2: value: AP43 - name: serial in: query description: Filter results by device serial number. Accepts multiple comma-separated values. style: form explode: true schema: type: string examples: - ACNP4666,ACNP6969 - FXLH2015150025 examples: Untitled Example1: value: ACNP4666,ACNP6969 Untitled Example2: value: FXLH2015150025 - name: sku in: query description: Filter results by SKU. Accepts multiple comma-separated values. style: form explode: true schema: type: string examples: - QFX10000-36Q,QFX10000-30C - EX2300 examples: Untitled Example1: value: QFX10000-36Q,QFX10000-30C Untitled Example2: value: EX2300 - name: status in: query description: 'Device status. enum: `all`, `connected`, `disconnected`' style: form explode: true schema: allOf: - $ref: '#/components/schemas/device_status' - description: 'Device status. enum: `all`, `connected`, `disconnected`' - name: warranty_type in: query description: Device warranty type used to filter Juniper Support Insight inventory style: form explode: true schema: type: string - name: end_of_sale_after in: query description: Filter devices with End Of Sale date after this date style: form explode: true schema: type: string examples: - 2024-01-01 - name: end_of_sale_before in: query description: Filter devices with End Of Sale date before this date style: form explode: true schema: type: string examples: - 2025-12-31 - name: eos_after in: query description: Filter devices with End Of Support date after this date style: form explode: true schema: type: string examples: - 2024-01-01 - name: eos_before in: query description: Filter devices with End Of Support date before this date style: form explode: true schema: type: string examples: - 2025-12-31 - name: version_eos_after in: query description: Filter devices with OS Version End Of Support date after this date style: form explode: true schema: type: string examples: - 2024-01-01 - name: version_eos_before in: query description: Filter devices with OS Version End Of Support date before this date style: form explode: true schema: type: string examples: - 2025-12-31 - name: contract_end_before in: query description: Filter results by service contract end date before this date style: form explode: true schema: type: string examples: - 2025-12-31 - name: contract_end_after in: query description: Filter results by service contract end date after this date style: form explode: true schema: type: string examples: - 2024-01-01 - name: contract_type in: query description: Filter results by contract type style: form explode: true schema: type: string - name: contract_sku in: query description: Filter results by contract SKU style: form explode: true schema: type: string - name: end_of_service_time in: query description: Filter results by end of service time style: form explode: true schema: type: string - name: support_contract_status in: query description: Filter results by service contract status style: form explode: true schema: allOf: - $ref: '#/components/schemas/support_contract_status' - description: Filter results by service contract status - name: has_support in: query description: Indicates if the device is covered under active support contract. Accepts multiple comma-separated boolean values. style: form explode: true schema: type: boolean examples: - 'true' examples: Untitled Example2: value: true - name: sirt_id in: query description: To get the onboarded devices that are affected by the SIRT ID style: form explode: true schema: type: string examples: - JSA12345 - name: pbn_id in: query description: To get the onboarded devices that are affected by the PBN ID style: form explode: true schema: type: string examples: - PBN67890 - name: text in: query description: Wildcard text search across `account_id`, `contract_id`, `contract_reseller`, `contract_sku`, `device_name`, `distributor`, `ia_address`, `ia_country`, `ia_region`, `ia_zip_postal`, `model`, `serial`, `sku`, `status`, `suggested_version`, `version`, `warranty` style: form explode: true schema: type: string - 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: sort in: query description: On which field the list should be sorted, -prefix represents DESC order style: form explode: true schema: type: string default: timestamp examples: - -site_id - name: search_after in: query description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed. style: form explode: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/js_inventory_search' - description: Paginated JSI inventory search response examples: - end: 1748023308 limit: 1000 results: - availability: true claimed: true contract_end_date: 2028-10-01 contract_id: 324343-234 contract_reseller: Reseller1 contract_sku: EX2300-24MP-AFO contract_start_date: 2022-09-01 contract_type: Maintenance current_contract_flag: No Contract device_name: name1 distributor: Dist end_of_sale_time: 1561507200 end_of_service_time: 1661507200 eol_psn: TSB18097 eos_time: 1672012800 has_support: true ia_address: Address1 ia_country: United States ia_region: Rhode Island ia_zip_postal: 02865-3749 master: true model: EX2300-24MP org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a serial: XN3123300095 service_contract_no: '16036705' service_contract_type: MS service_decline_flag: false service_eligible: true ship_date_calc: 2022-08-31 sku: EX2300 status: connected suggested_version: Latest 21.4R3-Sx support_contract_status: Active type: switch version: 23.4R2-S4.11 version_description: '' version_eos_time: 1672012800 version_time: 1561507200 warranty: Enhanced Hardware Warranty warranty_end: 2042-11-28 warranty_start: 2022-09-01 warranty_time: 1672012800 warranty_type: WTY00002 start: 1748019708 total: 1 contentMediaType: application/json examples: Example: value: end: 1748023308 limit: 1000 results: - availability: true claimed: true contract_end_date: 2028-10-01 contract_id: 324343-234 contract_reseller: Reseller1 contract_sku: EX2300-24MP-AFO contract_start_date: 2022-09-01 contract_type: Maintenance current_contract_flag: No Contract device_name: name1 distributor: Dist end_of_sale_time: 1561507200 end_of_service_time: 1661507200 eol_psn: TSB18097 eos_time: 1672012800 has_support: true ia_address: Address1 ia_country: United States ia_region: Rhode Island ia_zip_postal: 02865-3749 master: true model: EX2300-24MP org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a serial: XN3123300095 service_contract_no: '16036705' service_contract_type: MS service_decline_flag: false service_eligible: true ship_date_calc: 2022-08-31 sku: EX2300 status: connected suggested_version: Latest 21.4R3-Sx support_contract_status: Active type: switch version: 23.4R2-S4.11 version_description: '' version_eos_time: 1672012800 version_time: 1561507200 warranty: Enhanced Hardware Warranty warranty_end: 2042-11-28 warranty_start: 2022-09-01 warranty_time: 1672012800 warranty_type: WTY00002 start: 1748019708 total: 1 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/js_inventory_search' - description: Paginated JSI inventory search response examples: - end: 1748023308 limit: 1000 results: - availability: true claimed: true contract_end_date: 2028-10-01 contract_id: 324343-234 contract_reseller: Reseller1 contract_sku: EX2300-24MP-AFO contract_start_date: 2022-09-01 contract_type: Maintenance current_contract_flag: No Contract device_name: name1 distributor: Dist end_of_sale_time: 1561507200 end_of_service_time: 1661507200 eol_psn: TSB18097 eos_time: 1672012800 has_support: true ia_address: Address1 ia_country: United States ia_region: Rhode Island ia_zip_postal: 02865-3749 master: true model: EX2300-24MP org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a serial: XN3123300095 service_contract_no: '16036705' service_contract_type: MS service_decline_flag: false service_eligible: true ship_date_calc: 2022-08-31 sku: EX2300 status: connected suggested_version: Latest 21.4R3-Sx support_contract_status: Active type: switch version: 23.4R2-S4.11 version_description: '' version_eos_time: 1672012800 version_time: 1561507200 warranty: Enhanced Hardware Warranty warranty_end: 2042-11-28 warranty_start: 2022-09-01 warranty_time: 1672012800 warranty_type: WTY00002 start: 1748019708 total: 1 contentMediaType: application/vnd.api+json examples: Example: value: end: 1748023308 limit: 1000 results: - availability: true claimed: true contract_end_date: 2028-10-01 contract_id: 324343-234 contract_reseller: Reseller1 contract_sku: EX2300-24MP-AFO contract_start_date: 2022-09-01 contract_type: Maintenance current_contract_flag: No Contract device_name: name1 distributor: Dist end_of_sale_time: 1561507200 end_of_service_time: 1661507200 eol_psn: TSB18097 eos_time: 1672012800 has_support: true ia_address: Address1 ia_country: United States ia_region: Rhode Island ia_zip_postal: 02865-3749 master: true model: EX2300-24MP org_id: 6e843b41-f953-4af9-80e5-e1a70f65754a serial: XN3123300095 service_contract_no: '16036705' service_contract_type: MS service_decline_flag: false service_eligible: true ship_date_calc: 2022-08-31 sku: EX2300 status: connected suggested_version: Latest 21.4R3-Sx support_contract_status: Active type: switch version: 23.4R2-S4.11 version_description: '' version_eos_time: 1672012800 version_time: 1561507200 warranty: Enhanced Hardware Warranty warranty_end: 2042-11-28 warranty_start: 2022-09-01 warranty_time: 1672012800 warranty_type: WTY00002 start: 1748019708 total: 1 '400': description: Bad Request - no Juniper Account Linked headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_detail_string' - description: Response containing a human-readable detail message examples: - detail: no juniper account linked contentMediaType: application/json examples: No Juniper Account Linked: value: detail: no juniper account linked application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_detail_string' - description: Response containing a human-readable detail message examples: - detail: no juniper account linked contentMediaType: application/vnd.api+json examples: No Juniper Account Linked: value: detail: no juniper account linked '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/orgs/{org_id}/jsi/pbn/count: parameters: [] get: tags: - Orgs JSI summary: countOrgJsiPbn description: Get count of PBN advisories grouped by specified field operationId: countOrgJsiPbn parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: distinct in: query description: 'Field to group by enum: `versions`, `models`, `customer_risk`, `bug_type`' required: true style: form explode: true schema: allOf: - $ref: '#/components/schemas/count_pbn_distinct' - description: 'Field to group by enum: `versions`, `models`, `customer_risk`, `bug_type`' examples: - versions - 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: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_count' - description: Distinct count response for time-bounded search results contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_count' - description: Distinct count response for time-bounded search results 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/orgs/{org_id}/jsi/pbn/search: parameters: [] get: tags: - Orgs JSI summary: searchOrgJsiPbn description: Text search for PBN (Problem Bug Notification) advisories. Search can be done on versions, models, customer_risk, id, and bug_type fields. operationId: searchOrgJsiPbn parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: versions in: query description: Software versions affected by the PBN style: form explode: true schema: type: string examples: - 20.4R3 - name: models in: query description: Models affected by the PBN style: form explode: true schema: type: string - name: customer_risk in: query description: 'Filter results by customer risk. enum: `Critical`, `Major`, `Minor`' style: form explode: true schema: type: string - name: id in: query description: ID of the PBN style: form explode: true schema: type: string examples: - '1403338' - name: bug_type in: query description: Filter results by bug type style: form explode: true schema: allOf: - $ref: '#/components/schemas/jsi_pbn_bug_type' - description: Filter results by bug type - name: text in: query description: Wildcard search across `versions`, `models`, `customer_risk`, `id`, `bug_type` style: form explode: true schema: type: string - 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 - name: sort in: query description: On which field the list should be sorted, -prefix represents DESC order style: form explode: true schema: type: string default: timestamp examples: - -site_id - name: search_after in: query description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed. style: form explode: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/jsi_pbn_search' - description: Juniper Security Intelligence PBN search response with result metadata examples: - end: 1753415677 limit: 1 next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/pbn/search?end=1753415677&limit=1&search_after=%5B%221403338%22%5D&start=1753412077 results: - bug_type: Day-1 customer_risk: Major id: '1403338' introduced_in: '' models: - MX10008 - vMX product_family: - EX2200 - QFX5210 release_notes: In aggregated interfaces and STP (Spanning Tree Protocol) scenario, the STP does not work. restoration: '' title: The STP does not work when aggregated interfaces number is "ae1000" versions: - 23.4R2-S1.1 workaround: Use the 'ae' number from 0 to 999 in QFX5000 and 0 to 479 in other QFXs / EX under STP. workaround_provided: true start: 1753412077 total: 604 contentMediaType: application/json examples: Example: value: end: 1753415677 limit: 1 next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/pbn/search?end=1753415677&limit=1&search_after=%5B%221403338%22%5D&start=1753412077 results: - bug_type: Day-1 customer_risk: Major id: '1403338' introduced_in: '' models: - MX10008 - vMX product_family: - EX2200 - QFX5210 release_notes: In aggregated interfaces and STP (Spanning Tree Protocol) scenario, the STP does not work. restoration: '' title: The STP does not work when aggregated interfaces number is "ae1000" versions: - 23.4R2-S1.1 workaround: Use the 'ae' number from 0 to 999 in QFX5000 and 0 to 479 in other QFXs / EX under STP. workaround_provided: true start: 1753412077 total: 604 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/jsi_pbn_search' - description: Juniper Security Intelligence PBN search response with result metadata examples: - end: 1753415677 limit: 1 next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/pbn/search?end=1753415677&limit=1&search_after=%5B%221403338%22%5D&start=1753412077 results: - bug_type: Day-1 customer_risk: Major id: '1403338' introduced_in: '' models: - MX10008 - vMX product_family: - EX2200 - QFX5210 release_notes: In aggregated interfaces and STP (Spanning Tree Protocol) scenario, the STP does not work. restoration: '' title: The STP does not work when aggregated interfaces number is "ae1000" versions: - 23.4R2-S1.1 workaround: Use the 'ae' number from 0 to 999 in QFX5000 and 0 to 479 in other QFXs / EX under STP. workaround_provided: true start: 1753412077 total: 604 contentMediaType: application/vnd.api+json examples: Example: value: end: 1753415677 limit: 1 next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/pbn/search?end=1753415677&limit=1&search_after=%5B%221403338%22%5D&start=1753412077 results: - bug_type: Day-1 customer_risk: Major id: '1403338' introduced_in: '' models: - MX10008 - vMX product_family: - EX2200 - QFX5210 release_notes: In aggregated interfaces and STP (Spanning Tree Protocol) scenario, the STP does not work. restoration: '' title: The STP does not work when aggregated interfaces number is "ae1000" versions: - 23.4R2-S1.1 workaround: Use the 'ae' number from 0 to 999 in QFX5000 and 0 to 479 in other QFXs / EX under STP. workaround_provided: true start: 1753412077 total: 604 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/orgs/{org_id}/jsi/sirt/count: parameters: [] get: tags: - Orgs JSI summary: countOrgJsiSirt description: Get count of SIRT advisories grouped by specified field operationId: countOrgJsiSirt parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: distinct in: query description: 'Field to group by. enum: `jsa_updated_date`, `models`, `severity`, `versions`' required: true style: form explode: true schema: allOf: - $ref: '#/components/schemas/count_sirt_distinct' - description: 'Field to group by. enum: `jsa_updated_date`, `models`, `severity`, `versions`' examples: - versions - 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: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_count' - description: Distinct count response for time-bounded search results contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_count' - description: Distinct count response for time-bounded search results 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/orgs/{org_id}/jsi/sirt/search: parameters: [] get: tags: - Orgs JSI summary: searchOrgJsiSirt description: Search and get all the SIRT for the onboarded devices. Search can be done on severity, id, updated_after, updated_before, published_after, published_before, models, versions, and text fields. operationId: searchOrgJsiSirt parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: severity in: query description: Filter results by SIRT severity style: form explode: true schema: allOf: - $ref: '#/components/schemas/jsi_sirt_severity' - description: Filter results by SIRT severity - name: id in: query description: JSA number style: form explode: true schema: type: string examples: - JSA100053 - name: updated_after in: query description: JSA Updated date to be filtered after this date style: form explode: true schema: type: string - name: updated_before in: query description: JSA Updated date to be filtered before this date style: form explode: true schema: type: string - name: published_after in: query description: JSA Published date to be filtered after this date style: form explode: true schema: type: string - name: published_before in: query description: JSA Published date to be filtered before this date style: form explode: true schema: type: string - name: models in: query description: Models affected by the SIRT style: form explode: true schema: type: string - name: versions in: query description: Software versions affected by the SIRT style: form explode: true schema: type: string examples: - 20.4R3 - name: text in: query description: Wildcard search across `versions`, `models`, `severity`, `id` style: form explode: true schema: type: string - 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 - name: sort in: query description: On which field the list should be sorted, -prefix represents DESC order style: form explode: true schema: type: string default: timestamp examples: - -site_id - name: search_after in: query description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed. style: form explode: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/jsi_sirt_search' - description: Juniper Security Intelligence SIRT search response with result metadata examples: - end: 1753411849 limit: 1 next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/sirt/search?end=1753411849&limit=1&search_after=%5B%22JSA100053%22%5D&start=1753408249 results: - cvss_score: 6.5 id: JSA100053 models: - MX10008 - vMX problem: 'An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd). ' published_date: 1752019200 release_notes: An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd). severity: Medium solution: 'false' title: 'Junos OS and Junos OS Evolved: In an EVPN environment, receipt of a specifically malformed BGP update causes RPD crash' updated_date: 1752019200 versions: - 23.4R2-S1.1 workaround: '' start: 1753408249 total: 14 contentMediaType: application/json examples: Example: value: end: 1753411849 limit: 1 next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/sirt/search?end=1753411849&limit=1&search_after=%5B%22JSA100053%22%5D&start=1753408249 results: - cvss_score: 6.5 id: JSA100053 models: - MX10008 - vMX problem: 'An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd). ' published_date: 1752019200 release_notes: An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd). severity: Medium solution: 'false' title: 'Junos OS and Junos OS Evolved: In an EVPN environment, receipt of a specifically malformed BGP update causes RPD crash' updated_date: 1752019200 versions: - 23.4R2-S1.1 workaround: '' start: 1753408249 total: 14 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/jsi_sirt_search' - description: Juniper Security Intelligence SIRT search response with result metadata examples: - end: 1753411849 limit: 1 next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/sirt/search?end=1753411849&limit=1&search_after=%5B%22JSA100053%22%5D&start=1753408249 results: - cvss_score: 6.5 id: JSA100053 models: - MX10008 - vMX problem: 'An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd). ' published_date: 1752019200 release_notes: An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd). severity: Medium solution: 'false' title: 'Junos OS and Junos OS Evolved: In an EVPN environment, receipt of a specifically malformed BGP update causes RPD crash' updated_date: 1752019200 versions: - 23.4R2-S1.1 workaround: '' start: 1753408249 total: 14 contentMediaType: application/vnd.api+json examples: Example: value: end: 1753411849 limit: 1 next: /api/v1/orgs/bf105f5e-2490-453b-9dc0-81224ca295cf/jsi/sirt/search?end=1753411849&limit=1&search_after=%5B%22JSA100053%22%5D&start=1753408249 results: - cvss_score: 6.5 id: JSA100053 models: - MX10008 - vMX problem: 'An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd). ' published_date: 1752019200 release_notes: An Improper Handling of Length Parameter Inconsistency vulnerability in the routing protocol daemon (rpd). severity: Medium solution: 'false' title: 'Junos OS and Junos OS Evolved: In an EVPN environment, receipt of a specifically malformed BGP update causes RPD crash' updated_date: 1752019200 versions: - 23.4R2-S1.1 workaround: '' start: 1753408249 total: 14 '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 js_inventory_search: title: js_inventory_search type: object properties: end: type: integer description: Offset to end at contentEncoding: int32 limit: type: integer description: Number of results to return contentEncoding: int32 next: type: string description: URL for the next page of JSI inventory results results: type: array items: $ref: '#/components/schemas/js_inventory_item' description: JSI inventory records returned by the search start: type: integer description: Offset to start from contentEncoding: int32 total: type: integer description: Number of JSI inventory records matching the search contentEncoding: int32 description: Paginated JSI inventory search response support_contract_status: title: support_contract_status enum: - Active - Declined - EOL - Service Available type: string description: 'Service contract status. enum: `Active`, `Declined`, `EOL`, `Service Available`' jse_device: title: jse_device type: object properties: ext_ip: type: string description: External IP address for the JSE device, when available last_seen: type: - number - 'null' description: Timestamp when the JSE device was last seen readOnly: true examples: - 1470417522 mac: type: string description: Device MAC address for the JSE device model: type: string description: Device model for the JSE device serial: type: string description: Device serial number for the JSE device description: JSE device reported for an organization count_pbn_distinct: title: count_pbn_distinct enum: - versions - models - customer_risk - bug_type type: string description: 'Fields that can be used to group PBN advisory count results. enum: `versions`, `models`, `customer_risk`, `bug_type`' examples: - versions 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 jsi_sirt_severity: title: jsi_sirt_severity enum: - Critical - High - Low - Medium type: string description: 'Security severity assigned to the SIRT advisory. enum: `Critical`, `High`, `Low`, `Medium`' jsi_sirt_item: title: jsi_sirt_item type: object properties: cvss_score: type: number description: Common Vulnerability Scoring System score for the SIRT advisory id: type: string description: Unique SIRT or JSA advisory identifier from Juniper Support Insights examples: - JSA100053 models: type: array items: type: string description: Device models affected by the SIRT advisory problem: type: string description: Issue details described by the SIRT advisory published_date: type: integer description: Release date of the SIRT issue contentEncoding: int32 release_notes: type: string description: Release notes if any severity: allOf: - $ref: '#/components/schemas/jsi_sirt_severity' - description: 'Security severity assigned to the SIRT advisory. enum: `Critical`, `High`, `Low`, `Medium`' solution: type: string description: Recommended fix or remediation for the security issue title: type: string description: Summary title for the SIRT advisory updated_date: type: integer description: Time when the JSA advisory was last updated contentEncoding: int32 versions: type: array items: type: string description: Software versions affected by the SIRT advisory workaround: type: string description: Mitigation or workaround guidance for the SIRT advisory description: Juniper Security Intelligence SIRT advisory item support_contract_status2: title: support_contract_status2 enum: - Active - Declined - EOL - Service Available type: string description: 'Service contract status; only returned for onboarded (claimed) devices. enum: `Active`, `Declined`, `EOL`, `Service Available`.' device_type2: title: device_type2 enum: - ap - gateway - switch type: string description: 'Device category for the inventory item. enum: `ap`, `gateway`, `switch`.' device_status: title: device_status enum: - all - connected - disconnected type: string description: 'enum: `all`, `connected`, `disconnected`' jsi_sirt_search: title: jsi_sirt_search type: object properties: end: type: integer description: Upper bound timestamp for the SIRT search window contentEncoding: int32 limit: type: integer description: Number of results to return contentEncoding: int32 next: type: string description: Pagination URL for the next page of SIRT advisories results: type: array items: $ref: '#/components/schemas/jsi_sirt_item' description: List of SIRT advisories start: type: integer description: Lower bound timestamp for the SIRT search window contentEncoding: int32 total: type: integer description: Count of SIRT advisories matching the search contentEncoding: int32 description: Juniper Security Intelligence SIRT search response with result metadata websocket_session_with_url: title: websocket_session_with_url required: - session - url type: object properties: session: type: string description: Identifier used to correlate output on the WebSocket stream examples: - 19e73828-937f-05e6-f709-e29efdb0a82b url: type: string description: WebSocket URL returned for connecting to this session examples: - wss://api-ws.mist.com/ssh?jwt=xxxx description: Response containing a WebSocket session handle and connection URL jsi_pbn_search: title: jsi_pbn_search type: object properties: end: type: integer description: Upper bound timestamp for the PBN search window contentEncoding: int32 limit: type: integer description: Number of results to return contentEncoding: int32 next: type: string description: Pagination URL for the next page of PBN advisories results: type: array items: $ref: '#/components/schemas/jsi_pbn_item' description: List of PBN advisories start: type: integer description: Lower bound timestamp for the PBN search window contentEncoding: int32 total: type: integer description: Count of PBN advisories matching the search contentEncoding: int32 description: Juniper Security Intelligence PBN search response with result metadata jsi_pbn_item: title: jsi_pbn_item type: object properties: bug_type: allOf: - $ref: '#/components/schemas/jsi_pbn_bug_type' - description: 'Type of the bug. enum: `Day-1`, `Regression`' customer_risk: type: string description: Customer impact risk level for the PBN advisory fixed_in: type: string description: Release in which the issue was fixed id: type: string description: Unique PBN advisory identifier from Juniper Support Insights examples: - '1403338' introduced_in: type: string description: Release where the PBN issue was introduced models: type: array items: type: string description: Device models affected by the PBN issue product_family: type: array items: type: string description: Product families affected by the PBN issue release_notes: type: string description: Release notes for this PBN restoration: type: string description: Steps recommended to restore service or recover from the PBN issue title: type: string description: Summary title for the PBN issue updated_date: type: integer description: Time when the PBN advisory was last updated contentEncoding: int32 versions: type: array items: type: string description: Software versions affected by the PBN issue workaround: type: string description: Mitigation or workaround guidance for the PBN issue workaround_provided: type: string description: Indicator of whether workaround guidance is available description: PBN (Problem Bug Notification) advisory item jsi_pbn_bug_type: title: jsi_pbn_bug_type enum: - Day-1 - Regression type: string description: 'Type of the bug. enum: `Day-1`, `Regression`' count_result: title: count_result required: - count type: object properties: count: type: integer description: Number of matching items for the distinct value or values in this result contentEncoding: int32 additionalProperties: type: string description: Count result row with the matching distinct field values response_device_config_cmd: title: response_device_config_cmd required: - cmd type: object properties: cmd: type: string description: Configuration command returned for the device description: Device configuration command response js_inventory_item: title: js_inventory_item type: object properties: availability: type: string description: Current operational availability status of the device; only returned for onboarded (claimed) devices claimed: type: boolean description: Indicates if the device is claimed by any org contract_end_date: type: string description: Expiration date of the service contract; only returned for onboarded (claimed) devices contract_id: type: string description: Unique identifier of the service contract; only returned for onboarded (claimed) devices contract_reseller: type: string description: Name of the reseller associated with the contract; only returned for onboarded (claimed) devices contract_sku: type: string description: SKU associated with the service contract; only returned for onboarded (claimed) devices contract_start_date: type: string description: Official commencement date of the service contract; only returned for onboarded (claimed) devices contract_type: type: string description: General classification of the contract; only returned for onboarded (claimed) devices current_contract_flag: type: string description: Current status of the contract (e.g., 'Active', 'Expired'); only returned for onboarded (claimed) devices device_name: type: string description: Name of the device distributor: type: string description: Name of the distributor who provided the device; only returned for onboarded (claimed) devices end_of_sale_time: type: integer description: End of sale epoch timestamp contentEncoding: int32 end_of_service_time: type: integer description: End of service epoch timestamp contentEncoding: int32 eol_psn: type: string description: Product support notice associated with the device end-of-life milestone examples: - TSB18097 eos_time: type: integer description: End of support time contentEncoding: int32 has_support: type: boolean description: Indicates if the device is covered under active support contract ia_address: type: string description: Physical installation street address of the asset; only returned for onboarded (claimed) devices ia_country: type: string description: Country of installation; only returned for onboarded (claimed) devices ia_region: type: string description: Geographic region where the device is installed; only returned for onboarded (claimed) devices ia_zip_postal: type: string description: ZIP or postal code of the installation site; only returned for onboarded (claimed) devices master: type: boolean description: Indicates whether it is Master model: type: string description: Hardware model recorded in the install base inventory org_id: type: string description: Organization identifier that has claimed the device, when applicable contentEncoding: uuid readOnly: true examples: - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61 serial: type: string description: Device serial number recorded in the install base inventory service_contract_no: type: string description: Unique identifier for the service contract; only returned for onboarded (claimed) devices service_contract_type: type: string description: Specific service level or contract category for the device; only returned for onboarded (claimed) devices service_decline_flag: type: string description: Indicates if the service offer was declined (e.g., 'Y'/'N'); only returned for onboarded (claimed) devices service_eligible: type: string description: Indicator of whether the device is eligible for service coverage ('Yes', 'No'); only returned for onboarded (claimed) devices ship_date_calc: type: string description: Calculated or actual date the device was shipped; only returned for onboarded (claimed) devices sku: type: string description: Serviceable SKU associated with the device status: type: string description: Current inventory status reported for the device suggested_version: type: string description: Recommended software version for the device support_contract_status: allOf: - $ref: '#/components/schemas/support_contract_status2' - description: 'Service contract status; only returned for onboarded (claimed) devices. enum: `Active`, `Declined`, `EOL`, `Service Available`.' type: allOf: - $ref: '#/components/schemas/device_type2' - description: 'Device category for the inventory item. enum: `ap`, `gateway`, `switch`.' version: type: string description: Software version currently running on the device version_description: type: string description: Release description associated with the reported software version version_eos_time: type: integer description: End of Service of version contentEncoding: int32 version_time: type: integer description: FRS date of the version contentEncoding: int32 warranty: type: string description: Coverage details associated with the device warranty warranty_end: type: string description: Expiration date of the warranty period; only returned for onboarded (claimed) devices warranty_start: type: string description: Start date of the manufacturer or secondary warranty; only returned for onboarded (claimed) devices warranty_time: type: integer description: Timestamp when warranty needs to be renewed contentEncoding: int32 warranty_type: type: string description: Warranty category reported for the device description: Juniper Support inventory item with entitlement, lifecycle, and software metadata 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_http404: title: response_http404 type: object properties: id: type: string description: Missing resource identifier, when the API includes one description: Standard HTTP 404 not found error response response_count: title: response_count required: - distinct - end - limit - results - start - total type: object properties: distinct: type: string description: Field used to group the count results end: type: integer description: Search window end timestamp for the count request, in epoch seconds contentEncoding: int32 limit: type: integer description: Maximum number of distinct count results requested contentEncoding: int32 results: uniqueItems: true type: array items: $ref: '#/components/schemas/count_result' description: Count results grouped by the distinct field start: type: integer description: Search window start timestamp for the count request, in epoch seconds contentEncoding: int32 total: type: integer description: Number of distinct result buckets returned contentEncoding: int32 description: Distinct count response for time-bounded search results 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 count_sirt_distinct: title: count_sirt_distinct enum: - versions - models - severity - jsa_updated_date type: string description: 'Fields that can be used to group SIRT advisory count results. enum: `versions`, `models`, `severity`, `jsa_updated_date`' examples: - versions jsi_inventory_count_distinct: title: jsi_inventory_count_distinct enum: - account_id - claimed - has_support - end_of_sale_time - eos_time - version_time - model - sku - status - type - version - warranty_type type: string description: 'Distinct field used when counting Juniper Support Insight inventory records. enum: `account_id`, `claimed`, `has_support`, `end_of_sale_time`, `eos_time`, `version_time`, `model`, `sku`, `status`, `type`, `version`, `warranty_type`' 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