Tagging APIs
The IoT.live Tagging APIs provide mechanisms for associating subscriptions with:
- Customers
- Operational groups
- Metadata
- Deployment identifiers
- Generic operational tags
The platform supports both:
- Customer association tagging
- Generic connection tagging
These APIs enable large-scale operational organisation and segmentation across enterprise IoT deployments.
[IMAGE PLACEHOLDER: Tagging API architecture]
Tagging API overview
The IoT.live platform supports three primary tagging approaches:
- CSV upload workflows
- UI-driven tagging
- REST API tagging
The Tagging APIs are designed for:
- Operational automation
- Enterprise inventory segmentation
- Customer ownership mapping
- Metadata association
- Deployment management
The API documentation specifically references tagging use cases such as:
- Firmware versions
- Serial numbers
- Edge software configuration
- Customer identity association
[IMAGE PLACEHOLDER: Tagging workflow overview]
Customer association tagging
Customer association tagging allows subscriptions to be linked to customer identities or organisational groupings.
Typical use cases include:
- Customer ownership mapping
- Reseller segmentation
- Multi-tenant inventory management
- Customer-specific reporting
Primary APIs include:
- updateConnectionCustomerAssoc
- updateConnectionCustomerAssocAsync
- listConnectionCustomerAssoc
- listAvailableResellerCustomers
updateConnectionCustomerAssoc API
The updateConnectionCustomerAssoc API updates customer associations for one or more subscriptions.
Typical operational uses include:
- Customer onboarding
- Ownership transfers
- Deployment segmentation
- Inventory organisation
[IMAGE PLACEHOLDER: Customer association workflow]
Example customer association request
Generic tagging APIs
Generic tagging APIs allow arbitrary metadata tags to be associated with subscriptions.
These tags can support:
- Device categorisation
- Operational grouping
- Firmware tracking
- Deployment segmentation
- Workflow management
Primary APIs include:
- updateTagsConnectionsAssoc
- listTagsConnectionsAssoc
- addTag
- deleteTag
- listAvailableTags
[IMAGE PLACEHOLDER: Generic tagging workflow]
Example generic tagging request
Adding and removing tags
The platform supports lifecycle management for tags themselves.
Example APIs include:
- addTag
- deleteTag
These APIs can be used to:
- Create operational tags
- Retire obsolete tags
- Standardise tagging structures
- Manage deployment metadata
Listing available tags
The listAvailableTags API retrieves configured tags available within the platform.
Typical use cases include:
- Synchronising operational metadata
- Building UI dropdowns
- Reporting integrations
- Inventory filtering
[IMAGE PLACEHOLDER: Available tags example]
Async tagging operations
Large tagging operations may be executed asynchronously using:
updateTagsConnectionsAssocAsync
Async tagging workflows are useful for:
- Large inventory updates
- Customer migrations
- Enterprise tagging campaigns
- High-volume operational updates
Async operations may return:
- Pending
- Success
- Partially_Successful
- Failed
Monitoring async tagging workflows
The API documentation references:
listAsyncOperationsStatus
This API can be used to:
- Track background tagging operations
- Monitor campaign progress
- Identify failed records
- Validate completion status
[IMAGE PLACEHOLDER: Async tagging monitoring]
Prefix tagging support
The documentation references an isPrefix field used within tagging workflows.
This can support:
- Prefix-based tag matching
- Hierarchical operational grouping
- Flexible inventory segmentation
Example operational structures may include:
- Region/UK
- Region/EU
- Customer/ACME
- Firmware/v2
Common tagging use cases
Typical integration scenarios include:
- Customer ownership mapping
- Firmware tracking
- Device lifecycle grouping
- Regional segmentation
- Deployment management
- Inventory filtering
- Operational reporting
Best practices
Recommended tagging practices include:
- Standardise tag naming conventions
- Avoid duplicate tag structures
- Separate customer tags from operational tags
- Use async workflows for large updates
- Monitor partial successes carefully
Consistent tagging structures significantly improve filtering, reporting, and operational automation workflows.
Security considerations
Tagging APIs may affect:
- Customer visibility
- Reporting structures
- Operational grouping
- Multi-tenant segmentation
Recommended controls include:
- Restricting tagging permissions
- Validating customer association updates
- Auditing tagging operations
- Monitoring async campaigns
Incorrect customer associations may impact reporting, billing segmentation, and operational visibility.