API Reference

Quick API Reference

This API reference is organized by functional area, which generally equates to resource type.

Session Management

Method HTTP Request Description
POST /session/login Start a Connectivity Management session
POST /session/logout End a Connectivity Management session
PUT /session/password/actions/reset Get a new Connectivity Management API password

Device Service Provisioning and Management

Method HTTP Request Description
POST /devices/actions/activate Activate service for devices
POST /devices/actions/suspend Suspend service for devices
POST /devices/actions/restore Restore service for suspended devices
POST /devices/actions/deactivate Deactivate service for devices
PUT /devices/actions/gotostate Set devices to a customer-defined service and state
POST /devices/actions/upload Upload new device identifiers to the DMD
POST /devices/profile/actions/download_enable Download eUICC device profile
POST /devices/profile/actions/enable Enable eUICC device profile
POST /devices/profile/actions/disable Disable eUICC device profile
POST /devices/profile/actions/delete Delete eUICC device profile
POST /devices/actions/eidDeviceSwap EID Device Swap
POST /devices/availability/actions/list Checks whether devices are available to be activated
POST /devices/actions/add Add devices without activating service
POST /devices/actions/delete Delete deactivated devices
POST /devices/actions/list Get detailed information about devices
POST /devices/extendeddiagnostics/actions/list Get basic diagnostic information about a specified device
POST /devices/suspension/status Get service suspension information about devices
PUT /devices/{serviceType}/actions/deviceId Change device identifiers to match hardware changes
PUT /devices/actions/customFields Change custom field values for devices
PUT /devices/costCenter Changes or removes the CostCenterCode value for devices
PUT /devices/actions/contactinfo Changes the name and address associated with devices
PUT /devices/actions/plan Change device service plan
POST /devices/prl/actions/list Get current PRL version from devices
POST /devices/actions/list/imeiiccidmismatch Find 4G devices with an ICCID that is not paired with the expected IMEI
GET /accounts/{accountname}/requests/{requestID}/status Get the current processing status of an asynchronous request
GET /accounts/{accountname}/stateandservices Get a list of customer-defined services and states

Connectivity and Service History

Method HTTP Request Description
POST /devices/usage/actions/list Retrieve device usage history
POST /devices/usage/actions/list/aggregate Retrieve aggregated device usage history
POST /devices/history/actions/list Retrieve device provisioning history
POST /devices/connections/actions/listHistory Retrieve device connection history

Device Reachability Monitoring - Diagnostics

Method HTTP Request Description
POST /diagnostics/basic/devicereachability Monitor device reachability
DELETE /diagnostics/basic/devicereachability Stop device reachability monitoring
POST /diagnostics/basic/devicereachability/monitors Retrieve active reachability monitoring
POST /diagnostics/basic/devicereachability/status Retrieve reachability status

Device Groups

Method HTTP Request Description
POST /groups Create a device group
PUT /groups/{accountname}/name/{gname} Update a device group
GET /groups/{accountname} Get a list of device groups
GET /groups/{accountname}/name/{gname} Get information about a device group
DELETE /groups Delete a device group

Service Plans

Method HTTP Request Description
GET /plans/{accountname} Get a list of service plans in an account

SMS

Method HTTP Request Description
POST /sms Send an SMS message to devices
GET /sms/{accountname}/history Retrieve SMS messages sent by devices
PUT /sms/{accountname}/startCallbacks Start delivery of queued SMS messages

Callbacks

Method HTTP Request Description
POST /callbacks Register a callback listener URL
GET /callbacks Get a list of registered callback listener URLs
DELETE /callbacks Delete a callback listener URL

Accounts and Leads

Method HTTP Request Description
GET /accounts Get information about an account
GET /leads Get a list of leads in an account
POST /accounts/{accountname}/sku Retrieve list of registered device SKUs