Astarte Interfaces

io.edgehog.devicemanager.BaseImage v0.1

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /fingerprint with string type. OS bundle release identification code
• /name with string type. Name of the bundle
• /version with string type. Version of the bundle
• /buildId with string type. Human readable build identifier. Examples are [date][time] or [date]-[time]-[git-commit]

/fingerprint

OS bundle release identification code

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

/name

Name of the bundle

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

/version

Version of the bundle

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

/buildId

Human readable build identifier. Examples are [date][time] or [date]-[time]-[git-commit]

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

io.edgehog.devicemanager.BatteryStatus v0.1

About

This interface is of type datastream and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization.

Data gets sent with an object aggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message.

Mappings

The interface has the following mappings:

• /%{battery_slot}/levelPercentage with double type. Battery level estimated percentage [0.0%-100.0%]
• /%{battery_slot}/levelAbsoluteError with double type. Battery level measurement absolute error [0.0-100.0]
• /%{battery_slot}/status with string type. Battery status string, any of: Charging, Discharging, Idle, EitherIdleOrCharging, Failure, Removed, Unknown

/%{battery_slot}/levelPercentage

Battery level estimated percentage [0.0%-100.0%]

This endpoint accepts values of type double: a double-precision floating-point number as specified by binary64, by the IEEE 754 standard.

The endpoint is parametric and battery_slot can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{battery_slot}/levelAbsoluteError

Battery level measurement absolute error [0.0-100.0]

This endpoint accepts values of type double: a double-precision floating-point number as specified by binary64, by the IEEE 754 standard.

The endpoint is parametric and battery_slot can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{battery_slot}/status

Battery status string, any of: Charging, Discharging, Idle, EitherIdleOrCharging, Failure, Removed, Unknown

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and battery_slot can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

io.edgehog.devicemanager.CellularConnectionProperties v0.1

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /%{id}/apn with string type. Operator apn address.
• /%{id}/imei with string type. The modem IMEI code of the device.
• /%{id}/imsi with string type. The SIM IMSI code of the device.

/%{id}/apn

Operator apn address.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

/%{id}/imei

The modem IMEI code of the device.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

/%{id}/imsi

The SIM IMSI code of the device.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

io.edgehog.devicemanager.CellularConnectionStatus v0.1

About

This interface is of type datastream and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization.

Data gets sent with an object aggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message.

Mappings

The interface has the following mappings:

• /%{id}/carrier with string type. Connectivity carrier operator name.
• /%{id}/cellId with longinteger type. The Cell ID in hexadecimal format, either 16 bit for 2G or 28 bit for 3G or 4G.
• /%{id}/mobileCountryCode with integer type. The mobile country code (MCC) for the device's home network. Valid range: 0–999.
• /%{id}/mobileNetworkCode with integer type. The Mobile Network Code for the device's home network. This is the MNC for GSM, WCDMA, LTE and NR. CDMA uses the System ID (SID). Valid range for MNC: 0–999. Valid range for SID: 0–32767.
• /%{id}/localAreaCode with integer type. Two byte location area code in hexadecimal format.
• /%{id}/registrationStatus with string type. GSM/LTE registration status. Possible values: [NotRegistered, Registered, SearchingOperator, RegistrationDenied, Unknown, RegisteredRoaming]
• /%{id}/rssi with double type. Signal strength of the device in dBm.
• /%{id}/technology with string type. Access Technology. Possible values [GSM, GSMCompact, UTRAN, GSMwEGPRS, UTRANwHSDPA, UTRANwHSUPA, UTRANwHSDPAandHSUPA, EUTRAN]

/%{id}/carrier

Connectivity carrier operator name.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/cellId

The Cell ID in hexadecimal format, either 16 bit for 2G or 28 bit for 3G or 4G.

This endpoint accepts values of type longinteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.).

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/mobileCountryCode

The mobile country code (MCC) for the device's home network. Valid range: 0–999.

This endpoint accepts values of type integer: a signed 32 bit integer.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/mobileNetworkCode

The Mobile Network Code for the device's home network. This is the MNC for GSM, WCDMA, LTE and NR. CDMA uses the System ID (SID). Valid range for MNC: 0–999. Valid range for SID: 0–32767.

This endpoint accepts values of type integer: a signed 32 bit integer.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/localAreaCode

Two byte location area code in hexadecimal format.

This endpoint accepts values of type integer: a signed 32 bit integer.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/registrationStatus

GSM/LTE registration status. Possible values: [NotRegistered, Registered, SearchingOperator, RegistrationDenied, Unknown, RegisteredRoaming]

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/rssi

Signal strength of the device in dBm.

This endpoint accepts values of type double: a double-precision floating-point number as specified by binary64, by the IEEE 754 standard.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/technology

Access Technology. Possible values [GSM, GSMCompact, UTRAN, GSMwEGPRS, UTRANwHSDPA, UTRANwHSUPA, UTRANwHSDPAandHSUPA, EUTRAN]

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

io.edgehog.devicemanager.Commands v0.1

About

This interface is of type datastream and is owned by the server, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization.

Data gets sent with an individual aggregation. Each mapping is treated as an independent value and is managed individually.

Mappings

The interface has the following mappings:

• /request with string type. Command request. Possible values ['Reboot']

/request

Command request. Possible values ['Reboot']

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when it has been received exactly once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it.

io.edgehog.devicemanager.ForwarderSessionRequest v0.1

Configuration to open a session with the Edgehog Forwarder from a device to a certain host.

About

This interface is of type datastream and is owned by the server, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization.

Data gets sent with an object aggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message.

Mappings

The interface has the following mappings:

• /request/session_token with string type. The session token thanks to which the device can authenticates itself through Edgehog.
• /request/port with integer type. The host port the device must connect to.
• /request/host with string type. The IP address or host name the device must connect to.
• /request/secure with boolean type. Indicates whether the connection should use TLS, i.e. 'ws' or 'wss' scheme.

/request/session_token

The session token thanks to which the device can authenticates itself through Edgehog.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/request/port

The host port the device must connect to.

This endpoint accepts values of type integer: a signed 32 bit integer.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/request/host

The IP address or host name the device must connect to.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/request/secure

Indicates whether the connection should use TLS, i.e. 'ws' or 'wss' scheme.

This endpoint accepts values of type boolean: either true or false, adhering to JSON boolean type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

io.edgehog.devicemanager.ForwarderSessionState v0.1

Information provided by the device about the status of a forwarder session.

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /%{session_token}/status with string type. Indicates if the device is connecting, or connected to a forwarder session.

/%{session_token}/status

Indicates if the device is connecting, or connected to a forwarder session.

An enum with the following possible values: Connecting | Connected.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and session_token can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

io.edgehog.devicemanager.Geolocation v0.1

Generic Geolocation sampled data.

Geolocation allows geolocation sensors to stream location data, such as GPS data. Values availability depends on what sensors are present on devices and what measurement systems are in use. The id represents a unique identifier for an individual sensor.

About

This interface is of type datastream and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization.

Data gets sent with an object aggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message.

Mappings

The interface has the following mappings:

• /%{id}/latitude with double type. Sampled latitude value.
• /%{id}/longitude with double type. Sampled longitude value.
• /%{id}/altitude with double type. Sampled altitude value.
• /%{id}/accuracy with double type. Sampled accuracy of the latitude and longitude properties.
• /%{id}/altitudeAccuracy with double type. Sampled accuracy of the altitude property.
• /%{id}/heading with double type. Sampled value representing the direction towards which the device is facing.
• /%{id}/speed with double type. Sampled value representing the velocity of the device.

/%{id}/latitude

Sampled latitude value.

This endpoint accepts values of type double: a double-precision floating-point number as specified by binary64, by the IEEE 754 standard.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/longitude

Sampled longitude value.

This endpoint accepts values of type double: a double-precision floating-point number as specified by binary64, by the IEEE 754 standard.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/altitude

Sampled altitude value.

This endpoint accepts values of type double: a double-precision floating-point number as specified by binary64, by the IEEE 754 standard.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/accuracy

Sampled accuracy of the latitude and longitude properties.

This endpoint accepts values of type double: a double-precision floating-point number as specified by binary64, by the IEEE 754 standard.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/altitudeAccuracy

Sampled accuracy of the altitude property.

This endpoint accepts values of type double: a double-precision floating-point number as specified by binary64, by the IEEE 754 standard.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/heading

Sampled value representing the direction towards which the device is facing.

This endpoint accepts values of type double: a double-precision floating-point number as specified by binary64, by the IEEE 754 standard.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{id}/speed

Sampled value representing the velocity of the device.

This endpoint accepts values of type double: a double-precision floating-point number as specified by binary64, by the IEEE 754 standard.

The endpoint is parametric and id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

io.edgehog.devicemanager.HardwareInfo v0.1

General hardware capabilities

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /cpu/architecture with string type. CPU Architecture
• /cpu/model with string type. CPU Model Code
• /cpu/modelName with string type. CPU Model Display Name
• /cpu/vendor with string type. CPU Vendor
• /mem/totalBytes with longinteger type. Total RAM quantity (Bytes)

/cpu/architecture

CPU Architecture

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

/cpu/model

CPU Model Code

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

/cpu/modelName

CPU Model Display Name

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

/cpu/vendor

CPU Vendor

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

/mem/totalBytes

Total RAM quantity (Bytes)

This endpoint accepts values of type longinteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.).

The value of the property cannot be unset.

io.edgehog.devicemanager.LedBehavior v0.1

About

This interface is of type datastream and is owned by the server, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization.

Data gets sent with an individual aggregation. Each mapping is treated as an independent value and is managed individually.

Mappings

The interface has the following mappings:

• /%{led_id}/behavior with string type. Enum describing the behavior of the given led. Possible values: [Blink60Seconds | DoubleBlink60Seconds | SlowBlink60Seconds]

/%{led_id}/behavior

Enum describing the behavior of the given led. Possible values: [Blink60Seconds | DoubleBlink60Seconds | SlowBlink60Seconds]

Blink60Seconds: Blinking DoubleBlink60Seconds: Double blinking SlowBlink60Seconds: Slow blinking

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and led_id can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received exactly once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

io.edgehog.devicemanager.NetworkInterfaceProperties v0.1

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /%{iface_name}/macAddress with string type. Normalized physical address. Example value is "00:aa:bb:cc:dd:ee" (always lower case)
• /%{iface_name}/technologyType with string type. Connection technology. Possible values: [Ethernet, Bluetooth, Cellular, WiFi]

/%{iface_name}/macAddress

Normalized physical address. Example value is "00:aa:bb:cc:dd:ee" (always lower case)

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and iface_name can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

/%{iface_name}/technologyType

Connection technology. Possible values: [Ethernet, Bluetooth, Cellular, WiFi]

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and iface_name can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

io.edgehog.devicemanager.OSInfo v0.1

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /osName with string type. Name of the Operating System
• /osVersion with string type. Version of the Operating System

/osName

Name of the Operating System

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

/osVersion

Version of the Operating System

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

io.edgehog.devicemanager.OTAEvent v0.1

OTA Events sampled data.

Allows to stream OTA Events data, including OTA Update status, its progress, code and internal message.

About

This interface is of type datastream and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization.

Data gets sent with an object aggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message.

Mappings

The interface has the following mappings:

• /event/requestUUID with string type. OTA Request identifier.
• /event/status with string type. OTA Update status.
• /event/statusProgress with integer type. Current OTA Update status progress percentage [0%-100%].
• /event/statusCode with string type. Status code expands OTA Update status with additional information.
• /event/message with string type. Contains internal message for status code or empty string otherwise.

/event/requestUUID

OTA Request identifier.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when it has been received exactly once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/event/status

OTA Update status.

Value is one of the following strings:

• Acknowledged: the device received an OTA Request.
• Downloading: an update is in the process of downloading.
• Deploying: an update is in the process of deploying.
• Deployed: an update deployed on the device.
• Rebooting: the device is in the process of rebooting.
• Success: an update succeeded. This is a final status of OTA Update.
• Error: an error happened during the update. Also this status can be used to notify about handled errors.
• Failure: an update failed. This is a final status of OTA Update.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when it has been received exactly once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/event/statusProgress

Current OTA Update status progress percentage [0%-100%].

Every OTA Update status has own progress that starts from 0 and ends at 100, for example (pairs of "status, progress"): "Downloading, 0", "Downloading, 50", "Downloading, 100", "Deploying, 10", etc.

This endpoint accepts values of type integer: a signed 32 bit integer.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when it has been received exactly once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/event/statusCode

Status code expands OTA Update status with additional information.

Some common status codes are:

• InvalidRequest: an update request contains incorrect data.
• UpdateAlreadyInProgress: another update is currently in progress.
• NetworkError: a network error happened during the update.
• IOError: a filesystem error happened during the update.
• InternalError: an internal error happened during the update.
• InvalidBaseImage: an update failed to apply due to an invalid base image.
• SystemRollback: a system rollback has occurred.
• Canceled: an update was canceled.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when it has been received exactly once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/event/message

Contains internal message for status code or empty string otherwise.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when it has been received exactly once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

io.edgehog.devicemanager.OTARequest v1.0

About

This interface is of type datastream and is owned by the server, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization.

Data gets sent with an object aggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message.

Mappings

The interface has the following mappings:

• /request/operation with string type. OTA Request operation
• /request/url with string type. File URL
• /request/uuid with string type. Request identifier

/request/operation

OTA Request operation

Value is one of the following strings:

• Update: push an OTA update operation.
• Cancel: cancel an OTA update if it can still be cancelled.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/request/url

File URL

If the operation is Update, this will contain the URL that can be used to download the Update. If the operation is Cancel, this will be an empty string. Note that the URL will be valid only until the OTA update is active (i.e. it didn't reach a Failure or Success state), after that it's possible that the URL can become invalid.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/request/uuid

Request identifier

A UUID that uniquely identifies the OTA request. It must be stored when receiving an Update operation so that it can be matched against in case a Cancel operation is received.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

io.edgehog.devicemanager.RuntimeInfo v0.1

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /name with string type. Name of the Edgehog runtime. Example value: edgehog-esp32-device
• /url with string type. URL that uniquely identifies the Edgehog Edgehog runtime implementation. Example value: https://github.com/edgehog-device-manager/edgehog-esp32-device.
• /version with string type. Version of the Edgehog runtime. Example value: 0.5
• /environment with string type. Environment of the Edgehog runtime. Example value: esp-idf VERSION, Rust 1.58 or Java 8

/name

Name of the Edgehog runtime. Example value: edgehog-esp32-device

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

/url

URL that uniquely identifies the Edgehog Edgehog runtime implementation. Example value: https://github.com/edgehog-device-manager/edgehog-esp32-device.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

/version

Version of the Edgehog runtime. Example value: 0.5

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

/environment

Environment of the Edgehog runtime. Example value: esp-idf VERSION, Rust 1.58 or Java 8

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

io.edgehog.devicemanager.StorageUsage v1.0

About

This interface is of type datastream and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization.

Data gets sent with an object aggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message.

Mappings

The interface has the following mappings:

• /%{storageId}/mounts with stringarray type. Optional path mounted on the device
• /%{storageId}/name with string type. Optional name of the storage
• /%{storageId}/fstype with string type. Optional filesystem of the storage
• /%{storageId}/kind with string type. Optional kind of storage
• /%{storageId}/totalBytes with longinteger type. Total storage size in bytes
• /%{storageId}/freeBytes with longinteger type. Available storage bytes

/%{storageId}/mounts

Optional path mounted on the device

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint is parametric and storageId can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{storageId}/name

Optional name of the storage

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and storageId can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{storageId}/fstype

Optional filesystem of the storage

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and storageId can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{storageId}/kind

Optional kind of storage

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and storageId can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{storageId}/totalBytes

Total storage size in bytes

This endpoint accepts values of type longinteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.).

The endpoint is parametric and storageId can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/%{storageId}/freeBytes

Available storage bytes

This endpoint accepts values of type longinteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.).

The endpoint is parametric and storageId can be replaced with any valid string to send data on specialized paths.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

io.edgehog.devicemanager.SystemInfo v0.1

Information about the system

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /serialNumber with string type. The serial number of the system
• /partNumber with string type. The part number of the system

/serialNumber

The serial number of the system

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

/partNumber

The part number of the system

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The value of the property cannot be unset.

io.edgehog.devicemanager.SystemStatus v0.1

About

This interface is of type datastream and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization.

Data gets sent with an object aggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message.

Mappings

The interface has the following mappings:

• /systemStatus/availMemoryBytes with longinteger type. Available memory (Bytes)
• /systemStatus/bootId with string type. UUID representing the Boot Id
• /systemStatus/taskCount with integer type. Number of running tasks or processes
• /systemStatus/uptimeMillis with longinteger type. Get time in milliseconds since boot

/systemStatus/availMemoryBytes

Available memory (Bytes)

This endpoint accepts values of type longinteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.).

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/systemStatus/bootId

UUID representing the Boot Id

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/systemStatus/taskCount

Number of running tasks or processes

This endpoint accepts values of type integer: a signed 32 bit integer.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/systemStatus/uptimeMillis

Get time in milliseconds since boot

This endpoint accepts values of type longinteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.).

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

io.edgehog.devicemanager.WiFiScanResults v0.2

About

This interface is of type datastream and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization.

Data gets sent with an object aggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message.

Mappings

The interface has the following mappings:

• /ap/channel with integer type. The channel over which the client is communicating with the access point.
• /ap/connected with boolean type. Identifies if the device is connected to this Access Point
• /ap/essid with string type. Extended Service Set Identification of the current AP, empty string if the AP is hidden.
• /ap/macAddress with string type. Lower case mac address string formatted like de:ad:be:ff:11:22.
• /ap/rssi with integer type. The current signal strength measured in dBm.

/ap/channel

The channel over which the client is communicating with the access point.

The channel represents one of the ranges into which the reference frequency is divided and it's identified by an integer number in the range 1 - 165, depending on the frequency itself and the region.

This endpoint accepts values of type integer: a signed 32 bit integer.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/ap/connected

Identifies if the device is connected to this Access Point

This endpoint accepts values of type boolean: either true or false, adhering to JSON boolean type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/ap/essid

Extended Service Set Identification of the current AP, empty string if the AP is hidden.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/ap/macAddress

Lower case mac address string formatted like de:ad:be:ff:11:22.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

/ap/rssi

The current signal strength measured in dBm.

This endpoint accepts values of type integer: a signed 32 bit integer.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 5184000 seconds before it is erased from the database.

io.edgehog.devicemanager.apps.AvailableContainers v0.1

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /%{container_id}/status with string type. Container status

/%{container_id}/status

Container status

Possible values [Received, Created, Running, Stopped]

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and container_id can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

io.edgehog.devicemanager.apps.AvailableDeployments v0.1

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /%{deployment_id}/status with string type. Status of the deployment

/%{deployment_id}/status

Status of the deployment

Possible values: [Stopped, Started]

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint is parametric and deployment_id can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

io.edgehog.devicemanager.apps.AvailableDeviceMappings v0.1

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /%{device_mapping_id}/present with boolean type. The device is present on the host

/%{device_mapping_id}/present

The device is present on the host

This endpoint accepts values of type boolean: either true or false, adhering to JSON boolean type.

The endpoint is parametric and device_mapping_id can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

io.edgehog.devicemanager.apps.AvailableDeviceRequests v0.1

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /%{device_id}/present with boolean type. The device request is present on the host

/%{device_id}/present

The device request is present on the host

This endpoint accepts values of type boolean: either true or false, adhering to JSON boolean type.

The endpoint is parametric and device_id can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

io.edgehog.devicemanager.apps.AvailableEnvFiles v0.1

The available env files.

Exposes the environment files available on the device.

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /%{env_file_id}/present with boolean type. Env file availability

/%{env_file_id}/present

Env file availability

States whether the environment file with ID env_file_id is present on the device.

This endpoint accepts values of type boolean: either true or false, adhering to JSON boolean type.

The endpoint is parametric and env_file_id can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

io.edgehog.devicemanager.apps.AvailableFileBinds v0.1

The available file bind.

Exposes the file binds available on the device

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /%{bind_id}/present with boolean type. The file bind availability.

/%{bind_id}/present

The file bind availability.

States whether the file bind with ID bind_id is available on the device.

This endpoint accepts values of type boolean: either true or false, adhering to JSON boolean type.

The endpoint is parametric and bind_id can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

io.edgehog.devicemanager.apps.AvailableImages v0.1

Properties available for a specific Docker image on the device

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /%{image_id}/pulled with boolean type. Pulled image

/%{image_id}/pulled

Pulled image

This endpoint accepts values of type boolean: either true or false, adhering to JSON boolean type.

The endpoint is parametric and image_id can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

io.edgehog.devicemanager.apps.AvailableNetworks v0.1

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /%{network_id}/created with boolean type. Network was created

/%{network_id}/created

Network was created

This endpoint accepts values of type boolean: either true or false, adhering to JSON boolean type.

The endpoint is parametric and network_id can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

io.edgehog.devicemanager.apps.AvailableVolumes v0.1

About

This interface is of type properties and is owned by the device, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping.

Mappings

The interface has the following mappings:

• /%{volume_id}/created with boolean type. Volume created

/%{volume_id}/created

Volume created

This endpoint accepts values of type boolean: either true or false, adhering to JSON boolean type.

The endpoint is parametric and volume_id can be replaced with any valid string to send data on specialized paths.

The value of the property can be unset.

io.edgehog.devicemanager.apps.CreateContainerRequest v1.1

About

This interface is of type datastream and is owned by the server, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization.

Data gets sent with an object aggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message.

Mappings

The interface has the following mappings:

• /container/id with string type. Create Container Request id
• /container/deploymentId with string type. Reference to a Deployment using the container
• /container/imageId with string type. Container image id
• /container/networkIds with stringarray type. Container network ids
• /container/volumeIds with stringarray type. Container volume ids
• /container/deviceMappingIds with stringarray type. Container device mappings ids
• /container/deviceRequestIds with stringarray type. Container device request ids
• /container/fileBindIds with stringarray type. File bind ids
• /container/envFileIds with stringarray type. Env file ids
• /container/hostname with string type. Container hostname
• /container/domainname with string type. Container hostname
• /container/user with string type. Run as this user inside the container
• /container/cmd with stringarray type. Command to run specified as array of strings
• /container/healthcheckTest with stringarray type. A test to perform to check that the container is healthy.
• /container/healthcheckInterval with longinteger type. The time to wait before considering the check to have hung.
• /container/healthcheckTimeout with longinteger type. The time to wait between checks in nanoseconds.
• /container/healthcheckRetries with integer type. The number of consecutive failures needed to consider a container as unhealthy.
• /container/healthcheckStartPeriod with longinteger type. Start period for the container to initialize before starting health-retries countdown in nanoseconds.
• /container/healthcheckStartInterval with longinteger type. The time to wait between checks in nanoseconds during the start period.
• /container/workingDir with string type. The working directory for commands to run in.
• /container/entrypoint with stringarray type. The entry point for the container.
• /container/networkDisabled with boolean type. Disable networking for the container.
• /container/labelsKeys with stringarray type. User-defined key/value metadata.
• /container/labelsValues with stringarray type. User-defined key/value metadata.
• /container/stopSignal with string type. Signal to stop a container
• /container/stopTimeout with integer type. Timeout to stop a container in seconds.
• /container/restartPolicy with string type. Container restart policy
• /container/restartPolicyMaximumRetryCount with integer type. If on-failure is used, the number of times to retry before giving up.
• /container/env with stringarray type. Container environment
• /container/binds with stringarray type. Container binds
• /container/networkMode with string type. Network mode used for this container.
• /container/portBindings with stringarray type. Container port bindings
• /container/exposedPorts with stringarray type. Container exposed ports
• /container/extraHosts with stringarray type. List of hostname/IP to add to the container's /etc/hosts
• /container/capAdd with stringarray type. A list of kernel capabilities to add to the container.
• /container/capDrop with stringarray type. A list of kernel capabilities to drop from the container.
• /container/cpuShares with integer type. An integer value representing this container's relative CPU weight versus other containers.
• /container/cpusetCpus with string type. CPUs in which to allow execution (e.g., 0-3, 0,1).
• /container/cpuPeriod with longinteger type. The length of a CPU period in microseconds.
• /container/cpuQuota with longinteger type. Microseconds of CPU time that the container can get in a CPU period.
• /container/cpuRealtimePeriod with longinteger type. The length of a CPU real-time period in microseconds.
• /container/cpuRealtimeRuntime with longinteger type. The length of a CPU real-time runtime in microseconds.
• /container/memory with longinteger type. Memory limit in bytes.
• /container/memoryReservation with longinteger type. Memory soft limit in bytes. Default to 0 for unlimited.
• /container/memorySwap with longinteger type. Total memory limit (memory + swap).
• /container/memorySwappiness with integer type. Memory swappiness
• /container/deviceCgroupRules with stringarray type. A list of cgroup rules to apply to the container
• /container/ulimitsName with stringarray type. A list of resource limits to set in the container.
• /container/ulimitsSoft with integerarray type. A list of resource limits to set in the container.
• /container/ulimitsHard with integerarray type. A list of resource limits to set in the container.
• /container/autoRemove with boolean type. Automatically remove the container when the container's process exits.
• /container/volumeDriver with string type. Driver that this container uses to mount volumes.
• /container/storageOptKeys with stringarray type. Storage driver options for this container.
• /container/storageOptValues with stringarray type. Storage driver options for this container.
• /container/readOnlyRootfs with boolean type. Mount the container's root filesystem as read only.
• /container/tmpfsPaths with stringarray type. A map of container directories which should be replaced by tmpfs mounts.
• /container/tmpfsOptions with stringarray type. A map of container directories which should be replaced by tmpfs mounts.
• /container/cgroupnsMode with string type. cgroup namespace mode for the container.
• /container/dns with stringarray type. A list of DNS servers for the container to use.
• /container/dnsOptions with stringarray type. A list of DNS options.
• /container/dnsSearch with stringarray type. A list of DNS search domains.
• /container/groupAdd with stringarray type. A list of additional groups that the container process will run as.
• /container/ipcMode with string type. IPC sharing mode for the container.
• /container/oomScoreAdj with integer type. An integer value containing the score given to the container in order to tune OOM killer preferences.
• /container/usernsMode with string type. Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
• /container/sysctlsKeys with stringarray type. A list of kernel parameters (sysctls) to set in the container.
• /container/sysctlsValues with stringarray type. A list of kernel parameters (sysctls) to set in the container.
• /container/shmSize with longinteger type. Size of /dev/shm in bytes.
• /container/runtime with string type. Runtime to use with this container.
• /container/privileged with boolean type. Run privileged
• /container/logType with string type. The logging configuration for this container
• /container/logConfigKeys with stringarray type. Driver-specific configuration options for the logging driver.
• /container/logConfigValues with stringarray type. Driver-specific configuration options for the logging driver.
• /container/blkioWeight with integer type. Block IO weight (relative weight).
• /container/blkioWeightDevicePath with stringarray type. Block IO weight (relative device weight).
• /container/blkioWeightDeviceWeight with integerarray type. Block IO weight (relative device weight).
• /container/blkioDeviceReadBpsPath with stringarray type. Limit read rate (bytes per second) to a device.
• /container/blkioDeviceReadBpsRate with longintegerarray type. Limit read rate (bytes per second) to a device.
• /container/blkioDeviceWriteBpsPath with stringarray type. Limit write rate (bytes per second) to a device.
• /container/blkioDeviceWriteBpsRate with longintegerarray type. Limit write rate (bytes per second) to a device.
• /container/blkioDeviceReadIopsPath with stringarray type. Limit read rate (IO per second) to a device.
• /container/blkioDeviceReadIopsRate with longintegerarray type. Limit read rate (IO per second) to a device.
• /container/blkioDeviceWriteIopsPath with stringarray type. Limit write rate (IO per second) to a device.
• /container/blkioDeviceWriteIopsRate with longintegerarray type. Limit write rate (IO per second) to a device.
• /container/securityopt with stringarray type. a list of string values to customize labels for mls systems, such as selinux.
• /container/pidMode with string type. Set the PID (Process) Namespace mode for the container.
• /container/maskedPaths with stringarray type. The list of paths to be masked inside the container (this overrides the default set of paths).
• /container/readonlyPaths with stringarray type. The list of paths to be set as read-only inside the container (this overrides the default set of paths).

/container/id

Create Container Request id

Unique id for the container.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/deploymentId

Reference to a Deployment using the container

The deployment in which the container is used, so the device can send deployment events to Astarte for the create request

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/imageId

Container image id

The id of the image to use when creating the container.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/networkIds

Container network ids

The ids of the network to connect with the container.

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/volumeIds

Container volume ids

The ids of the volumes to mount on the container.

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/deviceMappingIds

Container device mappings ids

The ids of the device mappings to mount on the container.

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/deviceRequestIds

Container device request ids

The ids of the devices to request for the container.

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/fileBindIds

File bind ids

The ids of the file binds required by the container.

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/envFileIds

Env file ids

The ids of the environment files required by the container.

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/hostname

Container hostname

The hostname to use for the container, as a valid RFC 1123 hostname.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/domainname

Container hostname

The domain name to use for the container.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/user

Run as this user inside the container

Can be either user-name or UID, and optional group-name or GID, separated by colon (<user-name|UID>[<:group-name|GID>]).

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/cmd

Command to run specified as array of strings

This will be passed to the entrypoint

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/healthcheckTest

A test to perform to check that the container is healthy.

A non-zero exit code indicates a failed healthcheck

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/healthcheckInterval

The time to wait before considering the check to have hung.

It should be 0 or at least 1000000 (1 ms). 0 means inherit.

This endpoint accepts values of type longinteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.).

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/healthcheckTimeout

The time to wait between checks in nanoseconds.

It should be 0 or at least 1000000 (1 ms). 0 means inherit.

This endpoint accepts values of type longinteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.).

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/healthcheckRetries

The number of consecutive failures needed to consider a container as unhealthy.

0 means inherit.

This endpoint accepts values of type integer: a signed 32 bit integer.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/healthcheckStartPeriod

Start period for the container to initialize before starting health-retries countdown in nanoseconds.

It should be 0 or at least 1000000 (1 ms). 0 means inherit.

This endpoint accepts values of type longinteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.).

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/healthcheckStartInterval

The time to wait between checks in nanoseconds during the start period.

It should be 0 or at least 1000000 (1 ms). 0 means inherit.

This endpoint accepts values of type longinteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.).

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/workingDir

The working directory for commands to run in.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/entrypoint

The entry point for the container.

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/networkDisabled

Disable networking for the container.

This endpoint accepts values of type boolean: either true or false, adhering to JSON boolean type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/labelsKeys

User-defined key/value metadata.

This is a list of the keys for the values in labelsValues.

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/labelsValues

User-defined key/value metadata.

This is a list of the values for the keys in labelsKeys.

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/stopSignal

Signal to stop a container

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/stopTimeout

Timeout to stop a container in seconds.

Default to 10 seconds.

This endpoint accepts values of type integer: a signed 32 bit integer.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/restartPolicy

Container restart policy

The behavior to apply when the container exits. Possible values are: ['', 'no', 'always' 'unless-stopped', 'on-failure']

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/restartPolicyMaximumRetryCount

If on-failure is used, the number of times to retry before giving up.

This endpoint accepts values of type integer: a signed 32 bit integer.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/env

Container environment

Array of key=value environment variables. The key cannot contain =.

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/binds

Container binds

A list of volume bindings for this container. Each volume binding is a string in one of these forms: host-src:container-dest[:options], or volume-name:container-dest[:options]. The container-dest must be an absolute path.

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/networkMode

Network mode used for this container.

Supported standard values are: bridge, host, none, and container:<name|id>. Any other value is taken as a custom network's name to which this container should connect to. If you are using a different container engine than docker, there could be other values.

This endpoint accepts values of type string: an UTF-8 string, at most 65536 bytes long.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/portBindings

Container port bindings

Array of ip:[host_port:]container_port[/protocol] | [hostPort:]containerPort[/protocol]. Protocol is TCP by default

This endpoint accepts values of type stringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type.

The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database.

/container/exposedPorts

Container exposed ports

Array of ~<port>/<tcp|udp|sctp>This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/extraHostsList of hostname/IP to add to the container's /etc/hosts A list of hostnames/IP mappings to add to the container's /etc/hosts file. Specified in the form ["hostname:IP"]. You can use thehost-gatewayto connect to the host IP This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/capAddA list of kernel capabilities to add to the container. A list of kernel capabilities to add to the container. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/capDropA list of kernel capabilities to drop from the container. A list of kernel capabilities to drop from the container. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/cpuSharesAn integer value representing this container's relative CPU weight versus other containers. This endpoint accepts values of typeinteger: a signed 32 bit integer. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/cpusetCpusCPUs in which to allow execution (e.g., 0-3, 0,1). This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/cpuPeriodThe length of a CPU period in microseconds. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/cpuQuotaMicroseconds of CPU time that the container can get in a CPU period. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/cpuRealtimePeriodThe length of a CPU real-time period in microseconds. The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/cpuRealtimeRuntimeThe length of a CPU real-time runtime in microseconds. The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/memoryMemory limit in bytes. Memory limit in bytes. Default to 0 for unlimited. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/memoryReservationMemory soft limit in bytes. Default to 0 for unlimited. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/memorySwapTotal memory limit (memory + swap). Total memory limit (memory + swap). Set as -1 to enable unlimited swap. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/memorySwappinessMemory swappiness Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. This endpoint accepts values of typeinteger: a signed 32 bit integer. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/deviceCgroupRulesA list of cgroup rules to apply to the container This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/ulimitsNameA list of resource limits to set in the container. List of names for the Ulimits objects mapped to the name, soft and hard fields. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/ulimitsSoftA list of resource limits to set in the container. List of soft limits for the Ulimits objects mapped to the name, soft and hard fields. This endpoint accepts values of typeintegerarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/ulimitsHardA list of resource limits to set in the container. List of hard limits for the Ulimits objects mapped to the name, soft and hard fields. This endpoint accepts values of typeintegerarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/autoRemoveAutomatically remove the container when the container's process exits. This has no effect if RestartPolicy is set. This endpoint accepts values of typeboolean: either true or false, adhering to JSON boolean type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/volumeDriverDriver that this container uses to mount volumes. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/storageOptKeysStorage driver options for this container. Key for the values in storageOptValues This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/storageOptValuesStorage driver options for this container. Values for storageOptKey This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/readOnlyRootfsMount the container's root filesystem as read only. This endpoint accepts values of typeboolean: either true or false, adhering to JSON boolean type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/tmpfsPathsA map of container directories which should be replaced by tmpfs mounts. The key of a map of container directories and options which should be replaced by tmpfs mounts, and their corresponding mount options. For example: '/run' This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/tmpfsOptionsA map of container directories which should be replaced by tmpfs mounts. The value of a map of container directories and options which should be replaced by tmpfs mounts, and their corresponding mount options. For example: 'rw,noexec,nosuid,size=65536k' This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/cgroupnsModecgroup namespace mode for the container. Possible values are:privatethe container runs in its own private cgroup namespace,hostuse the host system's cgroup namespace This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/dnsA list of DNS servers for the container to use. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/dnsOptionsA list of DNS options. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/dnsSearchA list of DNS search domains. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/groupAddA list of additional groups that the container process will run as. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/ipcModeIPC sharing mode for the container. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/oomScoreAdjAn integer value containing the score given to the container in order to tune OOM killer preferences. This endpoint accepts values of typeinteger: a signed 32 bit integer. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/usernsModeSets the usernamespace mode for the container when usernamespace remapping option is enabled. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/sysctlsKeysA list of kernel parameters (sysctls) to set in the container. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/sysctlsValuesA list of kernel parameters (sysctls) to set in the container. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/shmSizeSize of /dev/shm in bytes. Must be >= 0. If omitted, the system uses 64MB. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/runtimeRuntime to use with this container. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/privilegedRun privileged Runs the exec process with extended privileges. This endpoint accepts values of typeboolean: either true or false, adhering to JSON boolean type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/logTypeThe logging configuration for this container Name of the logging driver used for the container or 'none' if logging is disabled. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/logConfigKeysDriver-specific configuration options for the logging driver. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/logConfigValuesDriver-specific configuration options for the logging driver. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/blkioWeightBlock IO weight (relative weight). Value from [0..1000] This endpoint accepts values of typeinteger: a signed 32 bit integer. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/blkioWeightDevicePathBlock IO weight (relative device weight). This value is related to the blkioWeightDeviceWeight value This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/blkioWeightDeviceWeightBlock IO weight (relative device weight). This value is related to the blkioWeightDevicePath This endpoint accepts values of typeintegerarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/blkioDeviceReadBpsPathLimit read rate (bytes per second) to a device. This value is related to the blkioDeviceReadBpsRate value This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/blkioDeviceReadBpsRateLimit read rate (bytes per second) to a device. This value is related to the blkioDeviceReadBpsPath This endpoint accepts values of typelongintegerarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/blkioDeviceWriteBpsPathLimit write rate (bytes per second) to a device. This value is related to the blkioDeviceWriteBpsRate value This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/blkioDeviceWriteBpsRateLimit write rate (bytes per second) to a device. This value is related to the blkioDeviceWriteBpsPath This endpoint accepts values of typelongintegerarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/blkioDeviceReadIopsPathLimit read rate (IO per second) to a device. This value is related to the blkioDeviceReadIopsRate value This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/blkioDeviceReadIopsRateLimit read rate (IO per second) to a device. This value is related to the blkioDeviceReadIopsPath This endpoint accepts values of typelongintegerarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/blkioDeviceWriteIopsPathLimit write rate (IO per second) to a device. This value is related to the blkioDeviceWriteIopsRate value This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/blkioDeviceWriteIopsRateLimit write rate (IO per second) to a device. This value is related to the blkioDeviceWriteIopsPath This endpoint accepts values of typelongintegerarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/securityopta list of string values to customize labels for mls systems, such as selinux. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/pidModeSet the PID (Process) Namespace mode for the container. It can be either:container:<name|id>joins another container's PID namespace,hostuse the host's PID namespace inside the container This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/maskedPathsThe list of paths to be masked inside the container (this overrides the default set of paths). This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/container/readonlyPathsThe list of paths to be set as read-only inside the container (this overrides the default set of paths). This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ## io.edgehog.devicemanager.apps.CreateDeploymentRequest v0.1 ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/deployment/idwithstringtype. Create Deployment Request id -/deployment/containerswithstringarraytype. Deployment containers ###/deployment/idCreate Deployment Request id Unique id for the deployment. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deployment/containersDeployment containers Containers used by the deployment. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ## io.edgehog.devicemanager.apps.CreateDeviceMappingRequest v0.1 ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/deviceMapping/idwithstringtype. Create Device Mapping Request id -/deviceMapping/deploymentIdwithstringtype. Reference to a Deployment using the device mapping -/deviceMapping/pathOnHostwithstringtype. Path on host for the device -/deviceMapping/pathInContainerwithstringtype. Path in the container for the device -/deviceMapping/cGroupPermissionswithstringtype. Permissions on the device. ###/deviceMapping/idCreate Device Mapping Request id Unique id for the container. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deviceMapping/deploymentIdReference to a Deployment using the device mapping The deployment in which the device mapping is used, so the device can send deployment events to Astarte for the create request This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deviceMapping/pathOnHostPath on host for the device Path on host for the device, for example '/dev/deviceName' This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deviceMapping/pathInContainerPath in the container for the device Path in the container for the device, for example '/dev/deviceName' This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deviceMapping/cGroupPermissionsPermissions on the device. Permissions on the device, for example 'mrw' This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ## io.edgehog.devicemanager.apps.CreateDeviceRequest v1.0 ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/deviceRequest/idwithstringtype. Create Device Request id -/deviceRequest/deploymentIdwithstringtype. Reference to a Deployment using the device mapping -/deviceRequest/driverwithstringtype. The name of the device driver to use for this request. -/deviceRequest/countwithlongintegertype. Count for the device to request for the container -/deviceRequest/deviceIdswithstringarraytype. Ids of the device to request for the container -/deviceRequest/capabilitieswithstringarraytype. A list of capabilities; an OR list of AND lists of capabilities. -/deviceRequest/optionKeyswithstringarraytype. -/deviceRequest/optionValueswithstringarraytype. ###/deviceRequest/idCreate Device Request id Unique id for the container. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deviceRequest/deploymentIdReference to a Deployment using the device mapping The deployment in which the device mapping is used, so the device can send deployment events to Astarte for the create request This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deviceRequest/driverThe name of the device driver to use for this request. Note that if this is specified the capabilities are ignored when selecting a device driver. Default value is an empty string This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deviceRequest/countCount for the device to request for the container Default value is -1 This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deviceRequest/deviceIdsIds of the device to request for the container This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deviceRequest/capabilitiesA list of capabilities; an OR list of AND lists of capabilities. Note that if a driver is specified the capabilities have no effect on selecting a driver as the driver name is used directly. Note that if no driver is specified the capabilities are used to select a driver with the required capabilities. JSON encoded array, so an array of arrays This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deviceRequest/optionKeysDriver-specific options, specified as a key/value pairs. These options are passed directly to the driver This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deviceRequest/optionValuesDriver-specific options, specified as a key/value pairs. These options are passed directly to the driver This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ## io.edgehog.devicemanager.apps.CreateEnvFileRequest v0.1 An env file creation request Instructs the runtime to read a file sent trough the file transfer and to parse its content to add environment variables to the container. ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/env/idwithstringtype. Create env file request id. -/env/targetIdwithstringtype. the target file id. -/env/targetTypewithstringtype. The target file type. -/env/deploymentIdwithstringtype. the target deployment id. ###/env/idCreate env file request id. Unique id for the file bind. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. ###/env/targetIdthe target file id. The target file id. Can be either a file request id or a file storage id. The type specifies which one to use. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. ###/env/targetTypeThe target file type. The target file type. Possible values are: [storage, request]. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. ###/env/deploymentIdthe target deployment id. The Id of a deployment that contains a container with this env file. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. ## io.edgehog.devicemanager.apps.CreateFileBindRequest v0.1 A bind the device must add to the container, for files sent through the file transfer. Datastream instructing the device how to bind a file or directory sent trough the file transfer. ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/bind/idwithstringtype. Create file bind request id -/bind/targetIdwithstringtype. the target file id. -/bind/deploymentIdwithstringtype. the target deployment id. -/bind/targetTypewithstringtype. The target file type. -/bind/mountpointwithstringtype. the mountpoint into the device. -/bind/optionswithstringtype. Binding options. ###/bind/idCreate file bind request id Unique id for the file bind. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. ###/bind/targetIdthe target file id. The target file id. Depending on the type might refer to a file storage or to a file request id. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. ###/bind/deploymentIdthe target deployment id. The Id of a deployment that contains a container with this file bind. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. ###/bind/targetTypeThe target file type. Instructs the runtime on which type of file we're referring to. Its possible values are: [storage, request]. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. ###/bind/mountpointthe mountpoint into the device. Where the file should be mounted onto the container. Must be an absolute path. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. ###/bind/optionsBinding options. The binding options the device manager must follow when binding the file onto the device. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. ## io.edgehog.devicemanager.apps.CreateImageRequest v0.1 Request to pull and create a container image. The ttl of this datastream is short to keep the sensitive fields private. ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/image/idwithstringtype. Create Image Request id -/image/deploymentIdwithstringtype. Reference to a Deployment using the image -/image/referencewithstringtype. Image reference to be pulled -/image/registryAuthwithstringtype. Image registry authentication header ###/image/idCreate Image Request id Unique id for the container image. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 600 seconds before it is erased from the database. ###/image/deploymentIdReference to a Deployment using the image The deployment in which the image is used, so the device can send deployment events to Astarte for the create request This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 600 seconds before it is erased from the database. ###/image/referenceImage reference to be pulled Name of the image to pull. It should be in the form [registry-host[:port]/][image-repo/]image-name[:(tag|digest)] This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 600 seconds before it is erased from the database. ###/image/registryAuthImage registry authentication header Optional base64url-encoded JSON for the auth configuration to the registry. An empty string means the image is public and doesn't require authentication. See https://docs.docker.com/reference/api/engine/version/v1.43/#section/Authentication for more information. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 600 seconds before it is erased from the database. ## io.edgehog.devicemanager.apps.CreateNetworkRequest v0.1 ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/network/idwithstringtype. Create Network Request id -/network/deploymentIdwithstringtype. Reference to a Deployment using the network -/network/driverwithstringtype. Network driver -/network/internalwithbooleantype. Internal network -/network/enableIpv6withbooleantype. Enable IPv6 -/network/optionswithstringarraytype. Network driver options ###/network/idCreate Network Request id Unique id for the container network. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/network/deploymentIdReference to a Deployment using the network The deployment in which the network is used, so the device can send deployment events to Astarte for the create request This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/network/driverNetwork driver Name of the network driver plugin to use. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/network/internalInternal network Restrict external access to the network. This endpoint accepts values of typeboolean: either true or false, adhering to JSON boolean type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/network/enableIpv6Enable IPv6 Enable IPv6 on the network. This endpoint accepts values of typeboolean: either true or false, adhering to JSON boolean type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/network/optionsNetwork driver options An array of key=value options to set for the driver. The key cannot contain an=. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ## io.edgehog.devicemanager.apps.CreateVolumeRequest v0.1 ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/volume/idwithstringtype. Create Volume Request id -/volume/deploymentIdwithstringtype. Reference to a Deployment using the volume -/volume/driverwithstringtype. Volume driver name -/volume/optionswithstringarraytype. Volume driver options ###/volume/idCreate Volume Request id Unique id for the volume. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/volume/deploymentIdReference to a Deployment using the volume The deployment in which the volume is used, so the device can send deployment events to Astarte for the create request This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/volume/driverVolume driver name Name of the volume driver to use. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/volume/optionsVolume driver options An array of key=value options to set for the driver. The key cannot contain an=. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ## io.edgehog.devicemanager.apps.DeploymentCommand v0.1 ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anindividualaggregation. Each mapping is treated as an independent value and is managed individually. ### Mappings The interface has the following mappings: -/%{deployment_id}/commandwithstringtype. Deployment command ###/%{deployment_id}/commandDeployment command Possible values [Start, Stop, Delete] This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint is parametric anddeployment_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ## io.edgehog.devicemanager.apps.DeploymentEvent v0.2 ### About This interface is of typedatastreamand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/%{deployment_id}/statuswithstringtype. Deployment status -/%{deployment_id}/messagewithstringtype. Optional message for the event -/%{deployment_id}/addInfowithstringarraytype. Additional info ###/%{deployment_id}/statusDeployment status Possible values: [Starting, Started, Stopping, Stopped, Updating, Deleting, Error] This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint is parametric anddeployment_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/%{deployment_id}/messageOptional message for the event This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint is parametric anddeployment_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/%{deployment_id}/addInfoAdditional info Additional info about the event. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint is parametric anddeployment_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ## io.edgehog.devicemanager.apps.DeploymentUpdate v0.1 ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/deployment/fromwithstringtype. Id of the deployment to update from -/deployment/towithstringtype. Id of the deployment to update to ###/deployment/fromId of the deployment to update from This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ###/deployment/toId of the deployment to update to This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 31556952 seconds before it is erased from the database. ## io.edgehog.devicemanager.apps.stats.ContainerBlkio v0.1 BlkioStats stores all IO service stats for data read and write. ### About This interface is of typedatastreamand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/%{container_id}/namewithstringtype. -/%{container_id}/majorwithlongintegertype. -/%{container_id}/minorwithlongintegertype. -/%{container_id}/opwithstringtype. -/%{container_id}/valuewithlongintegertype. ###/%{container_id}/nameThis endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/majorThis endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/minorThis endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/opThis endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/valueThis endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ## io.edgehog.devicemanager.apps.stats.ContainerCpu v0.1 The precpu stats is the CPU statistic of the previous read, and is used to calculate the CPU usage percentage. It is not an exact copy of the cpu_stats field. ### About This interface is of typedatastreamand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/%{container_id}/cpuUsageTotalUsagewithlongintegertype. Total CPU time consumed in nanoseconds -/%{container_id}/cpuUsagePercpuUsagewithlongintegerarraytype. Total CPU time (in nanoseconds) consumed per core -/%{container_id}/cpuUsageUsageInKernelmodewithlongintegertype. Time (in nanoseconds) spent by tasks of the cgroup in kernel mode -/%{container_id}/cpuUsageUsageInUsermodewithlongintegertype. Time (in nanoseconds) spent by tasks of the cgroup in user mode -/%{container_id}/systemCpuUsagewithlongintegertype. System Usage. -/%{container_id}/onlineCpuswithintegertype. Number of online CPUs. -/%{container_id}/throttlingDataPeriodswithlongintegertype. Number of periods with throttling active. -/%{container_id}/throttlingDataThrottledPeriodswithlongintegertype. Number of periods when the container hit its throttling limit. -/%{container_id}/throttlingDataThrottledTimewithlongintegertype. Aggregated time (in nanoseconds) the container was throttled for. -/%{container_id}/preCpuUsageTotalUsagewithlongintegertype. Total CPU time consumed in nanoseconds -/%{container_id}/preCpuUsagePercpuUsagewithlongintegerarraytype. Total CPU time (in nanoseconds) consumed per core -/%{container_id}/preCpuUsageUsageInKernelmodewithlongintegertype. Time (in nanoseconds) spent by tasks of the cgroup in kernel mode -/%{container_id}/preCpuUsageUsageInUsermodewithlongintegertype. Time (in nanoseconds) spent by tasks of the cgroup in user mode -/%{container_id}/preSystemCpuUsagewithlongintegertype. System Usage. -/%{container_id}/preOnlineCpuswithintegertype. Number of online CPUs. -/%{container_id}/preThrottlingDataPeriodswithlongintegertype. Number of periods with throttling active. -/%{container_id}/preThrottlingDataThrottledPeriodswithlongintegertype. Number of periods when the container hit its throttling limit. -/%{container_id}/preThrottlingDataThrottledTimewithlongintegertype. Aggregated time (in nanoseconds) the container was throttled for. ###/%{container_id}/cpuUsageTotalUsageTotal CPU time consumed in nanoseconds Total CPU time consumed by the container, in nanoseconds. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/cpuUsagePercpuUsageTotal CPU time (in nanoseconds) consumed per core This field is Linux-specific when using cgroups v1. This endpoint accepts values of typelongintegerarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/cpuUsageUsageInKernelmodeTime (in nanoseconds) spent by tasks of the cgroup in kernel mode CPU time spent in kernel mode by the container's tasks, in nanoseconds. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/cpuUsageUsageInUsermodeTime (in nanoseconds) spent by tasks of the cgroup in user mode This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/systemCpuUsageSystem Usage. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/onlineCpusNumber of online CPUs. This endpoint accepts values of typeinteger: a signed 32 bit integer. The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/throttlingDataPeriodsNumber of periods with throttling active. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/throttlingDataThrottledPeriodsNumber of periods when the container hit its throttling limit. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/throttlingDataThrottledTimeAggregated time (in nanoseconds) the container was throttled for. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/preCpuUsageTotalUsageTotal CPU time consumed in nanoseconds Total CPU time consumed by the container, in nanoseconds. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/preCpuUsagePercpuUsageTotal CPU time (in nanoseconds) consumed per core This field is Linux-specific when using cgroups v1. This endpoint accepts values of typelongintegerarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/preCpuUsageUsageInKernelmodeTime (in nanoseconds) spent by tasks of the cgroup in kernel mode CPU time spent in kernel mode by the container's tasks, in nanoseconds. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/preCpuUsageUsageInUsermodeTime (in nanoseconds) spent by tasks of the cgroup in user mode This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/preSystemCpuUsageSystem Usage. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/preOnlineCpusNumber of online CPUs. This endpoint accepts values of typeinteger: a signed 32 bit integer. The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/preThrottlingDataPeriodsNumber of periods with throttling active. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/preThrottlingDataThrottledPeriodsNumber of periods when the container hit its throttling limit. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/preThrottlingDataThrottledTimeAggregated time (in nanoseconds) the container was throttled for. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ## io.edgehog.devicemanager.apps.stats.ContainerMemory v0.1 ### About This interface is of typedatastreamand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/%{container_id}/usagewithlongintegertype. Current res_counter usage for memory. -/%{container_id}/maxUsagewithlongintegertype. Maximum usage ever recorded. -/%{container_id}/failcntwithlongintegertype. Number of times memory usage hits limits. -/%{container_id}/limitwithlongintegertype. Memory usage limit ###/%{container_id}/usageCurrent res_counter usage for memory. Current total memory usage (RAM + swap) of the container, in bytes. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/maxUsageMaximum usage ever recorded. The maximum memory usage recorded since the container's start, in bytes. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/failcntNumber of times memory usage hits limits. The number of times the memory limit has been reached. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/limitMemory usage limit The memory usage limit for the container This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ## io.edgehog.devicemanager.apps.stats.ContainerMemoryStats v0.1 All the stats exported via memory.stat. when using cgroups v2. ### About This interface is of typedatastreamand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/%{container_id}/namewithstringtype. Name of the stat -/%{container_id}/valuewithlongintegertype. Value of the stat ###/%{container_id}/nameName of the stat This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/valueValue of the stat This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ## io.edgehog.devicemanager.apps.stats.ContainerNetworks v0.1 Network statistics for the container per interface. ### About This interface is of typedatastreamand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/%{container_id}/interfacewithstringtype. Network interface name -/%{container_id}/rxByteswithlongintegertype. Bytes received. -/%{container_id}/rxPacketswithlongintegertype. Packets received. -/%{container_id}/rxDroppedwithlongintegertype. Incoming packets dropped. -/%{container_id}/rxErrorswithlongintegertype. Received errors. -/%{container_id}/txByteswithlongintegertype. Bytes sent. -/%{container_id}/txPacketswithlongintegertype. Packets sent. -/%{container_id}/txErrorswithlongintegertype. Sent errors. -/%{container_id}/txDroppedwithlongintegertype. Outgoing packets dropped. ###/%{container_id}/interfaceNetwork interface name Name of the network for which the statistics are provided. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/rxBytesBytes received. Total number of bytes received on the interface. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/rxPacketsPackets received. Total number of packets successfully received on the interface. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/rxDroppedIncoming packets dropped. Total number of incoming packets that were dropped. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/rxErrorsReceived errors. Total number of errors that occurred while receiving. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/txBytesBytes sent. Total number of bytes transmitted on the interface. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/txPacketsPackets sent. Total number of packets successfully transmitted on the interface. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/txErrorsSent errors. Total number of errors that occurred while transmitting. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/txDroppedOutgoing packets dropped. Total number of outgoing packets that were dropped. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ## io.edgehog.devicemanager.apps.stats.ContainerProcesses v0.1 PidsStats contains Linux-specific stats of a container's process-IDs (PIDs). ### About This interface is of typedatastreamand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/%{container_id}/currentwithlongintegertype. Current is the number of PIDs in the cgroup. -/%{container_id}/limitwithlongintegertype. Limit is the hard limit on the number of pids in the cgroup. ###/%{container_id}/currentCurrent is the number of PIDs in the cgroup. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{container_id}/limitLimit is the hard limit on the number of pids in the cgroup. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andcontainer_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ## io.edgehog.devicemanager.apps.stats.VolumeUsage v0.1 Statistics on the volumes ### About This interface is of typedatastreamand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/%{volume_id}/driverwithstringtype. Name of the volume driver used by the volume. -/%{volume_id}/mountpointwithstringtype. Mount path of the volume on the host. -/%{volume_id}/createdAtwithdatetimetype. Date/Time the volume was created. -/%{volume_id}/usageDataSizewithlongintegertype. Amount of disk space used by the volume (in bytes). -/%{volume_id}/usageDataRefCountwithlongintegertype. The number of containers referencing this volume. ###/%{volume_id}/driverName of the volume driver used by the volume. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint is parametric andvolume_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{volume_id}/mountpointMount path of the volume on the host. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint is parametric andvolume_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{volume_id}/createdAtDate/Time the volume was created. This endpoint accepts values of typedatetime: a UTC timestamp, internally represented as milliseconds since 1st Jan 1970 using a signed 64 bits integer. (datetime is represented as an ISO 8601 string by default in JSON based APIs.) The endpoint is parametric andvolume_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{volume_id}/usageDataSizeAmount of disk space used by the volume (in bytes). This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andvolume_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/%{volume_id}/usageDataRefCountThe number of containers referencing this volume. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andvolume_idcan be replaced with any valid string to send data on specialized paths. The endpoint has a specific configuration for how data is stored, transferred and indexed. Astarte expects a valid timestamp to be attached each time data is produced. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ## io.edgehog.devicemanager.config.Telemetry v0.1 ### About This interface is of typepropertiesand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can set a persistent, stateful, synchronized state with no concept of history or timestamping. ### Mappings The interface has the following mappings: -/request/%{interface_name}/enablewithbooleantype. Enable/Disable telemetry update. Unset returns to the previous state configured in the device. -/request/%{interface_name}/periodSecondswithlongintegertype. Set interval of period seconds between the end of the previous update and the start of the next one. Unset returns to the previous state configured in the device. ###/request/%{interface_name}/enableEnable/Disable telemetry update. Unset returns to the previous state configured in the device. This endpoint accepts values of typeboolean: either true or false, adhering to JSON boolean type. The endpoint is parametric andinterface_namecan be replaced with any valid string to send data on specialized paths. The value of the property can be unset. ###/request/%{interface_name}/periodSecondsSet interval of period seconds between the end of the previous update and the start of the next one. Unset returns to the previous state configured in the device. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andinterface_namecan be replaced with any valid string to send data on specialized paths. The value of the property can be unset. ## io.edgehog.devicemanager.fileTransfer.Capabilities v0.1 File transfer capabilities the Device supports Features and capabilities the Device implementation or plafrom supports and is able to receive from Astarte. ### About This interface is of typepropertiesand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping. ### Mappings The interface has the following mappings: -/transfer/unixPermissionswithbooleantype. Support unix file mode, user id and group id. -/transfer/serverToDevice/targetswithstringarraytype. Supported destination and sources for the transfers. -/transfer/deviceToServer/targetswithstringarraytype. Supported destination and sources for the transfers. -/deviceToServer/%{target}/encodingswithstringarraytype. Supported compressions and archive algorithms for the target. -/serverToDevice/%{target}/encodingswithstringarraytype. Supported compressions and archive algorithms for the target. ###/transfer/unixPermissionsSupport unix file mode, user id and group id. Flag to support setting the file mode, user and group ownership of a transferred file in a unix system. This endpoint accepts values of typeboolean: either true or false, adhering to JSON boolean type. The value of the property cannot be unset. ###/transfer/serverToDevice/targetsSupported destination and sources for the transfers. List of sources and destinations that the device can handle, possible values are: [storage, streaming, filesystem] This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The value of the property cannot be unset. ###/transfer/deviceToServer/targetsSupported destination and sources for the transfers. List of sources and destinations that the device can handle, possible values are: [storage, streaming, filesystem] This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The value of the property cannot be unset. ###/deviceToServer/%{target}/encodingsSupported compressions and archive algorithms for the target. List of encoding formats supported by the device for this target, possible values are: [gz, lz4, tar, tar.gz, tar.lz4]. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint is parametric andtargetcan be replaced with any valid string to send data on specialized paths. The value of the property cannot be unset. ###/serverToDevice/%{target}/encodingsSupported compressions and archive algorithms for the target. List of encoding formats supported by the device for this target, possible values are: [gz, lz4, tar, tar.gz, tar.lz4]. This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint is parametric andtargetcan be replaced with any valid string to send data on specialized paths. The value of the property cannot be unset. ## io.edgehog.devicemanager.fileTransfer.DeviceToServer v0.1 File transfer from a Device to a Server Request a file transfer operation. Providing an URL where the device will upload a file with an HTTP PUT request, the source of the file to upload is implementation specific. ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/request/idwithstringtype. Transfer ID (UUID) for the file -/request/urlwithstringtype. The URL to upload the file to -/request/httpHeaderKeyswithstringarraytype. Keys for the HTTP headers, must be in the order of the values -/request/httpHeaderValueswithstringarraytype. Values for the HTTP headers, must be in the order of the keys -/request/encodingwithstringtype. Encoding of the file or directory to upload -/request/progresswithbooleantype. Flag to enable the progress reporting of the download. -/request/sourceTypewithstringtype. Source from which the file should be read from. -/request/sourcewithstringtype. Source-specific information on what to upload to the server for the source. ###/request/idTransfer ID (UUID) for the file This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/urlThe URL to upload the file to This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/httpHeaderKeysKeys for the HTTP headers, must be in the order of the values This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/httpHeaderValuesValues for the HTTP headers, must be in the order of the keys This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/encodingEncoding of the file or directory to upload Optional enum string for the file encoding with default value empty, other values are: [gz, lz4, tar, tar.gz, tar.lz4] This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/progressFlag to enable the progress reporting of the download. This endpoint accepts values of typeboolean: either true or false, adhering to JSON boolean type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/sourceTypeSource from which the file should be read from. String enum specifying the source type, with allowed values: [storage, streaming, filesystem]. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/sourceSource-specific information on what to upload to the server for the source. The value depends on the selected source type: for 'storage' is the ID of an 'io.edgehog.devicemanager.storage.File' property, for 'streaming' it's an empty string, and for 'filesystem' is a path of a file on the device. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ## io.edgehog.devicemanager.fileTransfer.Progress v0.1 Progress of a file transfer. If the request enabled progress reporting, the device will send the progress of the operation. ### About This interface is of typedatastreamand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/request/idwithstringtype. Transfer ID (UUID) for the file -/request/typewithstringtype. Direction of the file transfer -/request/byteswithlongintegertype. Progress of the transfer in number of bytes transferred. -/request/totalByteswithlongintegertype. Total size of the transfer. ###/request/idTransfer ID (UUID) for the file This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/typeDirection of the file transfer Specifies the direction of the transfer. Allowed values: 'server_to_device' or 'device_to_server'. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/bytesProgress of the transfer in number of bytes transferred. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/totalBytesTotal size of the transfer. Reports the total number of bytes that have to be transferred. If the total size is not known this field contains a value of '-1'. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ## io.edgehog.devicemanager.fileTransfer.Response v0.1 Response for a file transfer Used by the device to report the transfer status upon completion. Used for both download and upload. ### About This interface is of typedatastreamand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/request/idwithstringtype. Transfer ID (UUID) for the file -/request/typewithstringtype. Direction of the file transfer -/request/codewithlongintegertype. Success or error code for the transfer -/request/messagewithstringtype. Optional message for the response ###/request/idTransfer ID (UUID) for the file Can be either for download or upload transfers. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/typeDirection of the file transfer Specifies the direction of the transfer. Allowed values: 'server_to_device' or 'device_to_server'. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/codeSuccess or error code for the transfer A 0 code is a success, errors are POSIX errno. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/messageOptional message for the response This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ## io.edgehog.devicemanager.fileTransfer.ServerToDevice v0.1 File transfer from a Server to a Device Request a file transfer operation. Providing a URL from which the device will download a file with an HTTP GET request, the destination of the file to download is implementation specific. ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/request/idwithstringtype. Transfer ID (UUID) for the file -/request/urlwithstringtype. The URL to get the file from -/request/httpHeaderKeyswithstringarraytype. Keys for the HTTP headers, must be in the order of the values -/request/httpHeaderValueswithstringarraytype. Values for the HTTP headers, must be in the order of the keys -/request/encodingwithstringtype. Encoding of the file or directory to download -/request/fileSizeByteswithlongintegertype. File size decompressed -/request/progresswithbooleantype. Flag to enable the progress reporting of the download. -/request/digestwithstringtype. Digest of the file contents -/request/ttlSecondswithlongintegertype. TTL on how long to keep the file for -/request/fileModewithlongintegertype. Unix mode for the file -/request/userIdwithlongintegertype. Uid of the user owning the file -/request/groupIdwithlongintegertype. Gid of the user owning the file -/request/destinationTypewithstringtype. Destination where the file should be written to. -/request/destinationwithstringtype. Destination-specific information on where to write the file to. ###/request/idTransfer ID (UUID) for the file If the file is to be stored, this MUST be unique to the file (e.g. hash of the content). For a file that needs to be streamed, it can be unique for the single request (e.g. uuid). This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/urlThe URL to get the file from This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/httpHeaderKeysKeys for the HTTP headers, must be in the order of the values This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/httpHeaderValuesValues for the HTTP headers, must be in the order of the keys This endpoint accepts values of typestringarray: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/encodingEncoding of the file or directory to download Optional enum string for the file encoding with default value empty, other values are: [gz, lz4, tar, tar.gz, tar.lz4] This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/fileSizeBytesFile size decompressed Total file size (if multiple files) uncompressed in bytes. It's used to reserve this space on the device. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/progressFlag to enable the progress reporting of the download. This endpoint accepts values of typeboolean: either true or false, adhering to JSON boolean type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/digestDigest of the file contents Must be in the form sha256:deadbeaf, and should be used only if supported by the device. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/ttlSecondsTTL on how long to keep the file for Optional ttl for how long to keep the file for, if 0 the file will be kept indefinitely, this field is ignored for destinationType 'streaming' and 'filesystem'. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/fileModeUnix mode for the file Optional unix mode for the file, set to default if 0. All files are immutable, so setting it to writable has no effect. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/userIdUid of the user owning the file Optional unix uid of the user owning the file, set to default if -1. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/groupIdGid of the user owning the file Optional unix gid of the group owning the file, set to default if -1. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/destinationTypeDestination where the file should be written to. String enum specifying the destination type, with allowed values: [storage, streaming, filesystem]. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/destinationDestination-specific information on where to write the file to. The value depends on the selected destination type: for 'streaming' it's an empty string, for 'filesystem' is a path to a file on the device, for 'storage' is the file name of the resource that gets downloaded. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ## io.edgehog.devicemanager.storage.DeleteFile v0.1 Delete a file stored on a device Requests the deletion of a file stored on the device. The file must be one published through theio.edgehog.devicemanager.storage.Fileinterface. ### About This interface is of typedatastreamand is owned by theserver, meaning that it is the server which initiates the data flow. Thanks to this type of interface, the server can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/request/idwithstringtype. Id of the delete request -/request/fileIdwithstringtype. ID of the file to delete -/request/forcewithbooleantype. Force the deletion of the file. ###/request/idId of the delete request Id of a request on which we will be used to send theio.edgehog.devicemanager.storage.Response. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/request/fileIdID of the file to delete Id of a file on the device published through theio.edgehog.devicemanager.storage.Fileinterface. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ###/request/forceForce the deletion of the file. Force the deletion of the file even if it's currently in use, this could cause errors. Default to false. This endpoint accepts values of typeboolean: either true or false, adhering to JSON boolean type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when the transport successfully sends the data regardless of the outcome. Data is discarded if the transport is temporarily uncapable of delivering it. ## io.edgehog.devicemanager.storage.File v0.1 Property for the files stored on a device Published when a file has been fully transferred and stored on the device. ### About This interface is of typepropertiesand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can set a persistent, stateful, synchronized state with no concept of history or timestamping. ### Mappings The interface has the following mappings: -/%{fileId}/pathOnDevicewithstringtype. Path on the device for the transferred file -/%{fileId}/sizeByteswithlongintegertype. Size in bytes of the file ###/%{fileId}/pathOnDevicePath on the device for the transferred file This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint is parametric andfileIdcan be replaced with any valid string to send data on specialized paths. The value of the property can be unset. ###/%{fileId}/sizeBytesSize in bytes of the file This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint is parametric andfileIdcan be replaced with any valid string to send data on specialized paths. The value of the property can be unset. ## io.edgehog.devicemanager.storage.Response v0.1 Response for a storage operation Used by the device to report the storage operation status upon completion. ### About This interface is of typedatastreamand is owned by thedevice, meaning that it is the device which initiates the data flow. Thanks to this type of interface, the device can send a mutable, ordered stream of data, with no concept of persistent state or synchronization. Data gets sent with anobjectaggregation. Astarte expects the owner to send all of the interface's mappings at the same time, packed in a single message. ### Mappings The interface has the following mappings: -/request/idwithstringtype. Operation ID associated with the response -/request/typewithstringtype. Type of storage response -/request/codewithlongintegertype. Success or error code for the transfer -/request/messageswithstringarraytype. Optional messages for the response ###/request/idOperation ID associated with the response This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/typeType of storage response Specifies the direction of the transfer. Allowed values: 'delete'. This endpoint accepts values of typestring: an UTF-8 string, at most 65536 bytes long. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/codeSuccess or error code for the transfer A 0 code is a success, errors are POSIX errno. This endpoint accepts values of typelonginteger: a signed 64 bit integer (please note that longinteger is represented as a string by default in JSON-based APIs.). The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database. ###/request/messagesOptional messages for the response This endpoint accepts values of typestringarray`: a list of values, represented as a JSON Array. Arrays can have up to 1024 items and each item must respect the limits of its scalar type. The endpoint has a specific configuration for how data is stored, transferred and indexed. Data is considered delivered when it has been received at least once by the recipient. Data is discarded if the transport is temporarily uncapable of delivering it. Delivered data is kept for 3600 seconds before it is erased from the database.