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 POST /session/login Start a Connectivity Management session
post POST /session/logout End a Connectivity Management session
put PUT /session/password/actions/reset Get a new Connectivity Management API password

Device Service Provisioning and Management

Method HTTP Request Description
post POST /devices/actions/activate Activate service for devices
post POST /devices/actions/suspend Suspend service for devices
post POST /devices/actions/restore Restore service for suspended devices
post POST /devices/actions/deactivate Deactivate service for devices
put PUT /devices/actions/gotostate Set devices to a customer-defined service and state
post POST /devices/availability/actions/list Checks whether devices are available to be activated
post POST /devices/actions/add Add devices without activating service
post POST /devices/actions/delete Delete deactivated devices
post POST /devices/actions/list Get detailed information about devices
post POST /devices/suspension/status Get service suspension information about devices
put PUT /devices/{serviceType}/actions/deviceId Change device identifiers to match hardware changes
put PUT /devices/actions/customFields Change custom field values for devices
put PUT /devices/costCenter Changes or removes the CostCenterCode value for devices
put PUT /devices/actions/contactinfo Changes the name and address associated with devices
put PUT /devices/actions/plan Change device service plan
post POST /devices/prl/actions/list Get current PRL version from devices
post POST /devices/actions/list/imeiiccidmismatch Find 4G devices with an ICCID that is not paired with the expected IMEI
get GET /accounts/{aname}/requests/{requestID}/status Get the current processing status of an asynchronous request
get GET /accounts/{aname/statesandservices Get a list of customer-defined services and states

Connectivity and Service History

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

Device Groups

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

Service Plans

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

SMS

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

Callbacks

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

Accounts and Leads

Method HTTP Request Description
get GET /accounts Get information about an account
get GET /leads Get a list of leads in an account