{"openapi":"3.1.0","info":{"title":"Live Objects REST API Guide","description":"API description for Live Objects service","contact":{"name":"Live Objects Support","url":"https://liveobjects.orange-business.com/#/cms/support"},"version":"2026.7.0"},"externalDocs":{"description":"Live Objects Developer Guide","url":"https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html"},"servers":[{"url":"https://liveobjects.orange-business.com"}],"security":[{"X-API-KEY":[],"OAuth2.0":[]}],"tags":[{"name":"Accounting - V1","description":"get your accounting metrics"},{"name":"Alarm rules","description":"Manage your alarm rules"},{"name":"Api keys","description":"API key management"},{"name":"Api self keys","description":"API self key management"},{"name":"Audit Log","description":"Search through your AuditLog messages"},{"name":"Bootstrap Config","description":"Manage lwm2m bootstrap config"},{"name":"Bootstrap Entry","description":"Manage LwM2M bootstrap entries"},{"name":"Bootstrap Master Entry","description":"Manage LwM2M bootstrap master entries"},{"name":"CA certificates","description":"CA certificates for MQTT client cert. authentication"},{"name":"Campaign management","description":"Management of actions on a fleet of devices"},{"name":"Data bulk injection","description":"APIs to inject a bulk of data"},{"name":"Data management custom pipelines","description":"APIs to manage dataMessage custom pipelines"},{"name":"Data management data search","description":"APIs to search through injected data"},{"name":"Data management data store","description":"APIs to store and retrieve data"},{"name":"Decoders","description":"list all decoders for a tenant"},{"name":"Decoders - CSV","description":"CSV decoder provisioning"},{"name":"Decoders - binary","description":"binary decoder provisioning"},{"name":"Decoders - public","description":"public decoder management"},{"name":"Device Analytics","description":"Manage your device analytics rules"},{"name":"Device management - Commands","description":"Devices commands"},{"name":"Device management - Configuration","description":"Devices configuration"},{"name":"Device management - Connector nodes - LoRa specific","description":"LoRa connector specificity"},{"name":"Device management - Connector nodes - V1","description":"Connector nodes management"},{"name":"Device management - Groups - V1","description":"Group management"},{"name":"Device management - Interfaces","description":"Devices' interfaces management"},{"name":"Device management - Inventory - V1","description":"Devices inventory"},{"name":"Device management - Resources","description":"Devices resources and firmware"},{"name":"Device management - Resources management","description":"Resources management and firmware"},{"name":"Event processing - Activity","description":"ActivityRule management"},{"name":"Event processing - Context","description":"Context management"},{"name":"Event processing - Firing","description":"FiringRules and FiringGuards management"},{"name":"Event processing - Geozone","description":"Geozone management"},{"name":"Event processing - Matching","description":"MatchingRules management"},{"name":"Event processing - State processing","description":"State processing Rules management"},{"name":"Gateway management for LoRa","description":"Gateway management"},{"name":"Inventory Explorer","description":"Inventory explorer management"},{"name":"Notification","description":"sending email or sms notifications"},{"name":"Notification channels","description":"Manage notification channels"},{"name":"Self User management","description":"manage self user"},{"name":"Self tenant account","description":"Self tenant account management"},{"name":"Triggers and Actions","description":"Action policies on event and messages"},{"name":"Triggers and Actions - Test","description":"Test api for actions"},{"name":"Twin data rules management","description":"Manage twin data rules"},{"name":"Twin devices management","description":"Manage twin device"},{"name":"Twin models management","description":"Manage twin model"},{"name":"Twin observations","description":"Manage twin observations"},{"name":"Twin operations management","description":"Manage twin device operations"},{"name":"User Profile and Access Management","description":"manage user profile and get access list"},{"name":"User authentication","description":"authentication"},{"name":"User authentication management","description":"authentication management"},{"name":"Users management","description":"manage users"},{"name":"Beta - Cellular networks management","description":"Cellular subscriptions and providers management"},{"name":"Beta - Network metrics","description":"Search network metrics"},{"name":"Deprecated - Bus management","description":"FIFO are now automatically managed with FifoPublish Action in Trigger & Actions"},{"name":"Deprecated - Data management data search - V0","description":"use data search V1 instead"}],"paths":{"/api/v1/event2action/diagnostics/actionPolicies/{policyId}/actions/{actionId}/suspended":{"put":{"tags":["Triggers and Actions"],"summary":"Resume a suspended action","description":"Diagnostic of an ActionPolicy will indicate if the actions are suspended or not, and the reason why.

When the action leads to too many failures (for example Http Push with 5xx responses, FIFO never subbed...) the platform will automatically suspend the action.

Once suspended, you can use the resume API to re-enable the action. Please note that if the underlying issue is not fixed, the action will be suspended again.

Usage of this API will be reported in your access log under 'routing' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"updateActionSuspension","parameters":[{"name":"policyId","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"actionId","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"requestBody":{"content":{"application/json":{"schema":{"type":"boolean"},"examples":{"Request body":{"description":"Use 'false' in the request body to resume a suspended action.","value":false}}}},"required":true},"responses":{"204":{"description":"Action diagnostic successfully updated"},"404":{"description":"Unknown Action diagnostic "}}}},"/api/v1/event2action/actionPolicies/{policyId}":{"get":{"tags":["Triggers and Actions"],"summary":"Retrieve an ActionPolicy","description":"Triggers and Actions APIs allow you to create action policies that will automatically trigger actions (webhook, push to FIFO, SMS, email, push to an Azure Event Hub server) when specific events or datamessages ('triggers') are received by the platform.
These triggers and actions endpoints are related to the routing & alarming notification feature.
\r\nPlease see the dedicated sections in our developer guide for more details.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getActionPolicyV1","parameters":[{"name":"policyId","in":"path","description":"id of the ActionPolicy to retrieve","required":true,"schema":{"type":"string"}},{"name":"showSensitiveInformation","in":"query","description":"whether or not to show sensitive information, such as HttpPush headers, Azure secrets","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"ActionPolicy Successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionPolicy"}}}},"404":{"description":"Unknown ActionPolicy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionPolicy"}}}}}},"put":{"tags":["Triggers and Actions"],"summary":"Create or update an ActionPolicy","description":"Triggers and Actions APIs allow you to create action policies that will automatically trigger actions (webhook, push to FIFO, SMS, email, push to an Azure Event Hub server) when specific events or datamessages ('triggers') are received by the platform.
These triggers and actions endpoints are related to the routing & alarming notification feature.
\r\nPlease see the dedicated sections in our developer guide for more details.

Usage of this API will be reported in your access log under 'routing' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"updateActionPolicyV1","parameters":[{"name":"policyId","in":"path","description":"id of the ActionPolicy to save. Max length is 100.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionPolicy"},"examples":{"PUT with no actionIds":{"description":"This example will update an action policy with new actions (action ids not provided)","value":{"id":"000000-0000-0000-0000-00000000","name":"name-aea80c1d-5777-4e20-822c-5e6871f428e5","enabled":true,"triggers":{"deviceStatus":{"version":1,"filter":{"connectors":["mqtt"],"groupPaths":[{"path":"/lyon","includeSubPath":true}]}}},"actions":{"emails":[{"to":["notification@orange.com"],"cc":["cc@orange.com"],"cci":["cci@orange.com"],"subjectTemplate":"State change for {{stateKey}}","contentTemplate":"{{stateKey}} change from state {{previousState}} to state {{newState}} at {{timestamp}}"}],"sms":[{"destinationPhoneNumbers":["+33601234567"],"contentTemplate":"{{stateKey}} new state {{newState}} at {{timestamp}}"}]}}}}}},"required":true},"responses":{"200":{"description":"ActionPolicy created or updated"},"404":{"description":"Unknown ActionPolicy"}}},"delete":{"tags":["Triggers and Actions"],"summary":"Delete an ActionPolicy","description":"Triggers and Actions APIs allow you to create action policies that will automatically trigger actions (webhook, push to FIFO, SMS, email, push to an Azure Event Hub server) when specific events or datamessages ('triggers') are received by the platform.
These triggers and actions endpoints are related to the routing & alarming notification feature.
\r\nPlease see the dedicated sections in our developer guide for more details.

Usage of this API will be reported in your access log under 'routing' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteActionPolicyV1","parameters":[{"name":"policyId","in":"path","description":"id of the ActionPolicy to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"ActionPolicy Successfully deleted"},"404":{"description":"Unknown ActionPolicy"}}}},"/api/v1/event2action/actionPolicies/{policyId}/enabled":{"put":{"tags":["Triggers and Actions"],"summary":"Enable or Disable an ActionPolicy","description":"Triggers and Actions APIs allow you to create action policies that will automatically trigger actions (webhook, push to FIFO, SMS, email, push to an Azure Event Hub server) when specific events or datamessages ('triggers') are received by the platform.
These triggers and actions endpoints are related to the routing & alarming notification feature.
\r\nPlease see the dedicated sections in our developer guide for more details.You can use this API to re-enabled a suspended policy.

Usage of this API will be reported in your access log under 'routing' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"setEnabledField","parameters":[{"name":"policyId","in":"path","description":"id of the ActionPolicy to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"boolean","description":"Use 'true' to enable and 'false' to disable."}}},"required":true},"responses":{"200":{"description":"ActionPolicy 'enabled' field updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionPolicy"}}}},"404":{"description":"Unknown ActionPolicy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionPolicy"}}}}}}},"/api/v1/deviceMgt/groups/{groupId}":{"get":{"tags":["Device management - Groups - V1"],"summary":"Get a device group","description":"Managing groups of devices allows you to organize your devices in a hierarchical structure. Groups can be used to target specific subsets of devices when performing operations such as filtering triggers and actions rules, querying their data... Groups can be nested, allowing you to create a tree-like structure of groups and subgroups.

Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getGroup","parameters":[{"name":"groupId","in":"path","description":"the Group Identifier. Expected string (max 6 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"put":{"tags":["Device management - Groups - V1"],"summary":"Update a device group","description":"Managing groups of devices allows you to organize your devices in a hierarchical structure. Groups can be used to target specific subsets of devices when performing operations such as filtering triggers and actions rules, querying their data... Groups can be nested, allowing you to create a tree-like structure of groups and subgroups.

Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"updateGroup","parameters":[{"name":"groupId","in":"path","description":"identifier to update group. Expected string (max 6 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupUpdateRequest"}}},"required":true},"responses":{"200":{"description":"The group newly created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"Group already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"delete":{"tags":["Device management - Groups - V1"],"summary":"Delete a device group","description":"Managing groups of devices allows you to organize your devices in a hierarchical structure. Groups can be used to target specific subsets of devices when performing operations such as filtering triggers and actions rules, querying their data... Groups can be nested, allowing you to create a tree-like structure of groups and subgroups.

Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"deleteGroup","parameters":[{"name":"groupId","in":"path","description":"targeted for deletion group identifier. Expected string (max 6 characters)","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Group deleted"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/twin/operations/{operationId}/status":{"put":{"tags":["Twin operations management"],"summary":"Set twin operation status for a given deviceId and operationId","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"setTwinOperationStatus","parameters":[{"name":"deviceId","in":"path","description":"A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"operationId","in":"path","description":"Identifier of specific twin operation. Expected string (max 32 characters)","required":true,"schema":{"type":"string"}},{"name":"force","in":"query","description":"cancelling mode. When force is false, the DeviceTwin manager prevents operation with status not started from starting, cancel operation with status pending and let operation with status in progress finish properly. When force is true, the DeviceTwin manager aborts pending or in progress operation immediately.","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"future state of the operation --> CANCELED","enum":["CANCELED"]}}},"required":true},"responses":{"200":{"description":"Twin operation status has been set"},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}},"403":{"description":"Delete forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}},"404":{"description":"Operation not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}},"409":{"description":"Invalid operation status update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/config/parameters/{paramKey}/status":{"put":{"tags":["Device management - Configuration"],"summary":"Update the status of a specific device parameter","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"setDeviceParamUpdateStatusV1","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"paramKey","in":"path","description":"key identifying the targeted device parameter. Expected string (max 128 characters)","required":true,"schema":{"type":"string"}},{"name":"force","in":"query","description":"force the update of the parameter status","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"future state of the parameter --> CANCELED","enum":["CANCELED"]}}},"required":true},"responses":{"200":{"description":"Parameter status updated"},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown device parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/commands/{commandId}/status":{"get":{"tags":["Device management - Commands"],"summary":"Get the status of a specific command by its identifier. A command is an instruction sent to a device, telling it to perform a specific action, change a configuration parameter, or report information.","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getCommandStatusV1","parameters":[{"name":"commandId","in":"path","description":"identifier of specific command. Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The command status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommandStatusReport"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Command not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"put":{"tags":["Device management - Commands"],"summary":"Update the status of a specific command by its identifier. A command is an instruction sent to a device, telling it to perform a specific action, change a configuration parameter, or report information.","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"setCommandStatusV1","parameters":[{"name":"commandId","in":"path","description":"identifier of specific command. Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}},{"name":"force","in":"query","description":"force the update of the command status","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"future state of the command --> CANCELED","enum":["CANCELED"]}}},"required":true},"responses":{"200":{"description":"Command status updated"},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Command not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"Invalid command status update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/device-analytics/rules/{analyticsRuleId}":{"get":{"tags":["Device Analytics"],"summary":"Retrieve an AnalyticsRule.","description":"An AnalyticsRule defines a fleet of devices whose behavior will be analyzed by algorithms, generating a weekly report. This report includes general fleet behavior, detection of outliers, connectivity status...

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getAnalyticsRule","parameters":[{"name":"analyticsRuleId","in":"path","description":"id of the AnalyticsRule to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"AnalyticsRule successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsRule"}}}},"404":{"description":"Unknown AnalyticsRule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsRule"}}}}}},"put":{"tags":["Device Analytics"],"summary":"Update an AnalyticsRule.","description":"The field `id` must be provided and match the API path id.

Usage of this API will be reported in your access log under 'device_analytics' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"updateAnalyticsRule","parameters":[{"name":"analyticsRuleId","in":"path","description":"id of the AnalyticsRule to retrieve","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsRule"},"examples":{"Rule for a LoRa fleet with a filter on group":{"description":"Rule for a LoRa fleet with a filter on group","value":{"id":"1234567890","name":"Lora Fleet analytics","fleet":{"connectors":["lora"],"groupPaths":[{"path":"/france","includeSubPath":true}]},"report":{"recipients":{"to":["jane.doe@mycompany.com"],"cc":["john.doe@mycompany.com"]},"language":"fr"},"enabled":true}}}}},"required":true},"responses":{"200":{"description":"AnalyticsRule successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsRule"}}}},"404":{"description":"Unknown AnalyticsRule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsRule"}}}}}},"delete":{"tags":["Device Analytics"],"summary":"Delete an AnalyticsRule.","description":"Usage of this API will be reported in your access log under 'device_analytics' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteAnalyticsRule","parameters":[{"name":"analyticsRuleId","in":"path","description":"id of the AnalyticsRule to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"AnalyticsRule successfully deleted"},"404":{"description":"Unknown AnalyticsRule"}}}},"/api/v1/contact/notificationChannels/{notificationChannelId}":{"get":{"tags":["Notification channels"],"summary":"Get a notification channel.","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getNotificationChannel","parameters":[{"name":"notificationChannelId","in":"path","description":"notification channel identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The notification channel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationChannel"}}}}}},"put":{"tags":["Notification channels"],"summary":"Update a notification channel.","description":"Usage of this API will be reported in your access log under 'notification' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"updateNotificationChannel","parameters":[{"name":"notificationChannelId","in":"path","description":"notification channel identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationChannelRequest"}}},"required":true},"responses":{"200":{"description":"The notification channel was successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationChannel"}}}},"404":{"description":"The notification channel was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}},"delete":{"tags":["Notification channels"],"summary":"Delete a notification channel.","description":"Usage of this API will be reported in your access log under 'notification' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteNotificationChannel","parameters":[{"name":"notificationChannelId","in":"path","description":"notification channel identifier","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The notification channel was successfully deleted"},"404":{"description":"The notification channel was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}}},"/api/v1/bootstrap/lwm2m/masterEntries/{masterEntryId}/name":{"put":{"tags":["Bootstrap Master Entry"],"summary":"Set the name of a bootstrap master entry.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"setMasterEntryName","parameters":[{"name":"masterEntryId","in":"path","description":"the id of the master entry to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"},"examples":{"name":{"description":"name","value":"My Bootstrap Master Entry"}}}}},"responses":{"204":{"description":"No Content"}}}},"/api/v1/bootstrap/lwm2m/masterEntries/{masterEntryId}/definition/bootstrapConfigId":{"put":{"tags":["Bootstrap Master Entry"],"summary":"Set the bootstrapConfigId field of a bootstrap master entry.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"setMasterEntryBootstrapConfigId","parameters":[{"name":"masterEntryId","in":"path","description":"the id of the master entry to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"},"examples":{"bootstrapConfigId":{"description":"bootstrapConfigId","value":"63c17e68f98ac770eac303fb"}}}}},"responses":{"204":{"description":"No Content"}}}},"/api/v1/bootstrap/lwm2m/entries/{endpointName}/security":{"put":{"tags":["Bootstrap Entry"],"summary":"Update the Bootstrap security info.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"updateBootstrapSecurityInfo","parameters":[{"name":"endpointName","in":"path","description":"the endpoint client name for which the entry will be updated","required":true,"schema":{"type":"string"},"example":"urn:imei:000000000000000"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapSecurityInfo"},"examples":{"bootstrapSecurityInfo":{"description":"bootstrapSecurityInfo","value":{"mode":"PSK","pskInfo":{"identity":"urn:lo:nsid:lwm2m:sensor12Stream","secret":"0123456789ABCDEF0123456789ABCDEF"}}}}}},"required":true},"responses":{"204":{"description":"No Content"}}}},"/api/v1/bootstrap/lwm2m/entries/{endpointName}/definition/runServers/{id}":{"put":{"tags":["Bootstrap Entry"],"summary":"Update a Run Server of a lwm2m bootstrap entry.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"updateRunServer","parameters":[{"name":"endpointName","in":"path","description":"the endpoint client name for which the entry will be updated","required":true,"schema":{"type":"string"},"example":"urn:imei:000000000000000"},{"name":"id","in":"path","description":"the identifier of the Run Server that will be updated or added","required":true,"schema":{"type":"string"},"example":"myServer"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunServerConfigParams"},"examples":{"runServer":{"description":"runServer","value":{"id":"LOServer","security":{"pskInfo":{"identity":"urn:lo:nsid:lwm2m:sensor12Stream","secret":"0123456789ABCDEF0123456789ABCDEF"}}}}}}},"required":true},"responses":{"204":{"description":"No Content"}}},"delete":{"tags":["Bootstrap Entry"],"summary":"Delete a Run Server of a lwm2m bootstrap entry.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"deleteRunServer","parameters":[{"name":"endpointName","in":"path","description":"the endpoint client name for which the entry will be deleted","required":true,"schema":{"type":"string"},"example":"urn:imei:000000000000000"},{"name":"id","in":"path","description":"the identifier of the Run Server to delete","required":true,"schema":{"type":"string"},"example":"myServer"}],"responses":{"204":{"description":"No Content"}}}},"/api/v1/bootstrap/lwm2m/entries/{endpointName}/definition/bootstrapConfigId":{"put":{"tags":["Bootstrap Entry"],"summary":"Set the bootstrapConfigId field of a bootstrap entry.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"setBootstrapConfigId","parameters":[{"name":"endpointName","in":"path","description":"the endpoint client name for which the entry will be updated","required":true,"schema":{"type":"string"},"example":"urn:imei:000000000000000"}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"},"examples":{"bootstrapConfigId":{"description":"bootstrapConfigId","value":"63c17e68f98ac770eac303fb"}}}}},"responses":{"204":{"description":"No Content"}}}},"/api/v1/bootstrap/lwm2m/configs/{configId}":{"get":{"tags":["Bootstrap Config"],"summary":"Get a lwm2m bootstrap config from configId.","description":"Restricted to API keys with at least one of the following roles: BOOTSTRAP_R.","operationId":"getLwm2mBootstrapConfig","parameters":[{"name":"configId","in":"path","description":"bootstrap config identifier","required":true,"schema":{"type":"string"}},{"name":"showSensitiveInformation","in":"query","description":"whether or not to show sensitive information (headers in external config server)","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Bootstrap config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapConfig"}}}}}},"put":{"tags":["Bootstrap Config"],"summary":"Update a lwm2m bootstrap config.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"updateLwm2mBootstrapConfig","parameters":[{"name":"configId","in":"path","description":"bootstrap config identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapConfigRequest"},"examples":{"Config Update Request":{"description":"Config Update Request","value":{"name":"NewName","description":"This is a new description","runServers":[{"id":"myServer","useLiveObjects":false,"lwm2mDefinition":{"security":{"shortServerId":1,"lwm2mServerUri":"myURI","securityMode":0},"server":{"shortServerId":1,"lifetime":300,"binding":"U"}}}]}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapConfig"}}}}}},"delete":{"tags":["Bootstrap Config"],"summary":"Delete a lwm2m bootstrap config from configId.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"deleteLwm2mBootstrapConfig","parameters":[{"name":"configId","in":"path","description":"bootstrap config identifier","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Bootstrap config deleted"}}}},"/api/v1/alarms/rules/{ruleId}":{"get":{"tags":["Alarm rules"],"summary":"Retrieve an AlarmRule.","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getAlarmRule","parameters":[{"name":"ruleId","in":"path","description":"id of the AlarmRule to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"AlarmRule successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmRule"}}}},"404":{"description":"Unknown AlarmRule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmRule"}}}}}},"put":{"tags":["Alarm rules"],"summary":"Update an AlarmRule.","description":"The field `id` must be provided and match the API path id.

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"updateAlarmRule","parameters":[{"name":"ruleId","in":"path","description":"id of the AlarmRule to retrieve","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmRule"},"examples":{"Rule for suspended action policy":{"description":"Rule for suspended action policy","value":{"id":"1234567890","name":"Action policy suspended","enabled":true,"type":"actionPolicySuspended","notifications":{"notificationChannelIds":["default"]}}}}}},"required":true},"responses":{"200":{"description":"AlarmRule successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmRule"}}}},"404":{"description":"Unknown AlarmRule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmRule"}}}}}},"delete":{"tags":["Alarm rules"],"summary":"Delete an AlarmRule.","description":"Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteAlarmRule","parameters":[{"name":"ruleId","in":"path","description":"id of the AlarmRule to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"AlarmRule successfully deleted"},"404":{"description":"Unknown AlarmRule"}}}},"/api/v0/users/me/portaldata":{"get":{"tags":["Self User management"],"summary":"Get the portal data of me","description":"No specific role on API key required.","operationId":"getUserPortalData","responses":{"200":{"description":"User portal data","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"put":{"tags":["Self User management"],"summary":"Update the portal data of me","description":"No specific role on API key required.","operationId":"updateUserPortalData","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"body of my user portal data Update"}}},"required":true},"responses":{"204":{"description":"No content"},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"413":{"description":"Request Entity Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v0/rm/{resourceId}/version/{resourceVersionId}":{"get":{"tags":["Device management - Resources management"],"summary":"Get a resource's version","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getResourceVersion","parameters":[{"name":"resourceId","in":"path","description":"the resource id. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}},{"name":"resourceVersionId","in":"path","description":"the resource version id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The resource version","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceVersion"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Resource version not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"put":{"tags":["Device management - Resources management"],"summary":"Update a resource's version","description":"Usage of this API will be reported in your access log under 'device_resource' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"updateResourceVersion","parameters":[{"name":"resourceId","in":"path","description":"the resource id. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}},{"name":"resourceVersionId","in":"path","description":"the resource version id. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateResourceVersionRequest"}}},"required":true},"responses":{"200":{"description":"The resource version","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceVersion"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Resource version not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"delete":{"tags":["Device management - Resources management"],"summary":"Delete a resource's version","description":"Usage of this API will be reported in your access log under 'device_resource' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"deleteResourceVersion","parameters":[{"name":"resourceId","in":"path","description":"the resource id. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}},{"name":"resourceVersionId","in":"path","description":"the resource version id. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Resource version deleted"},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Resource version not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v0/rm/{resourceId}":{"get":{"tags":["Device management - Resources management"],"summary":"Get a resource","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getResource","parameters":[{"name":"resourceId","in":"path","description":"the resource id. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"put":{"tags":["Device management - Resources management"],"summary":"Update a resource","description":"Usage of this API will be reported in your access log under 'device_resource' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"updateResource","parameters":[{"name":"resourceId","in":"path","description":"the resource Id. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateResourceRequest"}}},"required":true},"responses":{"200":{"description":"The resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"delete":{"tags":["Device management - Resources management"],"summary":"Delete a resource","description":"Usage of this API will be reported in your access log under 'device_resource' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"deleteResource","parameters":[{"name":"resourceId","in":"path","description":"the resource id. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Resource deleted"},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v0/pipelines/{pipelineId}":{"get":{"tags":["Data management custom pipelines"],"summary":"Retrieve a DataMessage pipeline","description":"DataMessage pipelines can transform your data by calling external services in the processing flow.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getPipeline","parameters":[{"name":"pipelineId","in":"path","description":"id of the pipeline to retrieve","required":true,"schema":{"type":"string","minLength":1}},{"name":"showSensitiveInformation","in":"query","description":"whether or not to show sensitive information, such as headers. Default value is false.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"DataMessage pipeline","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}}}},"put":{"tags":["Data management custom pipelines"],"summary":"Update a DataMessage pipeline","description":"DataMessage pipelines can transform your data by calling external services in the processing flow.

Usage of this API will be reported in your access log under 'data_pipeline' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"updatePipeline","parameters":[{"name":"pipelineId","in":"path","description":"id of the pipeline to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"required":true},"responses":{"200":{"description":"DataMessage pipeline updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}}}},"delete":{"tags":["Data management custom pipelines"],"summary":"Delete a DataMessage pipeline","description":"DataMessage pipelines can transform your data by calling external services in the processing flow.

Usage of this API will be reported in your access log under 'data_pipeline' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deletePipeline","parameters":[{"name":"pipelineId","in":"path","description":"id of the pipeline to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"DataMessage pipeline deleted"}}}},"/api/v0/eventprocessing/stateprocessing-rule/{stateProcessingRuleId}":{"get":{"tags":["Event processing - State processing"],"summary":"Retrieve a StateProcessingRule","description":"State processing service aims at detecting changes in 'device state' computed from data messages. A state can represent any result computed from Live Objects data messages : geo-zone ('paris-area', 'london-area', ..), temperature status ('hot', 'cold', ..), availability status ('ok' , 'ko'). Each state is identified by a key retrieved from the user-defined json-path in the data message. stateKeyPath examples : 'streamId', 'metadata.source'...

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getStateProcessingRule","parameters":[{"name":"stateProcessingRuleId","in":"path","description":"id of the StateProcessingRule to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"StateProcessingRule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateProcessingRule"}}}}}},"put":{"tags":["Event processing - State processing"],"summary":"Update a StateProcessingRule","description":"State processing service aims at detecting changes in 'device state' computed from data messages. A state can represent any result computed from Live Objects data messages : geo-zone ('paris-area', 'london-area', ..), temperature status ('hot', 'cold', ..), availability status ('ok' , 'ko'). Each state is identified by a key retrieved from the user-defined json-path in the data message. stateKeyPath examples : 'streamId', 'metadata.source'...

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"updateStateProcessingRule","parameters":[{"name":"stateProcessingRuleId","in":"path","description":"id of the StateProcessingRule to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateProcessingRule"}}},"required":true},"responses":{"204":{"description":"The StateProcessingRule has been updated"}}},"delete":{"tags":["Event processing - State processing"],"summary":"Delete a StateProcessingRule","description":"State processing service aims at detecting changes in 'device state' computed from data messages. A state can represent any result computed from Live Objects data messages : geo-zone ('paris-area', 'london-area', ..), temperature status ('hot', 'cold', ..), availability status ('ok' , 'ko'). Each state is identified by a key retrieved from the user-defined json-path in the data message. stateKeyPath examples : 'streamId', 'metadata.source'...

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteStateProcessingRule","parameters":[{"name":"stateProcessingRuleId","in":"path","description":"id of the StateProcessingRule to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"StateProcessingRule has been deleted"}}}},"/api/v0/eventprocessing/matching-rule/{matchingRuleId}":{"get":{"tags":["Event processing - Matching"],"summary":"Retrieve a MatchingRule","description":"A MatchingRule will be applied on each data message to evaluate if a 'match' occurs. It is evaluated as a boolean result. It supports numeric, string, logic and distance operators and is based on JsonLogic. This MatchingRule should then be linked to a FiringRule to trigger an event when a match occurs.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getMatchingRule","parameters":[{"name":"matchingRuleId","in":"path","description":"id of the MatchingRule to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"MatchingRule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchingRule"}}}}}},"put":{"tags":["Event processing - Matching"],"summary":"Update a MatchingRule","description":"A MatchingRule will be applied on each data message to evaluate if a 'match' occurs. It is evaluated as a boolean result. It supports numeric, string, logic and distance operators and is based on JsonLogic. This MatchingRule should then be linked to a FiringRule to trigger an event when a match occurs.

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"updateMatchingRule","parameters":[{"name":"matchingRuleId","in":"path","description":"id of the MatchingRule to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchingRule"}}},"required":true},"responses":{"204":{"description":"The MatchingRule has been updated"}}},"delete":{"tags":["Event processing - Matching"],"summary":"Delete a MatchingRule","description":"A MatchingRule will be applied on each data message to evaluate if a 'match' occurs. It is evaluated as a boolean result. It supports numeric, string, logic and distance operators and is based on JsonLogic. This MatchingRule should then be linked to a FiringRule to trigger an event when a match occurs.

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteMatchingRule","parameters":[{"name":"matchingRuleId","in":"path","description":"id of the MatchingRule to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"MatchingRule has been deleted"}}}},"/api/v0/eventprocessing/geozones/{zoneId}":{"get":{"tags":["Event processing - Geozone"],"summary":"retrieve a geozone from repository","description":"The Geozone repository is a database that allows storing geographical sites/zones of interest. The geozones are stored as polygons (array of geopoints coordinates in decimal degrees). Meta information like a description and tags can be stored with the geozone. The Geozone format : coordinates for polygon definition, use longitude as the first coordinate and latitude as the second coordinate, polygons are closed linestrings, with at least four coordinate pairs and specify the same position as the first and last coordinates. You can define several polygons in the same geozone, for example to define a zone with holes (first polygon is the external limit of the zone and the following polygons are holes in this zone). e.g. [[[1.780892, 48.091452], [2.301382, 48.000565], [2.281961, 47.509630], [1.252634, 47.729556], [1.780892, 48.091452]]]

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getEventProcessingGeozone","parameters":[{"name":"zoneId","in":"path","description":"the user-defined id of the zone to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Geozone retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeozoneContainer"}}}},"404":{"description":"Unable to find specified geozone id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeozoneContainer"}}}}}},"put":{"tags":["Event processing - Geozone"],"summary":"Store a geographic zone","description":"The Geozone repository is a database that allows storing geographical sites/zones of interest. The geozones are stored as polygons (array of geopoints coordinates in decimal degrees). Meta information like a description and tags can be stored with the geozone. The Geozone format : coordinates for polygon definition, use longitude as the first coordinate and latitude as the second coordinate, polygons are closed linestrings, with at least four coordinate pairs and specify the same position as the first and last coordinates. You can define several polygons in the same geozone, for example to define a zone with holes (first polygon is the external limit of the zone and the following polygons are holes in this zone). e.g. [[[1.780892, 48.091452], [2.301382, 48.000565], [2.281961, 47.509630], [1.252634, 47.729556], [1.780892, 48.091452]]]

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"saveEventProcessingGeozone","parameters":[{"name":"zoneId","in":"path","description":"the id of the zone to save","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeozoneContainerBase"}}},"required":true},"responses":{"201":{"description":"Geo zone created or updated"}}},"delete":{"tags":["Event processing - Geozone"],"summary":"delete a geographic zone","description":"The Geozone repository is a database that allows storing geographical sites/zones of interest. The geozones are stored as polygons (array of geopoints coordinates in decimal degrees). Meta information like a description and tags can be stored with the geozone. The Geozone format : coordinates for polygon definition, use longitude as the first coordinate and latitude as the second coordinate, polygons are closed linestrings, with at least four coordinate pairs and specify the same position as the first and last coordinates. You can define several polygons in the same geozone, for example to define a zone with holes (first polygon is the external limit of the zone and the following polygons are holes in this zone). e.g. [[[1.780892, 48.091452], [2.301382, 48.000565], [2.281961, 47.509630], [1.252634, 47.729556], [1.780892, 48.091452]]]

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteEventProcessingGeozone","parameters":[{"name":"zoneId","in":"path","description":"the id of the zone to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Geo zone deleted"}}}},"/api/v0/eventprocessing/firing-rule/{firingRuleId}":{"get":{"tags":["Event processing - Firing"],"summary":"Retrieve a FiringRule","description":"A FiringRule applies to the matches triggered by one or many matching rules and defines when fired events must be generated.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getFiringRule","parameters":[{"name":"firingRuleId","in":"path","description":"id of the FiringRule to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"FiringRule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiringRule"}}}}}},"put":{"tags":["Event processing - Firing"],"summary":"Update a FiringRule","description":"A FiringRule applies to the matches triggered by one or many matching rules and defines when fired events must be generated.

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"updateFiringRule","parameters":[{"name":"firingRuleId","in":"path","description":"id of the FiringRule to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiringRule"}}},"required":true},"responses":{"204":{"description":"The FiringRule has been updated"}}},"delete":{"tags":["Event processing - Firing"],"summary":"Delete a FiringRule","description":"A FiringRule applies to the matches triggered by one or many matching rules and defines when fired events must be generated.

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteFiringRule","parameters":[{"name":"firingRuleId","in":"path","description":"id of the FiringRule to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Delete request has been accepted. Return true if the FiringRule did exist, false else."}}}},"/api/v0/eventprocessing/context/{contextKey}":{"get":{"tags":["Event processing - Context"],"summary":"Retrieve a context data","description":"The context repository is a database that allows storing user data that can be used in the MatchingRules and StateProcessingRules when the value is not present in the data messages. The context may include thresholds definition, geographical zones, a list of device identifiers, a user preference, a group of contexts. The context has a key-value format. The key is a string and the value can be a primitive (string, numeric…​), a JSON object or an array.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getEventProcessingContext","parameters":[{"name":"contextKey","in":"path","description":"key of the context to get","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"a context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextContainer"}}}}}},"put":{"tags":["Event processing - Context"],"summary":"Store a context data.","description":"The context repository is a database that allows storing user data that can be used in the MatchingRules and StateProcessingRules when the value is not present in the data messages. The context may include thresholds definition, geographical zones, a list of device identifiers, a user preference, a group of contexts. The context has a key-value format. The key is a string and the value can be a primitive (string, numeric…​), a JSON object or an array.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"saveEventProcessingContext","parameters":[{"name":"contextKey","in":"path","description":"context key to store","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextContainer"}}},"required":true},"responses":{"200":{"description":"Context stored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextContainer"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContextContainer"}}}}}},"delete":{"tags":["Event processing - Context"],"summary":"Delete a context data.","description":"The context repository is a database that allows storing user data that can be used in the MatchingRules and StateProcessingRules when the value is not present in the data messages. The context may include thresholds definition, geographical zones, a list of device identifiers, a user preference, a group of contexts. The context has a key-value format. The key is a string and the value can be a primitive (string, numeric…​), a JSON object or an array.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteEventProcessingContext","parameters":[{"name":"contextKey","in":"path","description":"key of the context to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Deleted context key"}}}},"/api/v0/eventprocessing/activity/states/mute":{"put":{"tags":["Event processing - Activity"],"summary":"Mute or reset nextAlarm of ActivityStates targeted by a specific deviceId/activityRuleId","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"muteActivityRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityStateMuteRequest"}}},"required":true},"responses":{"200":{"description":"ActivityState has been updated, return the number of targeted states","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}}}}}},"/api/v0/eventprocessing/activity/rules/{activityRuleId}":{"get":{"tags":["Event processing - Activity"],"summary":"Retrieve an ActivityRule","description":"An ActivityRule will monitor device activity and trigger events when they become silent after certain amount a time.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getActivityRule","parameters":[{"name":"activityRuleId","in":"path","description":"id of the ActivityRule to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"ActivityRule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityRule"}}}}}},"put":{"tags":["Event processing - Activity"],"summary":"Update an ActivityRule","description":"An ActivityRule will monitor device activity and trigger events when they become silent after certain amount a time.

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"updateActivityRule","parameters":[{"name":"activityRuleId","in":"path","description":"id of the ActivityRule to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityRule"}}},"required":true},"responses":{"204":{"description":"The ActivityRule has been updated"}}},"delete":{"tags":["Event processing - Activity"],"summary":"Delete an ActivityRule","description":"An ActivityRule will monitor device activity and trigger events when they become silent after certain amount a time.

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteActivityRule","parameters":[{"name":"activityRuleId","in":"path","description":"id of the ActivityRule to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"ActivityRule has been deleted"}}}},"/api/v0/deviceMgt/campaigns/{campaignId}/cancel":{"put":{"tags":["Campaign management"],"summary":"Cancel a campaign","description":"Usage of this API will be reported in your access log under 'device_campaign' category.

Restricted to API keys with at least one of the following roles: CAMPAIGN_W.","operationId":"cancelCampaign","parameters":[{"name":"campaignId","in":"path","description":"identifier of a campaign","required":true,"schema":{"type":"string"}},{"name":"force","in":"query","description":"When force is false, the campaign manager prevents devices with status not started from starting, cancel devices with status pending and let devices with status in progress finish properly. When force is true, the campaign manager aborts all pending and in progress sequences immediately.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Campaign has been canceled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}}}},"/api/v0/decoders/csv/{decoderId}":{"get":{"tags":["Decoders - CSV"],"summary":"Retrieve a CSV decoder","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A CSV decoder handles payload with CSV format.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getCsvDecoder","parameters":[{"name":"decoderId","in":"path","description":"id of the CSV decoder to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"CSV decoder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsvPayloadDescription"}}}}}},"put":{"tags":["Decoders - CSV"],"summary":"Update a CSV decoder","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A CSV decoder handles payload with CSV format.

Usage of this API will be reported in your access log under 'data_decoder' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"updateCsvDecoder","parameters":[{"name":"decoderId","in":"path","description":"id of the csv decoder to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsvPayloadDescription"}}},"required":true},"responses":{"200":{"description":"Csv decoder updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsvPayloadDescription"}}}}}},"delete":{"tags":["Decoders - CSV"],"summary":"Delete a CSV decoder","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A CSV decoder handles payload with CSV format.

Usage of this API will be reported in your access log under 'data_decoder' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteCsvDecoder","parameters":[{"name":"decoderId","in":"path","description":"id of the CSV decoder to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"CSV decoder deleted"}}}},"/api/v0/decoders/csv/{decoderId}/enabled":{"put":{"tags":["Decoders - CSV"],"summary":"Activate or deactivate a CSV decoder","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A CSV decoder handles payload with CSV format. A non enabled decoder will not be applied on data messages. This allows you to temporarily disable a decoder without deleting it.

Usage of this API will be reported in your access log under 'data_decoder' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"activateCsvDecoder","parameters":[{"name":"decoderId","in":"path","description":"id of the CSV decoder to activate or deactivate","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"boolean","description":"true to activate, false otherwise"}}},"required":true},"responses":{"204":{"description":"Update request has been accepted."}}}},"/api/v0/decoders/binary/{decoderId}":{"get":{"tags":["Decoders - binary"],"summary":"Retrieve a binary decoder","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getBinaryDecoder","parameters":[{"name":"decoderId","in":"path","description":"id of the binary decoder to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"binary decoder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinaryPayloadDescription"}}}}}},"put":{"tags":["Decoders - binary"],"summary":"Update a binary decoder","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A binary decoder handles binary payload an uses 'Java Binary Block Parser' DSL.

Usage of this API will be reported in your access log under 'data_decoder' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"updateBinaryDecoder","parameters":[{"name":"decoderId","in":"path","description":"id of the binary decoder to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinaryPayloadDescription"}}},"required":true},"responses":{"200":{"description":"Binary decoder updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinaryPayloadDescription"}}}}}},"delete":{"tags":["Decoders - binary"],"summary":"Delete a binary decoder","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A binary decoder handles binary payload an uses 'Java Binary Block Parser' DSL.

Usage of this API will be reported in your access log under 'data_decoder' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteBinaryDecoder","parameters":[{"name":"decoderId","in":"path","description":"id of the binary decoder to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Binary decoder deleted"}}}},"/api/v0/decoders/binary/{decoderId}/enabled":{"put":{"tags":["Decoders - binary"],"summary":"Activate or deactivate a binary decoder","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A binary decoder handles binary payload an uses 'Java Binary Block Parser' DSL. A non enabled decoder will not be applied on data messages. This allows you to temporarily disable a decoder without deleting it.

Usage of this API will be reported in your access log under 'data_decoder' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"activateBinaryDecoder","parameters":[{"name":"decoderId","in":"path","description":"id of the binary decoder to activate or deactivate","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"boolean","description":"true to activate, false otherwise"}}},"required":true},"responses":{"204":{"description":"Update request has been accepted."}}}},"/api/v0/apiKeys/{apiKeyId}/debugMode":{"put":{"tags":["Api keys"],"summary":"Activate/Deactivate the debug mode on an API key","description":"Usage of this API will be reported in your access log under 'api_key' category.

Restricted to API keys with at least one of the following roles: API_KEY_W.","operationId":"setApiKeyDebugMode","parameters":[{"name":"apiKeyId","in":"path","description":"identifier of your API key. Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebugModeConfiguration"}}},"required":true},"responses":{"200":{"description":"The updated ApiKey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"ApiKey or Tenant not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/networks/cellular/subscriptions/search":{"post":{"tags":["Beta - Cellular networks management"],"summary":"Search cellular subscriptions. BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"

A network subscription identified by a subscriptionId. It is linked to a SIM card\nand contains information such as:

\n\n

If you use the \"deviceId\" search type, Live Objects will look for potential 'imei' or 'msisdn' in your device inventory based on the following fields (in order) :



Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"searchSubscriptions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSubscriptionsRequest"}}},"required":true},"responses":{"200":{"description":"The requested subscriptions list.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionResponse"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/network-metrics":{"post":{"tags":["Beta - Network metrics"],"summary":"Get the network metrics regarding provided filters BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"

\nThis endpoint gives you statistics on exchanges between devices and Live Objects.\nIt is very useful to monitor the health of your devices' connections to Live Objects and investigate unexpected behavior.\nConnectivities available with such statistics : LwM2M.\n
\nResults are aggregated per bucket (hour, day or week).\n

\n

\nProvided temporal fields (\"from\", \"to\" and \"interval\") must not lead to the generation of too many buckets :\n

\n

\n

Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getNetworkMetrics","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkMetricsRequest"}}},"required":true},"responses":{"200":{"description":"Network metrics","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NetworkMetricsResult"}}}}}}}},"/api/v1/network-metrics/lostMessagesRatio":{"post":{"tags":["Beta - Network metrics"],"summary":"Get lost messages ratio regarding provided filters BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"

\nThis endpoint gives you lost messages ratio on exchanges between devices and Live Objects.\nNot all connectivities have such statistics.\n
\nResults are aggregated per bucket (hour, day or week).\n
\nBuckets having zero as ratio value are not included in the response.\n

\n

\nProvided temporal fields (\"from\", \"to\" and \"interval\") must not lead to the generation of too many buckets : 1000 buckets max.\n

\n

\nThe lost message rate for the current day is never included in the response.\n

\n

Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getLostMessagesRatio","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LostMessagesRatioRequest"},"example":{"filters":{"from":"2003-09-06T20:05:00Z","to":"2003-09-07T15:12:13Z","interface":{"connector":"lwm2m","nodeId":"12345A0409001C1A"}},"timeAggregation":{"interval":"hour","timezone":"+01:00"}}}},"required":true},"responses":{"200":{"description":"Lost messages ratio","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LostMessagesRatioResult"}}}}}}}},"/api/v1/event2action/test/http-push":{"post":{"tags":["Triggers and Actions - Test"],"summary":"Post an http request for testing a webhook","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"testHttpPushV1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpPushWebhookTest"}}},"required":true},"responses":{"200":{"description":"Http push test successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpPushTestResult"}}}}}}},"/api/v1/event2action/test/fifo":{"post":{"tags":["Triggers and Actions - Test"],"summary":"Post a FIFO message for testing purposes","description":"This API aims to be used only for testing purpose. Only few calls per minute are allowed. It directly publishes a message into a FIFO, without being processed by decoders, analyzed by event processing or stored into the data storage. The message must be a JSON object (not a Json primitive or array). The test message is sent with 'no retention' : if there is no ongoing MQTT SUB on this FIFO (refer to MQTT 'application' mode in the dev guide), the message will be discarded.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"testFifoMessage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FifoTestRequest"}}},"required":true},"responses":{"200":{"description":"FIFO test completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FifoTestResult"}}}}}}},"/api/v1/event2action/actionPolicies":{"get":{"tags":["Triggers and Actions"],"summary":"List ActionPolicies","description":"Triggers and Actions APIs allow you to create action policies that will automatically trigger actions (webhook, push to FIFO, SMS, email, push to an Azure Event Hub server) when specific events or datamessages ('triggers') are received by the platform.
These triggers and actions endpoints are related to the routing & alarming notification feature.
\r\nPlease see the dedicated sections in our developer guide for more details.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listActionPoliciesV1","parameters":[{"name":"triggerType","in":"query","description":"Filter on action policy trigger type.","required":false,"schema":{"type":"string","enum":["dataMessage","stateChange","deviceActivity","matchingFired","deviceStatus","commandStatus","deviceCreated","deviceDeleted","loraNetwork","loraGatewayStatus","connectivityManagementPlatformEvent","alarmEvent"]}}],"responses":{"200":{"description":"ActionPolicies Successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActionPolicy"}}}}}}},"post":{"tags":["Triggers and Actions"],"summary":"Create an ActionPolicy","description":"Triggers and Actions APIs allow you to create action policies that will automatically trigger actions (webhook, push to FIFO, SMS, email, push to an Azure Event Hub server) when specific events or datamessages ('triggers') are received by the platform.
These triggers and actions endpoints are related to the routing & alarming notification feature.
\r\nPlease see the dedicated sections in our developer guide for more details.

Usage of this API will be reported in your access log under 'routing' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"createActionPolicyV1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionPolicy"},"examples":{"POST ActionPolicy":{"description":"This example will create a new action policy (action ids not provided)","value":{"name":"name-aea80c1d-5777-4e20-822c-5e6871f428e5","enabled":true,"triggers":{"deviceStatus":{"version":1,"filter":{"connectors":["mqtt"],"groupPaths":[{"path":"/lyon","includeSubPath":true}]}}},"actions":{"emails":[{"to":["notification@orange.com"],"cc":["cc@orange.com"],"cci":["cci@orange.com"],"subjectTemplate":"State change for {{stateKey}}","contentTemplate":"{{stateKey}} change from state {{previousState}} to state {{newState}} at {{timestamp}}"}],"sms":[{"destinationPhoneNumbers":["+33601234567"],"contentTemplate":"{{stateKey}} new state {{newState}} at {{timestamp}}"}]}}}}}},"required":true},"responses":{"200":{"description":"ActionPolicy created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionPolicy"}}}}}}},"/api/v1/deviceMgt/twin/model/object-definitions":{"post":{"tags":["Twin models management"],"summary":"Add a custom twin model.","description":"

\n For LwM2M input, custom model objectDefinitionId must be between 10241 and 42800.\n

\n

\n ⚠️ IDs between 10241 and 32768 belong to a public class of the LwM2M Object Registry,\n so they should be used with care as the custom model will supersede the potential public model\n

\n

Usage of this API will be reported in your access log under 'twin' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"createCustomModel","parameters":[{"name":"inputFormat","in":"query","description":"Input format used when importing the model. The only available option for now is \"LWM2M\"","required":false,"schema":{"type":"string","default":"LWM2M"}},{"name":"override","in":"query","description":"If TRUE then the imported definition will override the existing one (if it already exists)","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"XML file content in the OMA LwM2M format"}},"required":["file"]}}}},"responses":{"201":{"description":"Custom twin model created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwinModelResponse"}}}}}}},"/api/v1/deviceMgt/twin/data/rules":{"get":{"tags":["Twin data rules management"],"summary":"List twin data rules","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listTwinDataRules","responses":{"200":{"description":"List of twin data rules","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TwinDataRule"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Read forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"post":{"tags":["Twin data rules management"],"summary":"Create new twin data rule","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"createTwinDataRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwinDataRuleRequest"}}},"required":true},"responses":{"201":{"description":"Twin data rule created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwinDataRule"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}},"403":{"description":"Create forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}}},"/api/v1/deviceMgt/groups":{"get":{"tags":["Device management - Groups - V1"],"summary":"List registered device groups","description":"Managing groups of devices allows you to organize your devices in a hierarchical structure. Groups can be used to target specific subsets of devices when performing operations such as filtering triggers and actions rules, querying their data... Groups can be nested, allowing you to create a tree-like structure of groups and subgroups.

Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listGroups","parameters":[{"name":"limit","in":"query","description":"the maximum number of items per page (optional)","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"offset","in":"query","description":"the requested page number (optional)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"parentId","in":"query","description":"filter list by group's parent. When a parent is set, only direct children are returned (one level). Expected string (max 6 characters)","required":false,"schema":{"type":"string"}},{"name":"groupPath","in":"query","description":"filter list by group's path. When a full path is set, only nodes matching exactly this path are returned.
In order to return nodes matching a path and all descendants, the groupPath must end with /* (ex. /spain/*).
In order to return direct children nodes -only- of a path, the groupPath must end with /*/ (ex. /spain/*/).
Expected string (max 255 characters)","required":false,"schema":{"type":"string"}},{"name":"X-Total-Count","in":"header","description":"true if a total count must be returned in response","required":false,"schema":{"type":"boolean","default":false},"example":true}],"responses":{"200":{"description":"The list of groups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"post":{"tags":["Device management - Groups - V1"],"summary":"Create a device group","description":"Managing groups of devices allows you to organize your devices in a hierarchical structure. Groups can be used to target specific subsets of devices when performing operations such as filtering triggers and actions rules, querying their data... Groups can be nested, allowing you to create a tree-like structure of groups and subgroups. Create a new device group. Expected string (max 6 characters)

Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"createGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupCreateRequest"}}},"required":true},"responses":{"201":{"description":"The group newly created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"the server cannot or will not process the request due to something that is perceived to be a client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"Group already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/explorer/stats":{"post":{"tags":["Inventory Explorer"],"summary":"Count and aggregate devices across the fleet.","description":"Provides aggregation and counting capabilities over the entire fleet inventory index.\nIt is intended for dashboards, analytics, and reporting where you need counts and distributions\nrather than individual device details.\n

RSQL supported fields are:

\n

RSQL supported operators are:

\n

RSQL complex syntax using (), '', \"\" can be executed:

\n

The inventory service maintains an indexed version of the whole fleet.\nAs a consequence, a latency of a few seconds has to be expected before the current state of the fleet is available in the inventory index,\nthis latency can be longer especially when dealing with very large fleets.



Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"createStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsRequest"},"examples":{"Interfaces connectors and status":{"$ref":"swagger/static/examples/dm/explorer/stats_interfaces_request.json"},"Location":{"$ref":"swagger/static/examples/dm/explorer/stats_location_request.json"},"Location and interfaces":{"$ref":"swagger/static/examples/dm/explorer/stats_location_interfaces_request.json"},"Properties":{"$ref":"swagger/static/examples/dm/explorer/stats_nested_filter_properties_request.json"},"Lora lost messages":{"$ref":"swagger/static/examples/dm/explorer/stats_lora_lost_messages_range_request.json"}}}},"required":true},"responses":{"200":{"description":"Stats response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}}},"/api/v1/deviceMgt/explorer/search":{"post":{"tags":["Inventory Explorer"],"summary":"Search devices in the inventory index.","description":"Enables querying and retrieving detailed device information from the entire fleet inventory index\nwith flexible filtering capabilities. Unlike standard device management APIs, this endpoint queries an enriched,\nindexed representation of devices, optimized for complex search operations and list views.\n

RSQL supported fields are:

\n

RSQL supported operators are:

\n

RSQL complex syntax using (), '', \"\" can be executed:

\n

The inventory service maintains an indexed version of the whole fleet.\nAs a consequence, a latency of a few seconds has to be expected before the current state of the fleet is available in the inventory index,\nthis latency can be longer especially when dealing with very large fleets.



Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"createSearch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"},"examples":{"Group and interfaces":{"$ref":"swagger/static/examples/dm/explorer/search_rsql_interface_request.json"},"Tags and activity state":{"$ref":"swagger/static/examples/dm/explorer/search_rsql_tags_request.json"},"Partial search":{"$ref":"swagger/static/examples/dm/explorer/search_partial_request.json"},"Location":{"$ref":"swagger/static/examples/dm/explorer/search_geobounds_request.json"},"Lora lost messages":{"$ref":"swagger/static/examples/dm/explorer/search_lora_lost_messages_request.json"}}}},"required":true},"responses":{"200":{"description":"Search response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices":{"get":{"tags":["Device management - Inventory - V1"],"summary":"List registered devices","description":"

The inventory service maintains an indexed version of the whole fleet.\nAs a consequence, a latency of a few seconds has to be expected before the current state of the fleet is available in the inventory index,\nthis latency can be longer especially when dealing with very large fleets.



Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listDevicesV1","parameters":[{"name":"property.{filterName}","in":"query","description":"[Cannot be tested in swagger-ui] Multiple filters, Example : devices?property.temperature=25&property.humidity=58\nMax number of properties depends of your offer settings. A property name must not include following characters $.NULL and max length is 128. Invalid property names are : 'class', '_class'. Property value max length is 256.","schema":{"type":"string","example":"property_value"}},{"name":"limit","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"string","default":"20"}},{"name":"offset","in":"query","description":"number of items to skip (optional & DEPRECATED if >10000, please use bookmarkId Instead)","required":false,"deprecated":true,"schema":{"type":"integer","format":"int32"}},{"name":"bookmarkId","in":"query","description":"id of the last document retrieved that can be used to paginate : first result will be the one following this document id","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"sorting list by attributes. Supported columns: id, name, created, updated, group, interfaces.status, interfaces.enabled, interfaces.lastContact). Example: [\"id\",\"-created\"]. ","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"id","in":"query","description":"filter list by device identifier. Must respect the following regular expression ^\\*?(?:[\\w:|\\-]|\\.\\*)*\\*?$.Expected string (max 269 characters) Example: \"urn:lo:nsid:mqtt:dev-00*\".","required":false,"schema":{"type":"string"}},{"name":"groupPath","in":"query","description":"filter list by device groupPath. (with optional use of wildcard '/*' at the end of search term). Expected string (max 255 characters)","required":false,"schema":{"type":"string"}},{"name":"groupId","in":"query","description":"filter list by device groupId. Expected string (max 6 characters)","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"filter list by device name. (with optional use of wildcard '*' at the beginning or end of search term)Expected string (max 255 characters)","required":false,"schema":{"type":"string"}},{"name":"tags","in":"query","description":"filter list by device tags. Max number of tags depends on your offer settings. Tag value max length is 32.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"connectors","in":"query","description":"list devices with interfaces of the specified connector(s). Example: \"mqtt, lora\".","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"interfaces.nodeId","in":"query","description":"filter list by nodeId. Must respect the following regular expression ^\\*?[\\w\\-_:]{1,269}\\*?$.Expected string (max 269 characters)","required":false,"schema":{"type":"string"}},{"name":"interfaces.status","in":"query","description":"filter list by interface status. Supported values: REGISTERED, INITIALIZING, INITIALIZED, ONLINE, OFFLINE, SLEEPING, ACTIVATED, REACTIVATED, DEACTIVATED, CONNECTIVITY_ERROR.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"interfaces.enabled","in":"query","description":"filter list by interface enabled state.","required":false,"schema":{"type":"boolean"}},{"name":"activityStates","in":"query","description":"filter list by activity state. Supported values: ACTIVE, SILENT, UNKNOWN","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"filterQuery","in":"query","description":"device filter expression using RSQL notation. Supported device properties are 'groupPath', 'groupId', 'tags', 'connector', 'properties'. Supported RSQL operators are '==','!=','=in=','and','or,'. ","required":false,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"list of fields to return. Amongst: 'id', 'name', 'description', 'tags', 'properties', 'group', 'interfaces', 'activityState', 'defaultDataStreamId', 'created', 'updated'), default: id, name, tags & group, deprecated values: 'config', 'resources'","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"X-Total-Count","in":"header","description":"true if a total count must be returned in response","required":false,"schema":{"type":"boolean","default":false},"example":true}],"responses":{"200":{"description":"The list of devices","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Device"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"post":{"tags":["Device management - Inventory - V1"],"summary":"Create a device","description":"Please refer to the 'Device Management > Interfaces' API notes for more information about 'interfaces.[x].definition' content

Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"createDeviceV1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceCreateRequest"},"examples":{"LoRa device":{"$ref":"swagger/static/examples/dm/inventory/lora_device_request.json"},"SMS device":{"$ref":"swagger/static/examples/dm/inventory/sms_device_request.json"},"MQTT device":{"$ref":"swagger/static/examples/dm/inventory/mqtt_device_request.json"},"Device with external interface":{"$ref":"swagger/static/examples/dm/inventory/x_connector_device_request.json"},"LwM2M device":{"$ref":"swagger/static/examples/dm/inventory/lwm2m_device_request.json"},"Device without interface":{"$ref":"swagger/static/examples/dm/inventory/no_interface_device_request.json"}}}},"required":true},"responses":{"200":{"description":"The device newly created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Device"},"examples":{"LoRa device":{"$ref":"swagger/static/examples/dm/inventory/lora_device_response.json"},"SMS device":{"$ref":"swagger/static/examples/dm/inventory/sms_device_response.json"},"MQTT device":{"$ref":"swagger/static/examples/dm/inventory/mqtt_device_response.json"},"Device with external interface":{"$ref":"swagger/static/examples/dm/inventory/x_connector_device_response.json"},"LwM2M device":{"$ref":"swagger/static/examples/dm/inventory/lwm2m_device_response.json"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"the server cannot or will not process the request due to something that is perceived to be a client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"Device already exists in the device manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/twin/operations":{"get":{"tags":["Twin operations management"],"summary":"List twin operations from a given deviceId","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listTwinOperations","parameters":[{"name":"deviceId","in":"path","description":"A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"contextToken","in":"query","description":"filter on contextToken","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"filter list of operation type","required":false,"schema":{"$ref":"#/components/schemas/TwinOperationTypeFilter"}},{"name":"status","in":"query","description":"filter list of operation status","required":false,"schema":{"$ref":"#/components/schemas/TwinOperationStatusFilter"}},{"name":"path","in":"query","description":"filter on path","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of twin operations","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/AbbreviatedTwinOperationExecuteResponse"},{"$ref":"#/components/schemas/AbbreviatedTwinOperationReadResponse"},{"$ref":"#/components/schemas/AbbreviatedTwinOperationWriteMetadataResponse"},{"$ref":"#/components/schemas/AbbreviatedTwinOperationWriteResponse"}]}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}},"403":{"description":"Read forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}},"post":{"tags":["Twin operations management"],"summary":"Create twin operation for a given deviceId","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"createTwinOperation","parameters":[{"name":"deviceId","in":"path","description":"A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Twin operation to create","oneOf":[{"$ref":"#/components/schemas/TwinOperationExecute"},{"$ref":"#/components/schemas/TwinOperationRead"},{"$ref":"#/components/schemas/TwinOperationWrite"},{"$ref":"#/components/schemas/TwinOperationWriteMetadata"}]},"examples":{"read":{"description":"This example will produce a read operation for the target object 5 instance 0 attribute 1.This operation has an extra contextToken to tag operation.","value":{"type":"READ","paths":["/5/0/1"],"options":{"lwm2m":{"contentFormat":{"response":"SENML_JSON"}}},"contextToken":"swagger first example"}},"read composite":{"description":"This example will produce a composite read operation for the target all objects 1, object 5 instance 1, object 5 instance 0 attribute 1 and object 5 instance 0 attribute 8 instance 1","value":{"type":"READ","paths":["/1","/5/1","/5/0/1","/5/0/8/1"],"options":{"lwm2m":{"contentFormat":{"request":"SENML_CBOR","response":"SENML_CBOR"}}}}},"write simple, update mode":{"description":"This example will produce a simple write operation to update `/5/0/8/1` with value `33`.","value":{"type":"WRITE","paths":["/5/0/8/1"],"writeMode":"UPDATE","values":[{"path":"/5/0/8/1","value":"33"}],"options":{"lwm2m":{"contentFormat":{"request":"SENML_CBOR"}}}}},"write composite, update mode":{"description":"This example will produce a composite write operation to update `/5/0/8/1` with value `33` and update `/5/0/8/2` with value `34`.","value":{"type":"WRITE","paths":["/5/0/8"],"writeMode":"UPDATE","values":[{"path":"/5/0/8/1","value":"33"},{"path":"/5/0/8/2","value":"34"}],"options":{"lwm2m":{"contentFormat":{"request":"SENML_CBOR","response":"SENML_CBOR"}}}}},"write composite, replace mode":{"description":"This example will produce a composite write operation to replace `/1/0/25` multi-instances attributes with value `22` for attribute instance `0` and `23` for attribute instance `2`. Other `/1/0/25` attributes instances will be removed.
A specific `content format` can be set for both request and response. ","value":{"type":"WRITE","paths":["/1/0/25"],"writeMode":"REPLACE","options":{"lwm2m":{"contentFormat":{"request":"SENML_CBOR"}}},"values":[{"path":"/1/0/25/0","value":"22"},{"path":"/1/0/25/2","value":"23"}]}},"write metadata":{"description":"This example will produce a `write-metadata` operation to update metadata (set, update, reset) on `/1/0/7`.
This operation is available on one and only one path per request
Metadata having its name and value means it will be set or updated
Metadata having only its name means it will be unset
Currently, Live Objects supports LwM2M 1.0 notification attributes:
","value":{"type":"WRITE-METADATA","values":[{"path":"/1/0/7","metadata":[{"name":"pmin","value":"20"},{"name":"gt","value":"50"},{"name":"lt"}]}]}},"execute":{"description":"This example will produce an execute operation for the target object 5 instance 0 attribute 2","value":{"type":"EXECUTE","paths":["/5/0/2"]}},"execute (with retry)":{"description":"This example will produce an execute operation for the target object 5 instance 0 attribute 2
It contains a policy allowing a maximum of 3 attempts to successfully complete this operation.","value":{"type":"EXECUTE","paths":["/5/0/2"],"policy":{"attempts":3}}}}}},"required":true},"responses":{"201":{"description":"Twin operation created","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TwinOperationExecuteResponse"},{"$ref":"#/components/schemas/TwinOperationReadResponse"},{"$ref":"#/components/schemas/TwinOperationWriteMetadataResponse"},{"$ref":"#/components/schemas/TwinOperationWriteResponse"}]}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}},"403":{"description":"Create forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/twin/observations":{"get":{"tags":["Twin observations"],"summary":"List twin observations for a given device.","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listTwinObservations","parameters":[{"name":"deviceId","in":"path","description":"A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TwinObservation"}}}}}}},"post":{"tags":["Twin observations"],"summary":"Create a twin observation.","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"createTwinObservation","parameters":[{"name":"deviceId","in":"path","description":"A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwinObservationCreateRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwinObservation"}}}}}},"delete":{"tags":["Twin observations"],"summary":"Delete device's twin observations.","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"deleteTwinObservations","parameters":[{"name":"deviceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Observations have been removed. Return actual number of removed Observations.","content":{"application/json":{"schema":{"type":"integer","format":"int32"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/resources/{resourceId}":{"get":{"tags":["Device management - Resources"],"summary":"Get a specific device resource","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getDeviceResourceV1","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"resourceId","in":"path","description":"device resource identifier. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of device resource versions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceResource"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"post":{"tags":["Device management - Resources"],"summary":"Set device resource versions","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"setDeviceResourceVersionV1","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"resourceId","in":"path","description":"device resource identifier. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDeviceResourceRequest"}}},"required":true},"responses":{"200":{"description":"The list of device resource versions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceResource"}}}},"204":{"description":"No Content, device resource version is already updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceResource"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/resources/{resourceId}/updates":{"post":{"tags":["Device management - Resources"],"summary":"Create a device resource update","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"postDeviceResourceUpdateV1","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"resourceId","in":"path","description":"device resource identifier. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDeviceResourceWithConnectorRequest"}}},"required":true},"responses":{"201":{"description":"Resource update created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceResourceUpdate"}}}},"204":{"description":"No Content, device resource version is already updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceResourceUpdate"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/resources/updates/{resourceId}/status":{"post":{"tags":["Device management - Resources"],"summary":"Cancel a resource update","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"cancelResourceUpdateV1","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"resourceId","in":"path","description":"device resource identifier. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}},{"name":"force","in":"query","description":"force update status change","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"future state of the resource update, must be CANCELED","enum":["CANCELED"]}}},"required":true},"responses":{"200":{"description":"Update canceled"},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/interfaces":{"get":{"tags":["Device management - Interfaces"],"summary":"Get the interface list for a registered device","description":"

A device can hold several nodes, each one defining a connectivity - LoRa, MQTT, LwM2M, SMS, X-Connector - of this device.

\n

The definition depends on connector.

\n

Lora definition:

\n\n

SMS definition:

\n\n

\n
\n\n\n\n

\n

MQTT definition:

\n\n

X-CONNECTOR definition:

\n\n

LwM2M definition:

\n\n

The activity depends on connector.

\n

Lora activity:

\n\n

SMS activity:

\n\n

MQTT activity:

\n\n

LwM2M activity:

\n\n\n

Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listInterfacesForADevice","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The interfaces list","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInterface"}},"examples":{"LoRa interface":{"$ref":"swagger/static/examples/dm/interfaces/lora_interface_list_response.json"},"SMS interface":{"$ref":"swagger/static/examples/dm/interfaces/sms_interface_list_response.json"},"MQTT interface":{"$ref":"swagger/static/examples/dm/interfaces/mqtt_interface_list_response.json"},"External interface":{"$ref":"swagger/static/examples/dm/interfaces/x_connector_interface_list_response.json"},"LwM2M interface":{"$ref":"swagger/static/examples/dm/interfaces/lwm2m_interface_list_response.json"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"The device was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"post":{"tags":["Device management - Interfaces"],"summary":"Add an interface to a registered device","description":"

A device can hold several nodes, each one defining a connectivity - LoRa, MQTT, LwM2M, SMS, X-Connector - of this device.

\n

The definition depends on connector.

\n

Lora definition:

\n\n

SMS definition:

\n\n

\n
\n\n\n\n

\n

MQTT definition:

\n\n

X-CONNECTOR definition:

\n\n

LwM2M definition:

\n\n

Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"addInterfaceToDevice","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceCreateRequest"},"examples":{"LoRa interface":{"$ref":"swagger/static/examples/dm/interfaces/lora_interface_request.json"},"SMS interface":{"$ref":"swagger/static/examples/dm/interfaces/sms_interface_request.json"},"MQTT interface":{"$ref":"swagger/static/examples/dm/interfaces/mqtt_interface_request.json"},"External interface":{"$ref":"swagger/static/examples/dm/interfaces/x_connector_interface_request.json"},"LwM2M interface":{"$ref":"swagger/static/examples/dm/interfaces/lwm2m_interface_request.json"}}}},"required":true},"responses":{"201":{"description":"The interface was successfully configured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceInterface"},"examples":{"LoRa interface":{"$ref":"swagger/static/examples/dm/interfaces/lora_interface_request_response.json"},"SMS interface":{"$ref":"swagger/static/examples/dm/interfaces/sms_interface_request_response.json"},"MQTT interface":{"$ref":"swagger/static/examples/dm/interfaces/mqtt_interface_request_response.json"},"External interface":{"$ref":"swagger/static/examples/dm/interfaces/x_connector_interface_request_response.json"},"LwM2M interface":{"$ref":"swagger/static/examples/dm/interfaces/lwm2m_interface_request_response.json"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"The device was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/interfaces/{interfaceId}/debug":{"get":{"tags":["Device management - Interfaces"],"summary":"Retrieve debug mode info on a device interface. Restricted to LwM2M and MQTT interfaces.","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getDebugModeInfo","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"interfaceId","in":"path","description":"Must be {connector}:{nodeId}","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The 'Debug Mode' info.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebugModeInfo"}}}},"404":{"description":"The device or interface was not found, or there is no DebugMode set to this interface","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}},"post":{"tags":["Device management - Interfaces"],"summary":"Activate debug mode on a device interface. This will store additional messages into your activity logs. Restricted to LwM2M and MQTT interfaces.","description":"Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"startDebugMode","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"interfaceId","in":"path","description":"Must be {connector}:{nodeId}","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebugModeStartRequest"}}},"required":true},"responses":{"201":{"description":"The 'Debug Mode' was successfully activated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebugModeInfo"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}},"404":{"description":"The device or interface was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}},"delete":{"tags":["Device management - Interfaces"],"summary":"Stop debug mode on a device interface. Restricted to LwM2M and MQTT interfaces.","description":"Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"stopDebugMode","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"interfaceId","in":"path","description":"Must be {connector}:{nodeId}","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The 'Debug Mode' was successfully deactivated"},"404":{"description":"The device or interface was not found, or there is no DebugMode set to this interface","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/config":{"get":{"tags":["Device management - Configuration"],"summary":"Get a description of the device configuration","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getDeviceConfigurationV1","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The configuration of the device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceConfig"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"post":{"tags":["Device management - Configuration"],"summary":"Set requested values for a set of device configuration parameters","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"setMultipleDeviceConfigParamsV1","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceParametersSetRequest"},"examples":{"set parameters":{"description":"set parameters","value":{"parameters":{"MyParamINT32":{"type":"INT32","value":-333},"MyParamUINT32":{"type":"UINT32","value":123333},"MyParamFLOAT":{"type":"FLOAT","value":12345.01},"MyParamSTRING":{"type":"STRING","value":"My sentence.."},"MyParamBINARY":{"type":"BINARY","value":"Nzg3ODY4Ng=="}}}}}}},"required":true},"responses":{"200":{"description":"nothing"},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/commands":{"get":{"tags":["Device management - Commands"],"summary":"List commands targeting a specific device by its identifier (URN). A command is an instruction sent to a device, telling it to perform a specific action, change a configuration parameter, or report information.","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getDeviceCommandsV1","parameters":[{"name":"deviceId","in":"path","description":"requested commands target device identifier (URN). A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Search for commands created after this date. Use ISO-8601 normalization.","required":false,"schema":{"type":"string"},"example":"2018-10-05T15:45:51Z"},{"name":"to","in":"query","description":"Search for commands created before this date. Use ISO-8601 normalization.","required":false,"schema":{"type":"string"},"example":"2018-10-05T15:45:51Z"},{"name":"limit","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"string","default":"20"}},{"name":"offset","in":"query","description":"number of items to skip (optional)","required":false,"schema":{"type":"string","default":"0"}},{"name":"sort","in":"query","description":"sorting list by attributes. DefaultValue : -created. Supported columns: id, status, created. Example: [\"status\",\"-created\"]. ","required":false,"schema":{"type":"array","items":{"type":"string"}},"example":"status,-created"},{"name":"X-Total-Count","in":"header","description":"true if a total count must be returned in response","required":false,"schema":{"type":"boolean","default":false},"example":true}],"responses":{"200":{"description":"The list of commands of the device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"},"examples":{"Commands list":{"$ref":"swagger/static/examples/dm/commands/list_command_response.json"}}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"post":{"tags":["Device management - Commands"],"summary":"Register a new command targeting a device by its identifier (URN). A command is an instruction sent to a device, telling it to perform a specific action, change a configuration parameter, or report information.","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"addDeviceCommandV1","parameters":[{"name":"deviceId","in":"path","description":"target device identifier (URN). A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"validate","in":"query","description":"Command will be validated by connector before registration. Default is \"true\"","required":false,"schema":{"type":"boolean","default":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreationCommandRequest"},"examples":{"LoRa command":{"$ref":"swagger/static/examples/dm/commands/lora_command_request.json"},"SMS text command":{"$ref":"swagger/static/examples/dm/commands/sms_text_command_request.json"},"SMS binary command":{"$ref":"swagger/static/examples/dm/commands/sms_binary_command_request.json"},"MQTT command":{"$ref":"swagger/static/examples/dm/commands/mqtt_command_request.json"},"External interface command":{"$ref":"swagger/static/examples/dm/commands/x_connector_command_request.json"}}}},"required":true},"responses":{"201":{"description":"The command created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"},"examples":{"LoRa command":{"$ref":"swagger/static/examples/dm/commands/lora_command_req_response.json"},"MQTT command":{"$ref":"swagger/static/examples/dm/commands/mqtt_command_req_response.json"},"SMS command":{"$ref":"swagger/static/examples/dm/commands/sms_command_req_response.json"},"External interface command":{"$ref":"swagger/static/examples/dm/commands/x_connector_command_req_response.json"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/device-analytics/rules":{"get":{"tags":["Device Analytics"],"summary":"Retrieve your AnalyticsRules.","description":"An AnalyticsRule defines a fleet of devices whose behavior will be analyzed by algorithms, generating a weekly report. This report includes general fleet behavior, detection of outliers, connectivity status...

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listAnalyticsRules","responses":{"200":{"description":"list of AnalyticsRules","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsRule"}}}}}}},"post":{"tags":["Device Analytics"],"summary":"Create an AnalyticsRule.","description":"An AnalyticsRule defines a fleet of devices whose behavior will be analyzed by algorithms, generating a weekly report. This report includes general fleet behavior, detection of outliers, connectivity status... The field `id` must be null, it will be automatically generated

Usage of this API will be reported in your access log under 'device_analytics' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"createAnalyticsRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsRule"},"examples":{"Rule for a LoRa fleet":{"description":"Rule for a LoRa fleet","value":{"name":"Lora Fleet analytics","fleet":{"connectors":["lora"]},"report":{"recipients":{"to":["jane.doe@mycompany.com"],"cc":["john.doe@mycompany.com"]},"language":"en"},"enabled":true}}}}},"required":true},"responses":{"201":{"description":"AnalyticsRule successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsRule"}}}}}}},"/api/v1/data/search":{"post":{"tags":["Data management data search"],"summary":"Query an Elasticsearch Domain Specific Language request","description":"return the json serialization of an Elasticsearch SearchResponse for the query

Restricted to API keys with at least one of the following roles: DATA_R.","operationId":"dslQueryV1","parameters":[{"name":"trackTotalHits","in":"query","description":"if true, hits.total can exceed 10.000; if false, hits.total will be empty; if not set hits.total will not exceed 10.000","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"elasticsearch DSL request"},"examples":{"request with query and aggregation":{"description":"request with query and aggregation","value":{"size":10,"query":{"term":{"model":"dataModel"}},"aggs":{"list_streams":{"terms":{"field":"streamId"}},"count_streams":{"cardinality":{"field":"streamId"}}}}}}}},"required":true},"responses":{"200":{"description":"json serialization of an Elasticsearch SearchResponse for the query","content":{"application/json":{"examples":{"response with query and aggregation":{"description":"response with query and aggregation","value":{"took":35,"hits":{"total":{"value":10000,"relation":"gte"},"hits":[{"_source":{"model":"dataModel","streamId":"device_stream","value":{"temp":15.3}}}]},"aggregations":{"list_streams":{"buckets":[{"key":"stream_device_001","doc_count":3}]},"count_streams":{"value":9513}}}}}}}}}}},"/api/v1/data/search/hits":{"post":{"tags":["Data management data search"],"summary":"Query an Elasticsearch Domain Specific Language request and get only hits result","description":"return a json array of stored data that match the query.

Restricted to API keys with at least one of the following roles: DATA_R.","operationId":"dslQueryHitsOnlyV1","parameters":[{"name":"trackTotalHits","in":"query","description":"if true, x-total-count header can exceed 10.000; if false, header will be missing; if not set, header will not exceed 10.000","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"elasticsearch DSL request"},"examples":{"request with query and aggregation":{"description":"request with query and aggregation","value":{"query":{"bool":{"filter":[{"term":{"metadata.source":"myDeviceId"}},{"range":{"timestamp":{"gt":"now-1d"}}}]}}}}}}},"required":true},"responses":{"200":{"description":"json array of stored data that match the query","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataStoredWeb"}}}}}}}},"/api/v1/contact/notificationChannels":{"get":{"tags":["Notification channels"],"summary":"List notification channels.","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listNotificationChannels","responses":{"200":{"description":"The notification channels list","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotificationChannel"}}}}}}},"post":{"tags":["Notification channels"],"summary":"Create a notification channel.","description":"Usage of this API will be reported in your access log under 'notification' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"createNotificationChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationChannelRequest"}}},"required":true},"responses":{"201":{"description":"The notification channel was successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationChannel"}}}}}}},"/api/v1/bootstrap/lwm2m/masterEntries":{"get":{"tags":["Bootstrap Master Entry"],"summary":"List LwM2M bootstrap master entries.","description":"Restricted to API keys with at least one of the following roles: BOOTSTRAP_R.","operationId":"listBootstrapMasterEntries","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BootstrapMasterEntrySummary"}}}}}}},"post":{"tags":["Bootstrap Master Entry"],"summary":"Create a LwM2M bootstrap master entry.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"createBootstrapMasterEntry","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapMasterEntryRequest"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapMasterEntry"}}}}}}},"/api/v1/bootstrap/lwm2m/entries":{"get":{"tags":["Bootstrap Entry"],"summary":"List lwm2m bootstrap entries.","description":"Restricted to API keys with at least one of the following roles: BOOTSTRAP_R.","operationId":"listBootstrapEntry","parameters":[{"name":"limit","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"string","default":"20"}},{"name":"bookmarkEndpointName","in":"query","description":"endpointName of the last document retrieved that can be used to paginate : first result will be the one following this document","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BootstrapEntry"}}}}}}},"post":{"tags":["Bootstrap Entry"],"summary":"Create a lwm2m bootstrap entry.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"createBootstrapEntry","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapEntry"},"examples":{"entry":{"description":"entry","value":{"endpointName":"urn:lo:nsid:lwm2m:sensor12Stream","security":{"mode":"PSK","pskInfo":{"identity":"urn:lo:nsid:lwm2m:sensor12Stream","secret":"0123456789ABCDEF0123456789ABCDEF"}},"definition":{"bootstrapConfigId":"5fb4d4ae04ef3d2228ebb459","runServers":[{"id":"LOServer","security":{"pskInfo":{"identity":"urn:lo:nsid:lwm2m:sensor12Stream","secret":"0123456789ABCDEF0123456789ABCDEF"}}}]}}}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapEntry"}}}}}}},"/api/v1/bootstrap/lwm2m/entries/{endpointName}/security/secrets":{"post":{"tags":["Bootstrap Entry"],"summary":"Generates bootstrap PSK random secret for each run server in configuration. A valid bootstrap configuration must exist for the targeted entry.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"renewRunServersSecrets","parameters":[{"name":"endpointName","in":"path","description":"The endpoint client name for which the entry will be updated","required":true,"schema":{"type":"string"},"example":"urn:imei:000000000000000"},{"name":"overrideIfExists","in":"query","description":"Override any already existing value if set to true, leave the already existing value if set to false.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"204":{"description":"No Content"}}}},"/api/v1/bootstrap/lwm2m/entries/search":{"post":{"tags":["Bootstrap Entry"],"summary":"Search for lwm2m bootstrap entries matching specified filters. This API is rate limited based on its compute time (see development guide > Limitation table).","description":"Restricted to API keys with at least one of the following roles: BOOTSTRAP_R.","operationId":"searchBootstrapEntry","parameters":[{"name":"limit","in":"query","description":"the maximum number of items per page (optional, highest value is 100)","required":false,"schema":{"type":"string","default":"20"}},{"name":"bookmarkEndpointName","in":"query","description":"endpointName of the last document retrieved that can be used to paginate : first result will be the one following this document","required":false,"schema":{"type":"string"}},{"name":"showSecuritySecrets","in":"query","description":"whether or not to show the secrets used to authenticate to the LwM2M Run server","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapEntrySearchRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BootstrapEntry"}}}}}}}},"/api/v1/bootstrap/lwm2m/entries/count":{"post":{"tags":["Bootstrap Entry"],"summary":"Count lwm2m bootstrap entries matching specified filters. This API is rate limited based on its compute time (see development guide > Limitation table).","description":"Restricted to API keys with at least one of the following roles: BOOTSTRAP_R.","operationId":"countBootstrapEntry","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapEntryCountRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapEntryCountResult"}}}}}}},"/api/v1/bootstrap/lwm2m/configs":{"get":{"tags":["Bootstrap Config"],"summary":"List lwm2m bootstrap configs.","description":"Restricted to API keys with at least one of the following roles: BOOTSTRAP_R.","operationId":"listLwm2mBootstrapConfigs","parameters":[{"name":"limit","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"string","default":"20"}},{"name":"bookmarkId","in":"query","description":"id of the last document retrieved that can be used to paginate : first result will be the one following this document id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of bootstrap configs","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BootstrapConfig"}}}}}}},"post":{"tags":["Bootstrap Config"],"summary":"Create a lwm2m bootstrap config.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"createLwm2mBootstrapConfig","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapConfigRequest"},"examples":{"LO server":{"description":"This example will produce a bootstrap config with specific security and server object for LO","value":{"name":"MyBootstrapConfig","description":"This is a LO bootstrap config","runServers":[{"id":"LOServer","useLiveObjects":true,"renewSecurityOnBootstrap":true,"lwm2mDefinition":{"security":{"shortServerId":1},"server":{"shortServerId":1,"lifetime":300,"binding":"U"}}}]}},"Other server":{"description":"This example will produce a bootstrap config with custom security and server objects","value":{"name":"MyBootstrapConfig","description":"This is my bootstrap config","runServers":[{"id":"myServer","useLiveObjects":false,"lwm2mDefinition":{"security":{"shortServerId":1,"lwm2mServerUri":"myURI","securityMode":0},"server":{"shortServerId":1,"lifetime":300,"binding":"U"}}}]}}}}},"required":true},"responses":{"201":{"description":"Bootstrap config created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapConfig"}}}}}}},"/api/v1/alarms/rules":{"get":{"tags":["Alarm rules"],"summary":"Retrieve your AlarmRules.","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listAlarmRules","responses":{"200":{"description":"list of AlarmRules","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlarmRule"}}}}}}},"post":{"tags":["Alarm rules"],"summary":"Create an AlarmRule.","description":"The field `id` must not be provided, it will be automatically generated

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"createAlarmRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmRule"},"examples":{"Rule for suspended action policy":{"description":"Rule for suspended action policy","value":{"name":"Action policy suspended","enabled":true,"type":"actionPolicySuspended","notifications":{"notificationChannelIds":["default"]}}},"Rule for message delivery success ratio supervision":{"description":"Rule for message delivery success ratio supervision","value":{"type":"messageDeliverySuccessRatio","name":"Delivered message degradation","trigger":{"condition":{"comparisonOperator":"lessThanOrEqualTo","threshold":90.0,"evaluationWindow":"P1D"}},"notifications":{"notificationChannelIds":["default"]}}}}}},"required":true},"responses":{"201":{"description":"AlarmRule successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlarmRule"}}}}}}},"/api/v0/users":{"get":{"tags":["Users management"],"summary":"List all users in a tenant account","description":"Restricted to API keys with at least one of the following roles: USER_R.","operationId":"listUsers","parameters":[{"name":"size","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"string","default":"20"}},{"name":"page","in":"query","description":"the requested page number (optional)","required":false,"schema":{"type":"string","default":"0"}},{"name":"login","in":"query","description":"login of tenant account (optional) ex: \"login_name\" (deprecated, please use /api/v2 endpoints instead)","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"email of tenant account (optional) ex: \"myAccount@mail.com\"","required":false,"schema":{"type":"string"}},{"name":"externalProvider","in":"query","description":"external (IDP) provider of tenant account (optional) ex: \"SIU\" (deprecated, please use /api/v2 endpoints instead)","required":false,"schema":{"type":"string"}},{"name":"externalId","in":"query","description":"external (IDP) identifier of tenant account (optional) ex: \"57xxxxxxxxxxxxxxxxxxxxxx\" (deprecated, please use /api/v2 endpoints instead)","required":false,"schema":{"type":"string"}},{"name":"externalLogin","in":"query","description":"external (IDP) login of tenant account (optional) ex: \"login_name\" (deprecated, please use /api/v2 endpoints instead)","required":false,"schema":{"type":"string"}},{"name":"userState","in":"query","description":"userState of tenant account (optional) ex: \"[enabled]\"","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"The list of the Users of the Tenant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageableUserForList"}}}},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"post":{"tags":["Users management"],"summary":"Create a user","description":"Usage of this API will be reported in your access log under 'user' category.

Restricted to API keys with at least one of the following roles: USER_W.","operationId":"createUserAccount","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreationCustomerDefinition"}}},"required":true},"responses":{"200":{"description":"The created User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v0/users/{userId}/password":{"post":{"tags":["Self User management"],"summary":"Update user password","description":"Usage of this API will be reported in your access log under 'user' category.

No specific role on API key required.","operationId":"updateUserPassword","parameters":[{"name":"userId","in":"path","description":"the User Identifier. Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPasswordInfo"}}},"required":true},"responses":{"200":{"description":"Updating of the password is done, nothing in the response"},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v0/users/{userId}":{"get":{"tags":["Users management"],"summary":"Get details of a user in a tenant account","description":"Restricted to API keys with at least one of the following roles: USER_R.","operationId":"getUser","parameters":[{"name":"userId","in":"path","description":"the User Identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The User data are available","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"post":{"tags":["Users management"],"summary":"Update a user","description":"Usage of this API will be reported in your access log under 'user' category.

Restricted to API keys with at least one of the following roles: USER_W.","operationId":"updateUser","parameters":[{"name":"userId","in":"path","description":"the User Identifier. Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdateCustomerDefinition"}}},"required":true},"responses":{"200":{"description":"The User data are updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"delete":{"tags":["Users management"],"summary":"Delete a user in a tenant account","description":"Usage of this API will be reported in your access log under 'user' category.

Restricted to API keys with at least one of the following roles: USER_W.","operationId":"deleteUser","parameters":[{"name":"userId","in":"path","description":"the User Identifier. Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Deletion of the user is done, nothing in the response"},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v0/users/activateTrial":{"post":{"tags":["Self User management"],"summary":"Activate discover account","description":"Usage of this API will be reported in your access log under 'user' category.

No specific role on API key required.","operationId":"updateUserPasswordWithTokenWithoutCaptcha","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverActivationDefinition"}}},"required":true},"responses":{"200":{"description":"Updating of the password is done, nothing in the response"},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v0/updateEmail":{"post":{"tags":["User authentication management"],"summary":"Update user's email","description":"Usage of this API will be reported in your access log under 'authentication' category.

No specific role on API key required.","operationId":"updateUserEmailWithToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmailValidationInfo"}}},"required":true},"responses":{"200":{"description":"OK"}}}},"/api/v0/topics/fifo":{"get":{"tags":["Deprecated - Bus management"],"summary":"Deprecated - Listing FIFO topics. Use forceRefresh=true parameter to get recent fifo statistics.","description":"Use 'Triggers and Actions' instead.

Restricted to API keys with at least one of the following roles: BUS_CONFIG_R.","operationId":"listFifoV0","parameters":[{"name":"size","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"string","default":"20"}},{"name":"page","in":"query","description":"the requested page number (optional)","required":false,"schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"The FIFO list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageableFifoTopic"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"429":{"description":"Too Many Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}},"deprecated":true},"post":{"tags":["Deprecated - Bus management"],"summary":"Deprecated - Creating a new FIFO. ","description":"Use 'Triggers and Actions' instead, actions targeting unexisting FIFOs will automatically create the corresponding FIFO.

Usage of this API will be reported in your access log under 'routing' category.

Restricted to API keys with at least one of the following roles: BUS_CONFIG_W.","operationId":"createFifoV0","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FifoCreateRequest"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"FIFO creation forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"FIFO already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}},"deprecated":true}},"/api/v0/setpwd":{"post":{"tags":["User authentication"],"summary":"Update user's password","description":"Usage of this API will be reported in your access log under 'authentication' category.","operationId":"updateUserPasswordWithToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePasswordValidationInfo"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[]}},"/api/v0/rm":{"get":{"tags":["Device management - Resources management"],"summary":"List all resources","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getResources","parameters":[{"name":"size","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","description":"the requested page number (optional)","required":false,"schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Treatment success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageableResource"}}}},"403":{"description":"Request forbidden (missing role)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageableResource"}}}}}},"post":{"tags":["Device management - Resources management"],"summary":"Add a resource in Resource Manager","description":"Usage of this API will be reported in your access log under 'device_resource' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"addResource","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddResourceRequest"}}},"required":true},"responses":{"200":{"description":"Treatment success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden (missing role)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v0/rm/{resourceId}/version":{"get":{"tags":["Device management - Resources management"],"summary":"List resource's versions","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getResourceVersions","parameters":[{"name":"resourceId","in":"path","description":"the resource id. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}},{"name":"size","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","description":"the requested page number (optional)","required":false,"schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"The list of resource versions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageableResourceVersion"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"post":{"tags":["Device management - Resources management"],"summary":"Add a new version to a resource","description":"Usage of this API will be reported in your access log under 'device_resource' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"addResourceVersion","parameters":[{"name":"resourceId","in":"path","description":"the resource id. Expected string (max 255 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddResourceVersionRequest"}}},"required":true},"responses":{"200":{"description":"The resource version","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceVersion"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"Resource version already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v0/resetpwd":{"post":{"tags":["User authentication"],"summary":"Request password reset or connection reminder","description":"Initiates a password reset process for internal users or sends connection instructions for external identity provider (merged) users. Requires valid captcha. The user must have a known, valid account. Returns success even if user is not found to prevent enumeration attacks.

Usage of this API will be reported in your access log under 'authentication' category.","operationId":"resetUserPassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordValidationInfo"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[]}},"/api/v0/pipelines":{"get":{"tags":["Data management custom pipelines"],"summary":"Retrieve the list of DataMessage pipelines, ordered by priorityLevel","description":"DataMessage pipelines can transform your data by calling external services in the processing flow.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listPipelines","responses":{"200":{"description":"list of DataMessage pipelines","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pipeline"}}}}}}},"post":{"tags":["Data management custom pipelines"],"summary":"Create a DataMessage pipeline","description":"DataMessage pipelines can transform your data by calling external services in the processing flow.

Usage of this API will be reported in your access log under 'data_pipeline' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"postPipeline","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"required":true},"responses":{"201":{"description":"DataMessage pipeline created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}}}}},"/api/v0/logout":{"post":{"tags":["User authentication management"],"summary":"Log out of the current session","description":"No specific role on API key required.","operationId":"logout","parameters":[{"name":"cookie","in":"query","description":"if true, send the API key value in a secure cookie","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"204":{"description":"No Content"}}}},"/api/v0/eventprocessing/stateprocessing-rule":{"get":{"tags":["Event processing - State processing"],"summary":"Retrieve the list of all the StateProcessingRules or get a StateProcessingRule by its name","description":"State processing service aims at detecting changes in 'device state' computed from data messages. A state can represent any result computed from Live Objects data messages : geo-zone ('paris-area', 'london-area', ..), temperature status ('hot', 'cold', ..), availability status ('ok' , 'ko'). Each state is identified by a key retrieved from the user-defined json-path in the data message. stateKeyPath examples : 'streamId', 'metadata.source'...

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listStateProcessingRules","parameters":[{"name":"name","in":"query","description":"name of the StateProcessingRules to retrieve","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"list of StateProcessingRules","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StateProcessingRule"}}}}}}},"post":{"tags":["Event processing - State processing"],"summary":"Create a StateProcessingRule","description":"State processing service aims at detecting changes in 'device state' computed from data messages. A state can represent any result computed from Live Objects data messages : geo-zone ('paris-area', 'london-area', ..), temperature status ('hot', 'cold', ..), availability status ('ok' , 'ko'). Each state is identified by a key retrieved from the user-defined json-path in the data message. stateKeyPath examples : 'streamId', 'metadata.source'... Total number of StateProcessingRule is limited. Contact the commercial team or see developer guide to get more information.

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"createStateProcessingRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateProcessingRule"}}},"required":true},"responses":{"201":{"description":"StateProcessingRule stored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateProcessingRule"}}}}}}},"/api/v0/eventprocessing/stateprocessing-rule/test":{"post":{"tags":["Event processing - State processing"],"summary":"test a State Processing function","description":"State processing service aims at detecting changes in 'device state' computed from data messages. A state can represent any result computed from Live Objects data messages : geo-zone ('paris-area', 'london-area', ..), temperature status ('hot', 'cold', ..), availability status ('ok' , 'ko'). Each state is identified by a key retrieved from the user-defined json-path in the data message. stateKeyPath examples : 'streamId', 'metadata.source'...

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"testStateProcessingRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateProcessingFunctionTest"}}},"required":true},"responses":{"200":{"description":"State Processing function result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateProcessingFunctionTestResult"}}}}}}},"/api/v0/eventprocessing/matching-rule":{"get":{"tags":["Event processing - Matching"],"summary":"Retrieve the list of all the MatchingRules or get a MatchingRule by its name","description":"A MatchingRule will be applied on each data message to evaluate if a 'match' occurs. It is evaluated as a boolean result. It supports numeric, string, logic and distance operators and is based on JsonLogic. This MatchingRule should then be linked to a FiringRule to trigger an event when a match occurs.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listMatchingRules","parameters":[{"name":"name","in":"query","description":"name of the MatchingRule to retrieve","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"list of MatchingRules","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MatchingRule"}}}}}}},"post":{"tags":["Event processing - Matching"],"summary":"Create a MatchingRule","description":"A MatchingRule will be applied on each data message to evaluate if a 'match' occurs. It is evaluated as a boolean result. It supports numeric, string, logic and distance operators and is based on JsonLogic. This MatchingRule should then be linked to a FiringRule to trigger an event when a match occurs. Total number of MatchingRules is limited. Contact the commercial team or see developer guide to get more information.

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"createMatchingRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchingRule"}}},"required":true},"responses":{"201":{"description":"MatchingRule stored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchingRule"}}}}}}},"/api/v0/eventprocessing/matching-rule/test":{"post":{"tags":["Event processing - Matching"],"summary":"Test a JsonLogic predicate with some data sample","description":"It can be used for troubleshooting or for testing the matching result of a MatchingRule before applying it. A MatchingRule will be applied on each data message to evaluate if a 'match' occurs. It is evaluated as a boolean result. It supports numeric, string, logic and distance operators and is based on JsonLogic. This MatchingRule should then be linked to a FiringRule to trigger an event when a match occurs.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"testMatchingRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMatchTest"}}},"required":true},"responses":{"200":{"description":"Test has been performed. Result is in the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMatchResult"}}}}}}},"/api/v0/eventprocessing/firing-rule":{"get":{"tags":["Event processing - Firing"],"summary":"Retrieve the list of all the FiringRules or get a FiringRule by its name","description":"A FiringRule applies to the matches triggered by one or many matching rules and defines when fired events must be generated.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listFiringRules","parameters":[{"name":"name","in":"query","description":"name of the FiringRule to retrieve","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"list of FiringRules","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FiringRule"}}}}}}},"post":{"tags":["Event processing - Firing"],"summary":"Create a FiringRule","description":"A FiringRule applies to the matches triggered by one or many matching rules and defines when fired events must be generated. Total number of FiringRules is limited. Contact the commercial team or see developer guide to get more information.

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"createFiringRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiringRule"}}},"required":true},"responses":{"201":{"description":"FiringRule stored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiringRule"}}}}}}},"/api/v0/eventprocessing/firing-guard/search":{"post":{"tags":["Event processing - Firing"],"summary":"Get FiringGuards linked to a FiringRule, and where FiringGuards selection criteria match.","description":"A FiringGuard keeps a FiringRule with an already 'fired' context from re-firing again. It applies only for 'ONCE' and 'SLEEP' types of FiringRule; and take into account the aggregationKeys values of data messages that triggered the previous event.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getFiringGuards","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiringGuardMatchRequest"}}},"required":true},"responses":{"200":{"description":"FiringGuards that match the criteria.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FiringGuard"}}}}}}}},"/api/v0/eventprocessing/activity/rules":{"get":{"tags":["Event processing - Activity"],"summary":"Retrieve the list of all the ActivityRules or get an ActivityRule by its name","description":"An ActivityRule will monitor device activity and trigger events when they become silent after certain amount a time.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listActivityRules","parameters":[{"name":"name","in":"query","description":"name of the ActivityRule to retrieve","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"list of ActivityRules","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActivityRule"}}}}}}},"post":{"tags":["Event processing - Activity"],"summary":"Create an ActivityRule","description":"An ActivityRule will monitor device activity and trigger events when they become silent after certain amount a time. These activity events can then be forwarded to FIFO or HttpPush with ActionPolicy rules. Total number of ActivityRules is limited.

Usage of this API will be reported in your access log under 'alarming' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"createActivityRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityRule"}}},"required":true},"responses":{"201":{"description":"ActivityRule created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityRule"}}}}}}},"/api/v0/deviceMgt/campaigns":{"get":{"tags":["Campaign management"],"summary":"List all campaigns","description":"Restricted to API keys with at least one of the following roles: CAMPAIGN_R.","operationId":"listCampaigns","parameters":[{"name":"size","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","description":"the requested page number (optional)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"status","in":"query","description":"status list filter","required":false,"schema":{"type":"string","enum":["COMPLETE","INCOMPLETE","RUNNING","SCHEDULED","SERVER_ERROR","CANCELED","CANCELING"]}},{"name":"sort","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","description":"sorting list by attributes (supported columns: id, name, status, created, updated). DefaultValue : -created","example":"status"}}}],"responses":{"200":{"description":"List of campaigns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageableCampaign"}}}}}},"post":{"tags":["Campaign management"],"summary":"Create a campaign","description":"Usage of this API will be reported in your access log under 'device_campaign' category.

Restricted to API keys with at least one of the following roles: CAMPAIGN_W.","operationId":"createCampaign","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignDefinition"},"examples":{"Simple config campaign":{"$ref":"swagger/static/examples/campaign/simple_config_operation.json"},"Simple command campaign":{"$ref":"swagger/static/examples/campaign/simple_command_operation.json"},"Simple resource campaign":{"$ref":"swagger/static/examples/campaign/simple_resource_operation.json"},"Simple resource update http campaign":{"$ref":"swagger/static/examples/campaign/simple_resource_update_http_operation.json"},"Simple resource update lwm2m campaign":{"$ref":"swagger/static/examples/campaign/simple_resource_update_lwm2m_operation.json"},"Config, resource and command campaign":{"$ref":"swagger/static/examples/campaign/config_resource_command_operation.json"},"Simple Twin read campaign":{"$ref":"swagger/static/examples/campaign/simple_twin_read_operation.json"},"Simple Twin write campaign":{"$ref":"swagger/static/examples/campaign/simple_twin_write_operation.json"},"Simple Twin write metadata campaign":{"$ref":"swagger/static/examples/campaign/simple_twin_write_metadata_operation.json"},"Simple Twin execute campaign":{"$ref":"swagger/static/examples/campaign/simple_twin_execute_operation.json"},"Multiple Twin operations campaign":{"$ref":"swagger/static/examples/campaign/multiple_twin_operations.json"},"Simple Twin add observation campaign":{"$ref":"swagger/static/examples/campaign/simple_twin_add_observation_operation.json"},"Simple Twin clear observations campaign":{"$ref":"swagger/static/examples/campaign/simple_twin_clear_observation_operation.json"},"Dynamic Twin clear observations campaign":{"$ref":"swagger/static/examples/campaign/dynamic_twin_clear_observation_operation.json"}}}},"required":true},"responses":{"201":{"description":"Campaign has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}}}},"/api/v0/decoders/csv":{"get":{"tags":["Decoders - CSV"],"summary":"Retrieve the list of CSV decoders filtered by tags","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A CSV decoder handles payload with CSV format.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listCsvDecoders","parameters":[{"name":"tags","in":"query","description":"filter on decoders containing at least one of these tags","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"list of CSV decoders","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CsvPayloadDescription"}}}}}}},"post":{"tags":["Decoders - CSV"],"summary":"Create a CSV decoder","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A CSV decoder handles payload with CSV format. The number of csv decoders is limited to 100.

Usage of this API will be reported in your access log under 'data_decoder' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"registerCsvDecoder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsvPayloadDescription"}}},"required":true},"responses":{"201":{"description":"Csv decoder created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsvPayloadDescription"}}}}}}},"/api/v0/decoders/csv/test":{"post":{"tags":["Decoders - CSV"],"summary":"Test a CSV decoder format with an encoded payload","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A CSV decoder handles payload with CSV format. This API allows you to test the CSV decoder format with an encoded payload. It can be used for troubleshooting or for testing the decoding result before applying it on data messages. The response contains the decoded data as Json if the decoding is successful.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"test","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsvPayloadDescriptionTestRequest"}}},"required":true},"responses":{"200":{"description":"Test has been performed. Response body contains decoded data as Json","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadDescriptionTestResult"}}}}}}},"/api/v0/decoders/binary":{"get":{"tags":["Decoders - binary"],"summary":"Retrieve the list of binary decoders","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A binary decoder handles binary payload an uses 'Java Binary Block Parser' DSL.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listBinaryDecoders","parameters":[{"name":"tags","in":"query","description":"filter on decoders containing at least one of these tags","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"list of binary decoders","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BinaryPayloadDescription"}}}}}}},"post":{"tags":["Decoders - binary"],"summary":"Create a binary decoder","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A binary decoder handles binary payload an uses 'Java Binary Block Parser' DSL. The number of binary decoders is limited to 100.

Usage of this API will be reported in your access log under 'data_decoder' category.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"registerBinaryDecoder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinaryPayloadDescription"}}},"required":true},"responses":{"201":{"description":"Binary decoder created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinaryPayloadDescription"}}}}}}},"/api/v0/decoders/binary/test":{"post":{"tags":["Decoders - binary"],"summary":"Test a binary decoder format with an encoded payload","description":"A data decoder allows you to decode your data message payload into a json format. When an encoding is defined in the device interface or in the data message, the decoder will be be applied and the data message will be updated accordingly. A binary decoder handles binary payload an uses 'Java Binary Block Parser' DSL. This API allows you to test the binary decoder format with an encoded payload. It can be used for troubleshooting or for testing the decoding result before applying it on data messages. The response contains the decoded data as Json if the decoding is successful.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"testBinaryDecoder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BinaryPayloadDescriptionTestRequest"}}},"required":true},"responses":{"200":{"description":"Test has been performed. Response body contains decoded data as Json","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayloadDescriptionTestResult"}}}}}}},"/api/v0/data/streams/{streamId}":{"get":{"tags":["Data management data store"],"summary":"Retrieve the data from a streamId","description":"return an array of StoredDataMessage matching the request parameters. This API is very efficient to retrieve data. If you are looking for a specific device's streamId data message, it is the API to use.

Restricted to API keys with at least one of the following roles: DATA_R.","operationId":"retrieveData","parameters":[{"name":"streamId","in":"path","description":"StreamId from which the data will be retrieved","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"max number of data to return, value is limited to 1000","required":false,"schema":{"type":"integer","format":"int32","default":100,"maximum":1000}},{"name":"timeRange","in":"query","description":"filter data where timestamp is in timeRange (must be ISO 8601 formatted) : ?timeRange=[lowerbound],[upperbound]. Comma is mandatory, lowerbound and upperbound are optionals. Lowerbound is inclusive, upperbound is exclusive.","required":false,"schema":{"type":"array","items":{"type":"string"},"maxItems":2,"minItems":2}},{"name":"bookmarkId","in":"query","description":"id of the last document retrieved that can be used to paginate : first result will be the one following this document id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"array of DataMessage matching the request parameters","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataStoredWeb"}}}}}}},"post":{"tags":["Data management data store"],"summary":"Insert a new Data into the stream","description":"In order for the data to be enriched by decoders and pipelines functionalities, 'metadata.encoding' field must be set.

Restricted to API keys with at least one of the following roles: DATA_W.","operationId":"addDataMessage","parameters":[{"name":"streamId","in":"path","description":"StreamId in which the data will be added. Should not contains following character or space : ' \\ \" ; { } ( )","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataWeb"}}},"required":true},"responses":{"202":{"description":"Request has been accepted. Data processing ongoing.","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/api/v0/data/search":{"post":{"tags":["Deprecated - Data management data search - V0"],"summary":"Query an Elasticsearch Domain Specific Language request","description":"return the json serialization of an Elasticsearch SearchResponse for the query

Restricted to API keys with at least one of the following roles: DATA_R.","operationId":"dslQueryV0","requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"elasticsearch DSL request"}}},"required":true},"responses":{"200":{"description":"json serialization of an Elasticsearch SearchResponse for the query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonObjectForSwagger"}}}}}}},"/api/v0/data/search/hits":{"post":{"tags":["Deprecated - Data management data search - V0"],"summary":"Query an Elasticsearch Domain Specific Language request and get only hits result","description":"return a json array of stored data that match the query.

Restricted to API keys with at least one of the following roles: DATA_R.","operationId":"dslQueryHitsOnlyV0","requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"elasticsearch DSL request"}}},"required":true},"responses":{"200":{"description":"json array of stored data that match the query","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataStoredWeb"}}}}}}}},"/api/v0/data/bulk":{"post":{"tags":["Data bulk injection"],"summary":"Insert a bulk of new Data","description":"Restricted to API keys with at least one of the following roles: DATA_W.","operationId":"addDataBulk","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataBulkWeb"}}},"required":true},"responses":{"202":{"description":"Request has been accepted. Data processing ongoing."}}}},"/api/v0/contact":{"post":{"tags":["Notification"],"summary":"API to send message","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"sendMessage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"},"examples":{"SMS Notification":{"$ref":"swagger/static/examples/contact/contact_sms.json"},"Email Notification":{"$ref":"swagger/static/examples/contact/contact_email.json"}}}},"required":true},"responses":{"200":{"description":"Message is sending, nothing in response"},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"429":{"description":"Too Many Message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v0/certificates/ca":{"get":{"tags":["CA certificates"],"summary":"List CA certificates","description":"Restricted to API keys with at least one of the following roles: API_KEY_R.","operationId":"listCertificates","responses":{"200":{"description":"Ca certificates Successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CaCertificate"}}}}}}},"post":{"tags":["CA certificates"],"summary":"Upload CA certificate","description":"Usage of this API will be reported in your access log under 'security' category.

Restricted to API keys with at least one of the following roles: API_KEY_W.","operationId":"createCertificate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaCertificateDefinition"}}},"required":true},"responses":{"200":{"description":"PEM X.509 CA certificate uploaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaCertificateRef"}}}},"400":{"description":"Invalid X.509 certificate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaCertificateRef"}}}}}}},"/api/v0/auth":{"post":{"tags":["User authentication"],"summary":"Authenticate a user","description":"Usage of this API will be reported in your access log under 'authentication' category.","operationId":"authenticateUser","parameters":[{"name":"cookie","in":"query","description":"if true, send the API key value in a secure cookie","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordAuthenticationInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResWeb"}}}}},"security":[]}},"/api/v0/apiKeys":{"get":{"tags":["Api keys"],"summary":"List API keys information","description":"List API keys information with pagination. Useful to retrieve associated roles.

Restricted to API keys with at least one of the following roles: API_KEY_R.","operationId":"getApiKeys","parameters":[{"name":"size","in":"query","description":"the maximum number of items per page (optional)","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","description":"the requested page number (optional)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"parentId","in":"query","description":"the id of your parent (optional) ex: \"57xxxxxxxxxxxxxxxxxxxxxx\". Expected identifier (max 24 characters)","required":false,"schema":{"type":"string"}},{"name":"showSessionKeys","in":"query","description":"include the session Keys (optional)","required":false,"schema":{"type":"boolean","default":false}},{"name":"roles","in":"query","description":"list of API Key associated roles (optional). Basic roles are \"USER_R\", \"USER_W\", \"API_KEY_R\", \"API_KEY_W\" or any role string supplied at tenant account creation time. Expected array of role names (max all roles, role value max 255 characters).","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"showMasterKey","in":"query","description":"Boolean to show or not the master api key","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"The list of the ApiKeys","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageableApiKey"}}}},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"post":{"tags":["Api keys"],"summary":"Create an API key","description":"Usage of this API will be reported in your access log under 'api_key' category.

Restricted to API keys with at least one of the following roles: API_KEY_W.","operationId":"createApiKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreationDefinition"}}},"required":true},"responses":{"200":{"description":"The created ApiKey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v0/apiKeys/{apiKeyId}":{"get":{"tags":["Api keys"],"summary":"Get API key information","description":"Useful to get information about the API key, like current roles.

Restricted to API keys with at least one of the following roles: API_KEY_R.","operationId":"getApiKey","parameters":[{"name":"apiKeyId","in":"path","description":"the id of your API key. Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}},{"name":"tenantId","in":"query","description":"(unused) identifier of tenant account ex: \"57xxxxxxxxxxxxxxxxxxxxxx\". Expected identifier (max 24 characters)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The ApiKey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"post":{"tags":["Api keys"],"summary":"Update an API key","description":"Update a set of properties of the selected API key

Usage of this API will be reported in your access log under 'api_key' category.

Restricted to API keys with at least one of the following roles: API_KEY_W.","operationId":"updateApiKey","parameters":[{"name":"apiKeyId","in":"path","description":"the id of your API key. Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyUpdateDefinition"}}},"required":true},"responses":{"200":{"description":"The updated ApiKey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"delete":{"tags":["Api keys"],"summary":"Delete an API key","description":"Usage of this API will be reported in your access log under 'api_key' category.

Restricted to API keys with at least one of the following roles: API_KEY_W.","operationId":"deleteApiKey","parameters":[{"name":"apiKeyId","in":"path","description":"identifier of your API key. Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Deletion is done, nothing in the response"},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v2/user/profile":{"get":{"tags":["User Profile and Access Management"],"summary":"Get connected user profile","description":"No specific role on API key required.","operationId":"getUserProfile","responses":{"200":{"description":"The user profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"patch":{"tags":["User Profile and Access Management"],"summary":"Update connected user profile (email and lang)","description":"Usage of this API will be reported in your access log under 'user' category.

No specific role on API key required.","operationId":"patchUserProfile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfilePatchRequestWeb"}}},"required":true},"responses":{"200":{"description":"The updated user profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}},"400":{"description":"An ErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}":{"get":{"tags":["Device management - Inventory - V1"],"summary":"Get a device","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getDeviceV1","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Device"},"examples":{"LoRa device":{"$ref":"swagger/static/examples/dm/inventory/lora_device_response.json"},"SMS device":{"$ref":"swagger/static/examples/dm/inventory/sms_device_response.json"},"MQTT device":{"$ref":"swagger/static/examples/dm/inventory/mqtt_device_response.json"},"Device with external interface":{"$ref":"swagger/static/examples/dm/inventory/x_connector_device_response.json"},"LwM2M device":{"$ref":"swagger/static/examples/dm/inventory/lwm2m_device_response.json"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"The device was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"delete":{"tags":["Device management - Inventory - V1"],"summary":"Delete a device","description":"Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"deleteDeviceV1","parameters":[{"name":"deviceId","in":"path","description":"Target device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The device was successfully deleted"},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"The device was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"patch":{"tags":["Device management - Inventory - V1"],"summary":"Update a device","description":"Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"updateDeviceV1","parameters":[{"name":"deviceId","in":"path","description":"Targeted device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceUpdateRequest"}}},"required":true},"responses":{"200":{"description":"The device was successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"The device was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/interfaces/{interfaceId}":{"get":{"tags":["Device management - Interfaces"],"summary":"Get a specific interface for a registered device","description":"

A device can hold several nodes, each one defining a connectivity - LoRa, MQTT, LwM2M, SMS, X-Connector - of this device.

\n

The definition depends on connector.

\n

Lora definition:

\n\n

SMS definition:

\n\n

\n
\n\n\n\n

\n

MQTT definition:

\n\n

X-CONNECTOR definition:

\n\n

LwM2M definition:

\n\n

The activity depends on connector.

\n

Lora activity:

\n\n

SMS activity:

\n\n

MQTT activity:

\n\n

LwM2M activity:

\n\n\n

Note: get command are not allowed for X-Connector.



Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getInterfaceForADevice","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"interfaceId","in":"path","description":"Must be {connector}:{nodeId}","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"An interface","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceInterface"},"examples":{"LoRa interface":{"$ref":"swagger/static/examples/dm/interfaces/lora_interface_update_response.json"},"SMS interface":{"$ref":"swagger/static/examples/dm/interfaces/sms_interface_update_response.json"},"MQTT interface":{"$ref":"swagger/static/examples/dm/interfaces/mqtt_interface_update_response.json"},"LwM2M interface":{"$ref":"swagger/static/examples/dm/interfaces/lwm2m_interface_update_response.json"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"The device was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"delete":{"tags":["Device management - Interfaces"],"summary":"Delete a device interface","description":"Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"deleteInterface","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"interfaceId","in":"path","description":"Must be {connector}:{nodeId}","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"patch":{"tags":["Device management - Interfaces"],"summary":"Update a device interface","description":"

A device can hold several nodes, each one defining a connectivity - LoRa, MQTT, LwM2M, SMS, X-Connector - of this device.

\n

The definition depends on connector.

\n

Lora definition:

\n\n

SMS definition:

\n\n

\n
\n\n\n\n

\n

MQTT definition:

\n\n

X-CONNECTOR definition:

\n\n

LwM2M definition:

\n\n

Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"updateInterface","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"interfaceId","in":"path","description":"Must be {connector}:{nodeId}","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceUpdateRequest"},"examples":{"LoRa interface":{"$ref":"swagger/static/examples/dm/interfaces/lora_interface_update.json"},"SMS interface":{"$ref":"swagger/static/examples/dm/interfaces/sms_interface_update.json"},"MQTT interface":{"$ref":"swagger/static/examples/dm/interfaces/mqtt_interface_update.json"},"External interface":{"$ref":"swagger/static/examples/dm/interfaces/x_connector_interface_update.json"},"LwM2M interface":{"$ref":"swagger/static/examples/dm/interfaces/lwm2m_interface_update.json"}}}},"required":true},"responses":{"200":{"description":"An interface","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceInterface"},"examples":{"LoRa interface":{"$ref":"swagger/static/examples/dm/interfaces/lora_interface_update_response.json"},"SMS interface":{"$ref":"swagger/static/examples/dm/interfaces/sms_interface_update_response.json"},"MQTT interface":{"$ref":"swagger/static/examples/dm/interfaces/mqtt_interface_update_response.json"},"External interface":{"$ref":"swagger/static/examples/dm/interfaces/x_connector_interface_update_response.json"},"LwM2M interface":{"$ref":"swagger/static/examples/dm/interfaces/lwm2m_interface_update_response.json"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/connectors/{connector}/nodes/{nodeId}":{"get":{"tags":["Device management - Connector nodes - V1"],"summary":"Get details of a connector node","description":"

A device can hold several nodes, each one defining a connectivity - LoRa, MQTT, LwM2M, SMS, X-Connector - of this device.

\n

The definition depends on connector.

\n

Lora definition:

\n\n

SMS definition:

\n\n

\n
\n\n\n\n

\n

MQTT definition:

\n\n

X-CONNECTOR definition:

\n\n

LwM2M definition:

\n\n

The activity depends on connector.

\n

Lora activity:

\n\n

SMS activity:

\n\n

MQTT activity:

\n\n

LwM2M activity:

\n\n\n

Note: get command are not allowed for X-Connector.



Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getNode","parameters":[{"name":"connector","in":"path","description":"Connector identifier must respect the following regular expression ([\\w\\-]{1,128}) (max 128 characters)","required":true,"schema":{"type":"string"}},{"name":"nodeId","in":"path","description":"Node identifier must respect the following regular expression ^[\\w\\-_:]{1,269} (max 269 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorNode"},"examples":{"LoRa connector node":{"$ref":"swagger/static/examples/dm/connectors/lora_connector_response.json"},"SMS connector node":{"$ref":"swagger/static/examples/dm/connectors/sms_connector_response.json"},"MQTT connector node":{"$ref":"swagger/static/examples/dm/connectors/mqtt_connector_response.json"},"External connector node":{"$ref":"swagger/static/examples/dm/connectors/x_connector_connector_response.json"},"LwM2M connector node":{"$ref":"swagger/static/examples/dm/connectors/lwm2m_connector_response.json"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"delete":{"tags":["Device management - Connector nodes - V1"],"summary":"Delete a connector node","description":"Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"deleteNode","parameters":[{"name":"connector","in":"path","description":"Connector identifier must respect the following regular expression ([\\w\\-]{1,128}) (max 128 characters)","required":true,"schema":{"type":"string"}},{"name":"nodeId","in":"path","description":"Node identifier must respect the following regular expression ^[\\w\\-_:]{1,269} (max 269 characters)","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"patch":{"tags":["Device management - Connector nodes - V1"],"summary":"Update a connector node","description":"

A device can hold several nodes, each one defining a connectivity - LoRa, MQTT, LwM2M, SMS, X-Connector - of this device.

\n

The definition depends on connector.

\n

Lora definition:

\n\n

SMS definition:

\n\n

\n
\n\n\n\n

\n

MQTT definition:

\n\n

X-CONNECTOR definition:

\n\n

LwM2M definition:

\n\n

Usage of this API will be reported in your access log under 'device_inventory' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"updateNode","parameters":[{"name":"connector","in":"path","description":"Connector identifier must respect the following regular expression ([\\w\\-]{1,128}) (max 128 characters)","required":true,"schema":{"type":"string"}},{"name":"nodeId","in":"path","description":"Node identifier must respect the following regular expression ^[\\w\\-_:]{1,269} (max 269 characters)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConnectorNodeRequest"},"examples":{"LoRa connector node":{"$ref":"swagger/static/examples/dm/interfaces/lora_interface_update.json"},"SMS connector node":{"$ref":"swagger/static/examples/dm/interfaces/sms_interface_update.json"},"MQTT connector node":{"$ref":"swagger/static/examples/dm/interfaces/mqtt_interface_update.json"},"External connector node":{"$ref":"swagger/static/examples/dm/interfaces/x_connector_interface_update.json"},"LwM2M connector node":{"$ref":"swagger/static/examples/dm/interfaces/lwm2m_interface_update.json"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorNode"},"examples":{"LoRa connector node":{"$ref":"swagger/static/examples/dm/connectors/lora_connector_response.json"},"SMS connector node":{"$ref":"swagger/static/examples/dm/connectors/sms_connector_response.json"},"MQTT connector node":{"$ref":"swagger/static/examples/dm/connectors/mqtt_connector_response.json"},"External connector node":{"$ref":"swagger/static/examples/dm/connectors/x_connector_connector_response.json"},"LwM2M connector node":{"$ref":"swagger/static/examples/dm/connectors/lwm2m_connector_response.json"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/connectors/lora/gateways/{id}":{"get":{"tags":["Gateway management for LoRa"],"summary":"Get a specific gateway information","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getLoRaGateway","parameters":[{"name":"id","in":"path","description":"identifier of the gateway","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Return a list of LoRa gateways","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoraGatewayInfo"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"401":{"description":"Unauthorized. Please check your API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"patch":{"tags":["Gateway management for LoRa"],"summary":"Update a LoRa gateway.","description":"Set the location property to an empty object to remove the gateway location.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"updateLoRaGateway","parameters":[{"name":"id","in":"path","description":"identifier of the gateway","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoraGatewayDefinition"}}},"required":true},"responses":{"200":{"description":"Return a list of LoRa gateways","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoraGatewayInfo"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"401":{"description":"Unauthorized. Please check your API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v0/deviceMgt/campaigns/{campaignId}":{"get":{"tags":["Campaign management"],"summary":"Get a campaign","description":"Restricted to API keys with at least one of the following roles: CAMPAIGN_R.","operationId":"getCampaign","parameters":[{"name":"campaignId","in":"path","description":"identifier of a campaign","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A single campaign definition and status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}}},"delete":{"tags":["Campaign management"],"summary":"Delete a campaign","description":"Usage of this API will be reported in your access log under 'device_campaign' category.

Restricted to API keys with at least one of the following roles: CAMPAIGN_W.","operationId":"deleteCampaign","parameters":[{"name":"campaignId","in":"path","description":"identifier of a campaign","required":true,"schema":{"type":"string"}},{"name":"force","in":"query","description":"cancelling mode. When force is false, the campaign manager prevents devices with status not started from starting, cancel devices with status pending and let devices with status in progress finish properly. When force is true, the campaign manager aborts all pending and in progress sequences immediately.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Campaign deleted."},"202":{"description":"Campaign will be deleted soon."}}},"patch":{"tags":["Campaign management"],"summary":"Update a campaign","description":"Usage of this API will be reported in your access log under 'device_campaign' category.

Restricted to API keys with at least one of the following roles: CAMPAIGN_W.","operationId":"updateCampaign","parameters":[{"name":"campaignId","in":"path","description":"identifier of a campaign","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignUpdating"}}},"required":true},"responses":{"200":{"description":"Campaign has been updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}}}},"/api/v2/user/accesses":{"get":{"tags":["User Profile and Access Management"],"summary":"Get connected user accesses list (forbidden in connect-as mode)","description":"No specific role on API key required.","operationId":"getUserAccesses","parameters":[{"name":"size","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"string","default":"20"}},{"name":"page","in":"query","description":"the requested page number (optional)","required":false,"schema":{"type":"string","default":"0"}},{"name":"sort","in":"query","description":"sorting list by attributes. Supported fields:\"lastAccess\". (Option) Use minus as prefix for descending order. Example: [\"-lastAccess\"].","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"The user accesses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageableV2UserAccess"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}}},"/api/v2/user/accesses/current":{"get":{"tags":["User Profile and Access Management"],"summary":"Get connected user current access","description":"No specific role on API key required.","operationId":"getCurrentUserAccess","responses":{"200":{"description":"Current user access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccess"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}}},"/api/v1/networks/cellular/subscriptions/{subscriptionId}":{"get":{"tags":["Beta - Cellular networks management"],"summary":"Get a cellular subscription. BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"

A network subscription identified by a subscriptionId. It is linked to a SIM card\nand contains information such as:

\n\n

Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getSubscription","parameters":[{"name":"subscriptionId","in":"path","description":"identifier of subscription ex: \"06xxxxxxx\". Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSubscriptionResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"the subscription was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/networks/cellular/subscriptions/{subscriptionId}/traffic/history":{"get":{"tags":["Beta - Cellular networks management"],"summary":"Get the aggregated traffic history for a cellular subscription. BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getTrafficHistory","parameters":[{"name":"subscriptionId","in":"path","description":"identifier of subscription ex: \"06xxxxxxx\". Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit the response to the last n elements (0 < n < 1000)","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"interval","in":"query","description":"Aggregation interval (hour, day or week)","required":false,"schema":{"type":"string","default":"1d","enum":["1h","1d","1w"]}},{"name":"timeZone","in":"query","description":"time zone as TZ database name (ex : Europe/Paris) or UTC offset (ex : -02:00 or %2B02:00)","required":false,"schema":{"type":"string","default":"UTC"}}],"responses":{"200":{"description":"The requested traffic history.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TrafficData"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"The subscription was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/networks/cellular/subscriptions/{subscriptionId}/location":{"get":{"tags":["Beta - Cellular networks management"],"summary":"Get the last known location of a cellular subscription. BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getLocation","parameters":[{"name":"subscriptionId","in":"path","description":"identifier of subscription ex: \"06xxxxxxx\". Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested location.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"the location was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/networks/cellular/providers":{"get":{"tags":["Beta - Cellular networks management"],"summary":"List cellular network providers. BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listCellularProviders","responses":{"200":{"description":"The providers list","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProviderResponse"}}}}}}}},"/api/v1/event2action/metrics/actionPolicies/{policyId}/actions/{actionId}":{"get":{"tags":["Triggers and Actions"],"summary":"Retrieve the metrics of an action. BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"Metrics of an ActionPolicy (success, failures, supervision, response time...), hourly or daily based.

Not all types of action have metrics. Metrics are not in real time, updated several times a day, and are estimated.

All days and hours are UTC. A maximum period of 31 days is allowed. When 'hourly' parameter is true, then the maximum period allowed is 7 days.

You can retrieve additional information on errors in your Activity logs.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getMetricsByActionId","parameters":[{"name":"policyId","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"actionId","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"hourly","in":"query","description":"when true, also retrieve detailed hour by hour metrics. hourly metrics are limited to 7 days, else the limit is 1 month of metrics. Default value is false.","required":false,"schema":{"type":"boolean","default":false}},{"name":"fromDay","in":"query","description":"Day from which retrieve the metrics. yyyy-MM-dd format (e.g. '2024-01-01'). If not set, maximum of 1 month will be retrieved.","required":false,"schema":{"type":"string"}},{"name":"toDay","in":"query","description":"Day until which retrieve the metrics. yyyy-MM-dd format (e.g. '2024-01-12'). If not set, today is used.","required":false,"schema":{"type":"string"}},{"name":"timeZoneOffset","in":"query","description":"Time zone offset to apply, ISO-8601 format restricted to hours : '±[hh]' (e.g. '+02', '-01'). Must be between [-18, +18]. Offset minutes, if any, will be ignored.Depending on your HTTP client, '+' character may have to be url encoded into '%2B'.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Action metrics successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionMetrics"}}}},"404":{"description":"Unknown Action metrics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionMetrics"}}}}}}},"/api/v1/event2action/fifos":{"get":{"tags":["Triggers and Actions"],"summary":"Listing FIFO with their linked actions.","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listFifosWithActions","parameters":[{"name":"withStatus","in":"query","description":"when true, also retrieve fifo status","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The FIFO status list","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FifoWithActions"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"429":{"description":"Too Many Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/event2action/fifos/{fifoName}":{"get":{"tags":["Triggers and Actions"],"summary":"Getting a FIFO with linked actions","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getFifoWithActions","parameters":[{"name":"fifoName","in":"path","description":"name of the fifo. Fifo name must respect the following regular expression [A-Za-z\\d\\-_~]+ (max 255 characters)","required":true,"schema":{"type":"string"}},{"name":"withStatus","in":"query","description":"when true, also retrieve fifo status","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"A FIFO","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FifoWithActions"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"FIFO not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/event2action/diagnostics/actionPolicies":{"get":{"tags":["Triggers and Actions"],"summary":"Retrieve action diagnostics","description":"Diagnostic of an ActionPolicy will indicate if the actions are suspended or not, and the reason why.

When the action leads to too many failures (for example Http Push with 5xx responses, FIFO never subbed...) the platform will automatically suspend the action.

Once suspended, you can use the resume API to re-enable the action. Please note that if the underlying issue is not fixed, the action will be suspended again.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getAllDiagnosticsForTenant","responses":{"200":{"description":"Action diagnostics successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionPolicyDiagnosticsList"}}}}}}},"/api/v1/event2action/diagnostics/actionPolicies/{policyId}":{"get":{"tags":["Triggers and Actions"],"summary":"Retrieve all action diagnostics of an action policy","description":"Diagnostic of an ActionPolicy will indicate if the actions are suspended or not, and the reason why.

When the action leads to too many failures (for example Http Push with 5xx responses, FIFO never subbed...) the platform will automatically suspend the action.

Once suspended, you can use the resume API to re-enable the action. Please note that if the underlying issue is not fixed, the action will be suspended again.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getDiagnosticsByPolicyId","parameters":[{"name":"policyId","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Action diagnostics successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActionDiagnostic"}}}}}}}},"/api/v1/event2action/diagnostics/actionPolicies/{policyId}/actions/{actionId}":{"get":{"tags":["Triggers and Actions"],"summary":"Retrieve an action diagnostic","description":"Diagnostic of an ActionPolicy will indicate if the actions are suspended or not, and the reason why.

When the action leads to too many failures (for example Http Push with 5xx responses, FIFO never subbed...) the platform will automatically suspend the action.

Once suspended, you can use the resume API to re-enable the action. Please note that if the underlying issue is not fixed, the action will be suspended again.

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getDiagnosticByActionId","parameters":[{"name":"policyId","in":"path","required":true,"schema":{"type":"string","minLength":1}},{"name":"actionId","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Action diagnostic successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionDiagnostic"}}}},"404":{"description":"Unknown Action diagnostic ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionDiagnostic"}}}}}}},"/api/v1/deviceMgt/twin/model/object-definitions/{objectDefinitionId}":{"get":{"tags":["Twin models management"],"summary":"Read a twin model","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"readPublicModel","parameters":[{"name":"objectDefinitionId","in":"path","description":"object definition identifier the model ex: urn:oma:lwm2m:ext:3442:1.1","required":true,"schema":{"type":"string"}},{"name":"customOnly","in":"query","description":"If TRUE only the custom objects are returned, else custom and public objects are returned","required":false,"schema":{"type":"boolean","default":false}},{"name":"supportedOnly","in":"query","description":"If TRUE only the supported objects are returned, else supported and instantiated objects are returned","required":false,"schema":{"type":"boolean","default":false}},{"name":"childrenFields","in":"query","description":"List of children's fields to return. Amongst: 'pathSegment', 'name', 'description', 'minOccurs', 'maxOccurs', 'type', 'operations', 'attributes'. Following children fields are always returned : 'objectDefinitionId', 'owner'.","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"responses":{"200":{"description":"The twin model","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwinModelResponse"}}}}}},"delete":{"tags":["Twin models management"],"summary":"Delete a custom twin model","description":"Usage of this API will be reported in your access log under 'twin' category.

Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"deleteCustomModel","parameters":[{"name":"objectDefinitionId","in":"path","description":"object definition identifier the model ex: urn:oma:lwm2m:ext:3442:1.1","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Custom Twin model deleted"}}}},"/api/v1/deviceMgt/twin/data/rules/{dataRuleId}":{"get":{"tags":["Twin data rules management"],"summary":"Get twin data rule from a given dataRuleId","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getTwinDataRule","parameters":[{"name":"dataRuleId","in":"path","description":"Identifier of specific twin data rule. Expected string (max 24 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwinDataRule"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Read forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Twin data rule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}},"delete":{"tags":["Twin data rules management"],"summary":"Delete twin data rule for a given dataRuleId","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_W.","operationId":"deleteTwinDataRule","parameters":[{"name":"dataRuleId","in":"path","description":"Identifier of specific twin data rule. Expected string (max 24 characters)","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Twin data rule deleted"},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Delete forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Twin data rule not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/twin/supported-objects":{"get":{"tags":["Twin devices management"],"summary":"Get twin device supported objects","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"readDeviceSupportedObjects","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Read forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/twin/operations/{operationId}":{"get":{"tags":["Twin operations management"],"summary":"Get twin operation from a given deviceId and operationId","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getTwinOperation","parameters":[{"name":"deviceId","in":"path","description":"A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"operationId","in":"path","description":"Identifier of specific twin operation. Expected string (max 32 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TwinOperationExecuteResponse"},{"$ref":"#/components/schemas/TwinOperationReadResponse"},{"$ref":"#/components/schemas/TwinOperationWriteMetadataResponse"},{"$ref":"#/components/schemas/TwinOperationWriteResponse"}]}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Read forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/twin/observations/{observationId}":{"get":{"tags":["Twin observations"],"summary":"Get a twin observation.","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getTwinObservation","parameters":[{"name":"deviceId","in":"path","description":"A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"observationId","in":"path","description":"Identifier of specific twin observation.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwinObservation"}}}}}},"delete":{"tags":["Twin observations"],"summary":"Delete a twin observation.","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"deleteTwinObservation","parameters":[{"name":"deviceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"observationId","in":"path","description":"Identifier of specific twin observation.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/api/v1/deviceMgt/devices/{deviceId}/twin/objects":{"get":{"tags":["Twin devices management"],"summary":"Get twin device objects","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"readDeviceObjects","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"If 1 then detailed object is returned","required":false,"schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParentTwinObject"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Read forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/twin/objects/{objectId}":{"get":{"tags":["Twin devices management"],"summary":"Get twin device object from a given objectId","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"readDeviceDetailedObjectFromObjectId","parameters":[{"name":"deviceId","in":"path","description":"A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"objectId","in":"path","description":"object id value (expect path segment matching ^[a-zA-Z0-9]{1,256}$)","required":true,"schema":{"type":"string"},"example":5},{"name":"expand","in":"query","description":"If 1 then detailed instance is returned","required":false,"schema":{"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwinObject"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Read forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/twin/objects/{objectId}/{objectInstanceId}":{"get":{"tags":["Twin devices management"],"summary":"Get twin device object instance from a given objectId and instanceId","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"readDeviceDetailedObjectInstanceFromObjectIdAndInstanceId","parameters":[{"name":"deviceId","in":"path","description":"A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"objectId","in":"path","description":"object id value (expect path segment matching ^[a-zA-Z0-9]{1,256}$)","required":true,"schema":{"type":"string"},"example":5},{"name":"objectInstanceId","in":"path","description":"object instance id value (expect path segment matching ^[a-zA-Z0-9]{1,256}$)","required":true,"schema":{"type":"string"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TwinObjectInstance"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Read forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/resources":{"get":{"tags":["Device management - Resources"],"summary":"Get a map of all device resources","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listDeviceResourcesV1","parameters":[{"name":"deviceId","in":"path","description":"requested target device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of device resources versions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceResourceMapResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/resources/updates":{"get":{"tags":["Device management - Resources"],"summary":"Get a list of device resource updates","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getDeviceResourceUpdatesV1","parameters":[{"name":"deviceId","in":"path","description":"requested target device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"the requested page number (optional)","required":false,"schema":{"type":"string","default":"0"}},{"name":"limit","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"string","default":"20"}},{"name":"resourceId","in":"query","description":"device resource identifier. Expected string (max 255 characters)","required":false,"schema":{"type":"string"}},{"name":"latest","in":"query","description":"get only the latest","required":false,"schema":{"type":"boolean","default":false}},{"name":"X-Total-Count","in":"header","description":"true if a total count must be returned in response","required":false,"schema":{"type":"boolean","default":false},"example":true}],"responses":{"200":{"description":"The list of device resources updates","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceResourceUpdate"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/data/streams":{"get":{"tags":["Device management - Inventory - V1"],"summary":"Get the list of device's streamIds","description":"Restricted to API keys with at least one of the following roles: DATA_R.","operationId":"getDeviceStreamsV1","parameters":[{"name":"deviceId","in":"path","description":"Targeted device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum number of return items (optional, max 100 items)","required":false,"schema":{"type":"string","default":"10","maximum":100}}],"responses":{"200":{"description":"The requested device streamIds and last data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceStreamsResponseWeb"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"The device was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/config/parameters":{"get":{"tags":["Device management - Configuration"],"summary":"Get a description of the device configuration parameters","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getDeviceConfigParametersV1","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The map of configuration parameters of the device","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DeviceParameter"}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown device","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/devices/{deviceId}/config/parameters/{paramKey}":{"get":{"tags":["Device management - Configuration"],"summary":"Get state of a specific device configuration parameter","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getDeviceConfigParameterV1","parameters":[{"name":"deviceId","in":"path","description":"device identifier. A Live Objects URN 'urn:lo:nsid:{namespace}:{id}' must respect the following regular expression ^urn:lo:nsid:([\\w\\-]{1,128}):([\\w\\-:]{1,128})$ (max 269 characters)","required":true,"schema":{"type":"string"}},{"name":"paramKey","in":"path","description":"config parameter identifier/key. Expected string (max 128 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Device configuration parameter details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceParameter"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Unknown device configuration parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/connectors/{connector}/nodes":{"get":{"tags":["Device management - Connector nodes - V1"],"summary":"List all connector nodes","description":"

A device can hold several nodes, each one defining a connectivity - LoRa, MQTT, LwM2M, SMS, X-Connector - of this device.

\n

The definition depends on connector.

\n

Lora definition:

\n\n

SMS definition:

\n\n

\n
\n\n\n\n

\n

MQTT definition:

\n\n

X-CONNECTOR definition:

\n\n

LwM2M definition:

\n\n

The activity depends on connector.

\n

Lora activity:

\n\n

SMS activity:

\n\n

MQTT activity:

\n\n

LwM2M activity:

\n\n\n

Note: list command are not allowed for X-Connector, MQTT and LWM2M.



Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listNodes","parameters":[{"name":"connector","in":"path","description":"Connector identifier must respect the following regular expression ([\\w\\-]{1,128}) (max 128 characters)","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"string","default":"20"}},{"name":"offset","in":"query","description":"number of items to skip (optional & DEPRECATED, please use bookmarkId instead)","required":false,"deprecated":true,"schema":{"type":"string","default":"0"}},{"name":"bookmarkId","in":"query","description":"id of the last node retrieved that can be used to paginate : first result will be the one following this node id","required":false,"schema":{"type":"string"}},{"name":"X-Total-Count","in":"header","description":"true if a total count must be returned in response","required":false,"schema":{"type":"boolean","default":false},"example":true}],"responses":{"200":{"description":"The connector nodes list","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConnectorNode"}},"examples":{"LoRa connector node":{"$ref":"swagger/static/examples/dm/connectors/lora_connector_list_response.json"},"SMS connector node":{"$ref":"swagger/static/examples/dm/connectors/sms_connector_list_response.json"},"MQTT connector node":{"$ref":"swagger/static/examples/dm/connectors/mqtt_connector_list_response.json"},"External connector node":{"$ref":"swagger/static/examples/dm/connectors/x_connector_connector_list_response.json"},"LwM2M connector node":{"$ref":"swagger/static/examples/dm/connectors/lwm2m_connector_list_response.json"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/connectors/lora/profiles":{"get":{"tags":["Device management - Connector nodes - LoRa specific"],"summary":"Get LoRa device profile IDs available on your fleet","description":"

(Deprecated) Replaced by the new device profiles API.

\n

Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listLoRaDeviceProfileIds","responses":{"200":{"description":"Return the list of LoRa device profile IDs","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"503":{"description":"In case Lora maintenance mode is enabled","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"deprecated":true}},"/api/v1/deviceMgt/connectors/lora/profiles/manufacturers":{"get":{"tags":["Device management - Connector nodes - LoRa specific"],"summary":"List LoRa device manufacturers","description":"

A device manufacturer represents a vendor that produces LoRa devices.

\n
\n

This endpoint returns the list of available LoRa device manufacturers for your fleet.

\n
\n

Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listLoRaDeviceManufacturers","responses":{"200":{"description":"Return the list of LoRa device manufacturers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LoraDeviceManufacturer"}}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"503":{"description":"In case Lora maintenance mode is enabled","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LoraDeviceManufacturer"}}}}}}}},"/api/v1/deviceMgt/connectors/lora/profiles/details":{"get":{"tags":["Device management - Connector nodes - LoRa specific"],"summary":"List LoRa device profiles","description":"

A device profile defines the interface capabilities and boot parameters that are needed by the network for access service.\nThese information elements shall be provided by the manufacturer.

\n
\n

LoRa device profiles can include details such as:

\n\n

These profiles help manage and identify devices within a LoRa network, ensuring proper communication and functionality.

\n
\n

This endpoint returns the list of available LoRa device profiles for your fleet.

\n
\n

Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listLoRaDeviceProfiles","parameters":[{"name":"manufacturerName","in":"query","description":"Filter by manufacturer name","required":false,"schema":{"type":"string"}},{"name":"ismBand","in":"query","description":"Filter by ISM band","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Return the list of LoRa device profiles with details","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LoraDeviceProfile"}}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"503":{"description":"In case Lora maintenance mode is enabled","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LoraDeviceProfile"}}}}}}}},"/api/v1/deviceMgt/connectors/lora/gateways":{"get":{"tags":["Gateway management for LoRa"],"summary":"List your LoRa gateways","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listLoRaGateways","parameters":[{"name":"size","in":"query","description":"the maximum number of items per page (optional, highest value is 1000)","required":false,"schema":{"type":"integer","format":"int32","default":20}},{"name":"page","in":"query","description":"the requested page number (optional)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"id","in":"query","description":"filtering by identifier (regexp filter) of gateway","required":false,"schema":{"type":"string","default":""},"example":"^(002|0ff)"},{"name":"name","in":"query","description":"filtering by name (regexp filter) of gateway","required":false,"schema":{"type":"string","default":""},"example":".*def.*"},{"name":"status","in":"query","description":"filtering by status of gateway","required":false,"schema":{"type":"string","default":""},"example":"ONLINE"},{"name":"manufacturer","in":"query","description":"filtering by manufacturer of gateway","required":false,"schema":{"type":"string","default":""},"example":"Kerlink"},{"name":"model","in":"query","description":"filtering by model of gateway","required":false,"schema":{"type":"string","default":""},"example":"Warbler"}],"responses":{"200":{"description":"Return a list of LoRa gateways","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageableLoraGatewayInfo"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"401":{"description":"Unauthorized. Please check your API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/deviceMgt/connectors/lora/connectivities":{"get":{"tags":["Device management - Connector nodes - LoRa specific"],"summary":"List LoRa connectivity plans available for your fleet","description":"

A connectivity plan defines the interface capabilities and parameters that are needed by the network for access service.\nThese information elements shall be provided by the manufacturer.

\n
\n

In case there is at least one inconsistency between your provided list of parameters of connectivity and your \"lora\" offer settings, then\nno result will be returned by this service. Else the content of the result matches provided parameters (case insensitive).

\n

Depending on your \"lora\" offer settings, test connectivity plans can be excluded from the result.

\n
\n

Available parameters:\n

\n

\n

Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"listLoRaConnectivityPlans","parameters":[{"name":"parameters","in":"query","description":"List of parameters for the connectivity plan","required":false,"schema":{"type":"object","additionalProperties":{}},"example":{"name":"my_connectivity_plan","parameters.location":false}}],"responses":{"200":{"description":"List of LoRa connectivity plans","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LoraNetworkSubscriptionDetail"}}}}},"503":{"description":"In case Lora maintenance mode is enabled","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LoraNetworkSubscriptionDetail"}}}}}}}},"/api/v1/deviceMgt/commands/{commandId}":{"get":{"tags":["Device management - Commands"],"summary":"Get a specific command by its identifier. A command is an instruction sent to a device, telling it to perform a specific action, change a configuration parameter, or report information.","description":"Restricted to API keys with at least one of the following roles: DEVICE_R.","operationId":"getCommandV1","parameters":[{"name":"commandId","in":"path","description":"identifier of specific command. Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The command","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command"},"examples":{"LoRa command":{"$ref":"swagger/static/examples/dm/commands/lora_command_response.json"},"MQTT command":{"$ref":"swagger/static/examples/dm/commands/mqtt_command_response.json"},"SMS command":{"$ref":"swagger/static/examples/dm/commands/sms_command_response.json"},"External interface command":{"$ref":"swagger/static/examples/dm/commands/x_connector_command_response.json"}}}}},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Command not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}},"delete":{"tags":["Device management - Commands"],"summary":"Delete a specific command by its identifier. A command is an instruction sent to a device, telling it to perform a specific action, change a configuration parameter, or report information.","description":"Restricted to API keys with at least one of the following roles: DEVICE_W.","operationId":"deleteCommandV1","parameters":[{"name":"commandId","in":"path","description":"identifier of specific command. Expected identifier (max 24 characters)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Command deleted"},"403":{"description":"Request forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}},"404":{"description":"Command not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebErrorResponse"}}}}}}},"/api/v1/device-analytics/rules/{ruleId}/device-analyses/statistics/days/{day}":{"get":{"tags":["Device Analytics"],"summary":"Retrieve the DeviceAnalysisStats for an AnalyticsRule and day BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"Return the list of the fleet's devices statistical analysis, with their communication rate, the status and quality of their connectivity...

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getDevicesAnalysisStats","parameters":[{"name":"ruleId","in":"path","description":"id of the AnalyticsRule","required":true,"schema":{"type":"string"}},{"name":"day","in":"path","description":"day with 'YYYY-MM-DD' format","required":true,"schema":{"type":"string"}},{"name":"bookmarkId","in":"query","description":"deviceId as page bookmark (deviceId of last page of results)","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"page size, value is limited to :1000","required":false,"schema":{"type":"string","default":"1000"}}],"responses":{"200":{"description":"array of DeviceAnalysisStats matching the request.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAnalysisStats"}}}}}}}},"/api/v1/device-analytics/rules/{ruleId}/device-analyses/statistics/days/{day}/devices/{deviceId}":{"get":{"tags":["Device Analytics"],"summary":"Retrieve the DeviceAnalysisStats for a specific AnalyticsRule, day and deviceId BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"This daily device statistical analysis includes details regarding its communication rate, the quality of its connectivity...

Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getDeviceAnalysisStats","parameters":[{"name":"ruleId","in":"path","description":"id of the AnalyticsRule","required":true,"schema":{"type":"string"}},{"name":"day","in":"path","description":"day with 'YYYY-MM-DD' format","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"path","description":"deviceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"DeviceAnalysisStats matching the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceAnalysisStats"}}}}}}},"/api/v1/device-analytics/rules/{ruleId}/device-analyses/flattened":{"get":{"tags":["Device Analytics"],"summary":"Retrieve the latest flattened human readable DeviceAnalysisResult for an AnalyticsRule BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getFlattenedDevicesAnalysisResult","parameters":[{"name":"ruleId","in":"path","description":"id of the AnalyticsRule","required":true,"schema":{"type":"string"}},{"name":"bookmarkId","in":"query","description":"deviceId as page bookmark (deviceId of last page of results)","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"page size, value is limited to :1000","required":false,"schema":{"type":"string","default":"1000"}}],"responses":{"200":{"description":"array of FlattenedDeviceAnalysisResult matching the request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FlattenedDeviceAnalysisResult"}}}}}}}},"/api/v1/device-analytics/rules/{ruleId}/device-analyses/classifications/regular-patterns/devices":{"get":{"tags":["Device Analytics"],"summary":"Retrieve the latest regular pattern classification for all devices of an AnalyticsRule BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getDevicesRegularPatternClassification","parameters":[{"name":"ruleId","in":"path","description":"id of the AnalyticsRule","required":true,"schema":{"type":"string"}},{"name":"bookmarkId","in":"query","description":"deviceId as page bookmark (deviceId of last page of results)","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"page size, value is limited to :1000","required":false,"schema":{"type":"string","default":"1000"}}],"responses":{"200":{"description":"array of DeviceAnalysisRegularPattern matching the request.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAnalysisRegularPattern"}}}}}}}},"/api/v1/device-analytics/rules/{ruleId}/device-analyses/classifications/regular-patterns/devices/{deviceId}":{"get":{"tags":["Device Analytics"],"summary":"Retrieve the latest regular pattern classification for a specific device BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getDeviceRegularPatternClassification","parameters":[{"name":"ruleId","in":"path","description":"id of the AnalyticsRule","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"path","description":"deviceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"DeviceAnalysisRegularPattern matching the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceAnalysisRegularPattern"}}}}}}},"/api/v1/device-analytics/rules/{ruleId}/device-analyses/classifications/clusters/devices":{"get":{"tags":["Device Analytics"],"summary":"Retrieve the latest cluster classification for all devices of an AnalyticsRule BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getDevicesClusterClassification","parameters":[{"name":"ruleId","in":"path","description":"id of the AnalyticsRule","required":true,"schema":{"type":"string"}},{"name":"bookmarkId","in":"query","description":"deviceId as page bookmark (deviceId of last page of results)","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"page size, value is limited to :1000","required":false,"schema":{"type":"string","default":"1000"}}],"responses":{"200":{"description":"array of DeviceAnalysisClusterClassification matching the request.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAnalysisClusterClassification"}}}}}}}},"/api/v1/device-analytics/rules/{ruleId}/device-analyses/classifications/clusters/devices/{deviceId}":{"get":{"tags":["Device Analytics"],"summary":"Retrieve the latest cluster classification for a specific device BETA - please note that the API is currently in beta state, and therefore still subject to breaking changes.","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getDeviceClusterClassification","parameters":[{"name":"ruleId","in":"path","description":"id of the AnalyticsRule","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"path","description":"deviceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"DeviceAnalysisClusterClassification matching the request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceAnalysisClusterClassification"}}}}}}},"/api/v1/bootstrap/lwm2m/masterEntries/{masterEntryId}":{"get":{"tags":["Bootstrap Master Entry"],"summary":"Get a LwM2M bootstrap master entry from its id.","description":"Restricted to API keys with at least one of the following roles: BOOTSTRAP_R.","operationId":"getBootstrapMasterEntry","parameters":[{"name":"masterEntryId","in":"path","description":"the master entry id","required":true,"schema":{"type":"string"}},{"name":"showSecuritySecrets","in":"query","description":"whether or not to show the secrets","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapMasterEntry"}}}}}},"delete":{"tags":["Bootstrap Master Entry"],"summary":"Delete a LwM2M bootstrap master entry from its id.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"deleteBootstrapMasterEntry","parameters":[{"name":"masterEntryId","in":"path","description":"the master entry to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"}}}},"/api/v1/bootstrap/lwm2m/entries/{endpointName}":{"get":{"tags":["Bootstrap Entry"],"summary":"Get a lwm2m bootstrap entry from its endpointName.","description":"Restricted to API keys with at least one of the following roles: BOOTSTRAP_R.","operationId":"getBootstrapEntry","parameters":[{"name":"endpointName","in":"path","description":"the endpoint client name","required":true,"schema":{"type":"string"},"example":"urn:imei:000000000000000"},{"name":"showSecuritySecrets","in":"query","description":"whether or not to show the secrets used to authenticate to the LwM2M Run server","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapEntry"}}}}}},"delete":{"tags":["Bootstrap Entry"],"summary":"Delete a lwm2m bootstrap entry from its endpointName.","description":"Usage of this API will be reported in your access log under 'bootstrap' category.

Restricted to API keys with at least one of the following roles: BOOTSTRAP_W.","operationId":"deleteBootstrapEntry","parameters":[{"name":"endpointName","in":"path","description":"the endpoint client name for which the entry will be deleted","required":true,"schema":{"type":"string"},"example":"urn:imei:000000000000000"}],"responses":{"204":{"description":"No Content"}}}},"/api/v1/alarms/rules/types/{type}/default":{"get":{"tags":["Alarm rules"],"summary":"Retrieve default AlarmRules for a type.","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"getDefaultAlarmRules","parameters":[{"name":"type","in":"path","description":"the type of the default AlarmRules to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"list of AlarmRules","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlarmRule"}}}}},"404":{"description":"Unknown type","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlarmRule"}}}}}}}},"/api/v1/alarms/rules/supportedValues":{"get":{"tags":["Alarm rules"],"summary":"Retrieve AlarmRules supported values.","description":"Restricted to API keys with at least one of the following roles: DATA_PROCESSING_R.","operationId":"listAlarmRulesSupportedValues","responses":{"200":{"description":"list of AlarmRules supported values","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AlarmRuleSupportedValues"}}}}}}}},"/api/v1/accounting/monthly":{"get":{"tags":["Accounting - V1"],"summary":"Get monthly accounting metrics.","description":"

Get accounting metrics for a given period (up to 18 months). The data is aggregated by months.

\n

The response contains 2 main sections : tenant and months.

\n

The tenant section gives useful information related to the customer. It returns the current values, whatever has been specified in startMonth and endMonth parameters :

\n\n


The months section provides connectors and service metrics for each month.

\n