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

eUICC Device Endpoints

Method	HTTP Request	Description
POST	/devices/profile/actions/activate_enable	Activate Enable a device for a profile
POST	/devices/profile/actions/activate	Activate a device for a profile
POST	/devices/profile/actions/deactivate	Deactivate a device for a profile
POST	/devices/profile/actions/setfallbackattribute	Set the fallback attribute for a device
POST	/v2/devices/actions/list	Retrieve the Global Device List
POST	/v2/devices/history/actions/list	Retrieve Device Provisioning History
GET	/v2/accounts/{accountname}/requests/{requestID}/status	Get the Status of an Asynchronous Request

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
GET	/devices/requests/status	Check the status of an activation order and lists where the order is in the provisioning process.
PUT	/devices/actions/move	Moves active devices from one billing account to another within a customer profile.
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/diagnostics/actions/list	Returns basic diagnostic information about a specified device, including connectivity, provisioning, and billing status.
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 aggregate 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/{accountname}/name/{gname}	Delete a device group

Service Plans

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

Segmentation

Method	HTTP Request	Description
POST	/devices/actions/usagesegmentationlabels	Associates your own usage segmentation label with a device.
DELETE	/devices/actions/usagesegmentationlabels	Removes the label associated with a device.
POST	/devices/usage/actions/billedusage	Gets billing usage for a customer segment for a specified billing cycle, or the most recent billing cycle if one is not specified.
POST	/devices/usage/actions/billedusage/list	Gets billed usage for for either multiple devices or an entire billing account.
POST	/devices/sms/history/actions/list	Returns the history of mobile-originated/mobile-terminated SMS messages for a single device that were sent or received via ThingSpace, within a specified time period.

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
POST	triggers	Creates a new trigger that sends an alert callback based on specified device usage.

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

Send Non-IP Data (NIDD)

Method	HTTP Request	Description
POST	/devices/nidd/message	Send NIDD to NB-IoT device NOTE: From NB-IoT device to an application via callback