Connection Management APIs
The Connection Management APIs allow operational updates to be executed against subscriptions managed within the IoT.live platform.
These APIs support:
- Connection status changes
- Rate plan updates
- Communication plan updates
- Attribute management
- Bulk operational changes
- Asynchronous campaign workflows
[IMAGE PLACEHOLDER: Connection management architecture]
Connection management overview
The platform provides several APIs for operational connection management.
Core management APIs include:
API | Purpose |
|---|---|
editConnectionsStatus | Update connection operational status |
editConnectionsRatePlan | Change assigned rate plans |
editConnectionsAttribute | Update connection attributes |
editConnectionsCommPlan | Update communication plans |
editConnections | General connection updates |
editConnectionsAsync | Execute asynchronous bulk updates |
These APIs are typically used for:
- Operational lifecycle management
- Billing optimisation
- Service suspension workflows
- Bulk operational campaigns
- Customer provisioning
editConnectionsStatus API
The editConnectionsStatus API updates the operational status of one or more connections.
Typical status workflows include:
- Suspend subscriptions
- Resume subscriptions
- Activate subscriptions
- Operational state transitions
[IMAGE PLACEHOLDER: Connection status workflow]
Example status update request
Status updates may immediately affect live connectivity services.
editConnectionsRatePlan API
The editConnectionsRatePlan API updates the assigned rate plan for one or more subscriptions.
Typical use cases include:
- Billing optimisation
- Operational migrations
- Pool management
- Customer plan upgrades
[IMAGE PLACEHOLDER: Rate plan update workflow]
Example rate plan update request
editConnectionsAttribute API
The editConnectionsAttribute API updates operational or custom attributes associated with subscriptions.
Typical attribute use cases include:
- Operational metadata
- Device categorisation
- Internal workflow management
- Deployment tracking
Examples may include:
- Firmware version
- Region
- Customer reference
- Deployment state
[IMAGE PLACEHOLDER: Connection attribute management]
Example attribute update request
editConnectionsCommPlan API
The editConnectionsCommPlan API updates communication plans associated with subscriptions.
Communication plan operations may depend on:
- Provider support
- Subscription type
- Account permissions
- Operational eligibility
[IMAGE PLACEHOLDER: Communication plan workflow]
Bulk operational updates
Most management APIs support bulk operational workflows.
Bulk updates may target:
- Multiple ICCIDs
- Filtered connection groups
- Campaign-based operations
- Imported datasets
Bulk workflows are commonly used for:
- Large operational migrations
- Billing changes
- Customer onboarding
- Lifecycle management
Asynchronous operations
The editConnectionsAsync API supports asynchronous processing for large-scale updates.
Async workflows are commonly used when:
- Processing large datasets
- Executing provider-side campaigns
- Performing long-running updates
- Executing high-volume operational changes
Async operations may return:
- Pending
- Partially_Successful
- Success
- Failed
[IMAGE PLACEHOLDER: Async campaign processing]
Example async update request
Common operational responses
Operational APIs commonly return:
Result | Description |
|---|---|
Success | Operation completed successfully |
Pending | Async operation queued |
Partially_Successful | Some records succeeded while others failed |
Failed | Operation failed |
Not_Allowed | Insufficient permissions |
Rejected | Request rejected |
Operational safety recommendations
Before executing production updates:
- Validate target subscriptions carefully
- Test workflows on smaller device groups
- Export operational snapshots
- Review provider compatibility
- Monitor async campaign progress
Bulk operational changes may immediately affect billing, connectivity, or live customer services.
Monitoring operational changes
Operational updates should be monitored using:
- Async campaign status APIs
- Audit APIs
- Export APIs
- Operational reporting workflows
Recommended monitoring includes:
- Failed records
- Provider validation issues
- Partial successes
- Synchronisation delays
[IMAGE PLACEHOLDER: Operational monitoring dashboard]