Quick API Reference

Quick Reference for the 5G BI API Endpoints

Task	HTTP Request
Device Attributes	POST /m2m/v1/devices/actions/list
Activating a 5G Business Internet Device	POST /m2m/v1/devices/actions/activate
Change a 5G Business Internet Service Plan	PUT /m2m/v1/devices/actions/plan

The 5G BI service builds on the existing Connectivity Management API endpoints. Useful endpoints are listed here and in the sections below:

Task	HTTP Request
Start a Connectivity Management session	POST /m2m/v1/session/login
End a Connectivity Management session	POST /m2m/v1/session/logout
Get a new Connectivity Management API password	PUT /m2m/v1/session/password/actions/reset

Task	HTTP Request
Domestic 4G and 5G Fixed Wireless qualification	POST /m2m/v1/intelligence/wireless-coverage
Go to state for a device	PUT /m2m/v1/devices/actions/goToState
Change device contact information	PUT /m2m/v1/devices/actions/contactInfo
Change device cost center	PUT /m2m/v1/devices/costCenter
Suspend service for devices	POST /m2m/v1/devices/actions/suspend
Restore service for suspended devices	POST /m2m/v1/devices/actions/restore
Deactivate service for devices	POST /m2m/v1/devices/actions/deactivate
Check the status of an activation order and where the order is in the provisioning process	GET /m2m/v1/devices/requests/status
Check whether devices are available to be activated	POST /m2m/v1/devices/availability/actions/list
Add devices without activating service	POST /m2m/v1/devices/actions/add
Delete deactivated devices	POST /m2m/v1/devices/actions/delete
Get detailed information about devices	POST /m2m/v1/devices/actions/list
Get service suspension status for devices	POST /m2m/v1/devices/suspension/status
Change device identifiers to match hardware changes	PUT /m2m/v1/devices/{serviceType}/actions/deviceId
Change custom field values for devices	PUT /m2m/v1/devices/actions/customFields
Changes or removes the `CostCenterCode` value for devices	PUT /m2m/v1/devices/costCenter
Get the current processing status of an asynchronous request	GET /m2m/v2/accounts/{accountName}/requests/{requestID}/status

Task	HTTP Request
Retrieve device usage history	POST /m2m/v1/devices/usage/actions/list
Retrieve aggregate device usage history	POST /m2m/v1/devices/usage/actions/list/aggregate
Retrieve device provisioning history	POST /m2m/v1/devices/history/actions/list
Retrieve device connection history	POST /m2m/v1/devices/connections/actions/listHistory

Task	HTTP Request
Create a Device Group	POST /m2m/v1/groups
Update a Device Group	PUT /m2m/v1/groups/{accountName}/name/{groupName}
Get a List of Device Groups for an Account	GET /m2m/v1/groups/{accountName}
Get Information about a Device Group	GET /m2m/v1/groups/{accountName}/name/{groupName}
Delete a Device Group	DELETE /m2m/v1/groups/{accountName}/name/{groupName}

Task	HTTP Request
Get a list of service plans in an account	GET /m2m/v1/plans/{accountName}

For more information about callbacks, please visit About Callback Services and Callback Best Practices.

Task	HTTP Request
Create a new trigger that sends an alert callback based on specified device usage	POST /m2m/v1/trigger
Register a callback listener URL	POST /m2m/v1/callbacks
Get a list of registered callback listener URLs	GET /m2m/v1/callbacks
Delete a callback listener URL	DELETE /m2m/v1/callbacks

Task	HTTP Request
Get information about an account	GET /m2m/v1/accounts/{accountName}
Get a list of leads in an account	GET /m2m/v1/leads/{accountName}
Retrieve a list of registered device SKUs	POST /m2m/v1/accounts/{accountName}/sku

More information at Device Reachability.

Task	HTTP Request
Monitor device reachability	POST /m2m/v1/diagnostics/basic/devicereachability
Stop device reachability monitoring	DELETE /m2m/v1/diagnostics/basic/devicereachability
Retrieve active reachability monitoring	POST /m2m/v1/diagnostics/basic/devicereachability/monitors
Retrieve reachability status	POST /m2m/v1/diagnostics/basic/devicereachability/status