Create data delivery rule

post

https://api.sensos.io/v1/accounts/{accountId}/data-delivery-rules

Create a data delivery rule. The rule applies to every device in the account. Unless status is Disabled, Sensos starts delivering data that matches the rule's dataSourceType to the configured HTTP endpoint. The new rule takes effect within about 15 minutes.

Returns the created rule; the Location header contains its id.

Path Params

accountId

string

required

Unique identifier of the Sensos account.

Body Params

The data delivery rule to create.

A data delivery rule. Rules apply to every device in the account.

name

string

required

Descriptive name for the rule.

description

string

Optional human-readable description of the rule's purpose.

status

string

enum

Defaults to Enabled

Whether the rule delivers data. Defaults to Enabled when omitted.

Allowed:

dataSourceType

string

enum

required

Type of data the rule delivers. Payload formats:

DeviceReport: Device reports
TemperatureLogging: Temperature logging
HumidityLogging: Humidity logging
Alert: Alerts

Allowed:

skipNoLocationReports

boolean

Applies only to DeviceReport rules. When true, device reports without a location fix are not delivered.

action

object

required

HTTP delivery action. Sensos sends each payload to url using method. Failed deliveries are retried as described in the retry policy.

Responses

401

The access token is missing, invalid or expired. Returned by the gateway with an empty body.

403

The caller has no permission for this operation or account. Returned by the gateway with an empty body.

201Data delivery rule created.

400The request is invalid. Rule validation errors (for example a missing name, dataSourceType, action.url or an invalid secretKey length) and an invalid cursor return {"error": "<message>"}. Malformed JSON or invalid values for typed fields return a validation problem details body.