Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsJSI

searchOrgJsiAssetsAndContracts

GET
/api/v1/orgs/{org_id}/jsi/inventory/search

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.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Query Parameters

claimed?boolean

Device claim status, true for claimed devices, false for all devices. Accepts multiple comma-separated boolean values.

model?string

Filter results by device model. Accepts multiple comma-separated values.

serial?string

Filter results by device serial number. Accepts multiple comma-separated values.

sku?string

Filter results by SKU. Accepts multiple comma-separated values.

status?string

Device status. enum: all, connected, disconnected

Default"all"

Value in

  • "all"
  • "connected"
  • "disconnected"
warranty_type?string

Device warranty type used to filter Juniper Support Insight inventory

end_of_sale_after?string

Filter devices with End Of Sale date after this date

end_of_sale_before?string

Filter devices with End Of Sale date before this date

eos_after?string

Filter devices with End Of Support date after this date

eos_before?string

Filter devices with End Of Support date before this date

version_eos_after?string

Filter devices with OS Version End Of Support date after this date

version_eos_before?string

Filter devices with OS Version End Of Support date before this date

contract_end_before?string

Filter results by service contract end date before this date

contract_end_after?string

Filter results by service contract end date after this date

contract_type?string

Filter results by contract type

contract_sku?string

Filter results by contract SKU

end_of_service_time?string

Filter results by end of service time

support_contract_status?string

Filter results by service contract status

Value in

  • "Active"
  • "Declined"
  • "EOL"
  • "Service Available"
has_support?boolean

Indicates if the device is covered under active support contract. Accepts multiple comma-separated boolean values.

sirt_id?string

To get the onboarded devices that are affected by the SIRT ID

pbn_id?string

To get the onboarded devices that are affected by the PBN ID

text?string

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

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
sort?string

On which field the list should be sorted, -prefix represents DESC order

Default"timestamp"
search_after?string

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.

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/jsi/inventory/search"
{  "end": 1748023308,  "limit": 1000,  "results": [    {      "availability": "Yes",      "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": "No",      "service_eligible": "Yes",      "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}

listOrgJsiPastPurchases GET

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.

searchOrgJsiPbn GET

Text search for PBN (Problem Bug Notification) advisories. Search can be done on versions, models, customer_risk, id, and bug_type fields.