Recipes
Recipes are runnable examples of common jobs. Each one combines several steps, and often several endpoints, into a single script.
Getting Started
Authenticate
Exchange the client credentials for an access token.
POST /v1/auth/:org
Monitoring
Retrieve Offline Devices
Retrieve every device whose status is offline, paging through the full result set.
GET /v1/devices
Inventory
Onboard Discovered Devices
Onboard the discovered devices that are ready to onboard, and track the task to completion.
GET /v1/discoveredDevicesPOST /v1/tasks
Automation
Restart Devices
Restart the devices that support the task, and confirm they return online.
GET /v1/devicesPOST /v1/tasks
Automation
Rotate Device Passwords
Rotate the passwords on the devices that support the task, and track the task to completion.
GET /v1/devicesPOST /v1/tasks
Automation
Rotate SSL Certificates
Rotate the SSL certificates on the devices that support the task, and track the task to completion.
GET /v1/devicesPOST /v1/tasks
Automation
Upgrade Firmware
Upgrade the devices that have an approved firmware path, and track the task to completion.
GET /v1/devicesGET /v1/devices/:id/targetFirmwarePOST /v1/tasks