Delete Bridge Delete Bridge application Permanently delete an existing <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. This cannot be undone once the API request has been submitted. <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> can be deleted even if the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a> is offline. In this case, the information will be immediately deleted on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> and the commands to delete on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a> will be sent when it next comes online. Permission Required: `kelvin.permission.bridge.delete`
Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='blank'>Kelvin Bridge</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
Request optional parameters
Deploy Bridge Deploy Bridge App Deploy a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> to a selected <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>. The Kelvin Bridge will handle all the communications and data transfer between external equipment and the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a> using one of four communication protocols; OPC UA, MQTT, Modbus TCP / RTU or Emerson ROC. Each protocol will require a different type of payload structure that defines the exact address specifications for each <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> // <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs. Permission Required: `kelvin.permission.bridge.create`
Bridge create schema. Supported protocols [`opc-ua`, `mqtt`, `modbus`, `roc`]
Request optional parameters
Get Bridge Get Bridge Retrieve the properties of a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. Permission Required: `kelvin.permission.bridge.read`
Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='blank'>Kelvin Bridge</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
Request optional parameters
List Bridge List Bridge Returns a dictionary with a data property containing a list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. Pagination Sortable Columns: `bridge.name`, `bridge.title`, `bridge.protocol`, `bridge.acp_name`, `bridge.workload_name`, `bridge.created`, `bridge.updated`, `status_state`, `status_last_seen` Permission Required: `kelvin.permission.bridge.read`
Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='blank'>Kelvin Bridge</a>'s acp_name (This is a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>). This is given as an array, for example `[demo-node-1,extruder-node]`.</p> The filter is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end).</p> For example a filter with `[demo-node-1,extruder-node]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the parameter acp_name `extruder-node` but not with the names `demo-extruder-node` or `extruder-node-one`.
An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='blank'>Kelvin Bridge</a> by its name. This is given as an array, for example `[extruder-bridge,tank-bridge]`.</p> The filter is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end).</p> For example a filter with `[extruder-bridge,tank-bridge]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the name `extruder-bridge` but not with the names `demo-extruder-bridge` or `tank-bridge-one`.
Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> objects.
Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> `protocol`. This is the communication protocol used by the bridge. This is given as an array, for example `[modbus,mqtt]`.</p> There are four options available; `modbus`, `opc-ua`, `mqtt`, `roc`.
Search and filter the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> list. Both the Display Name and the Name will be included in the search field criteria. This is given as an array, for example `[demo,bridge]`.</p> The search is case insensitive and will find partial matches as well. For example if a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> name or display name is `extruder-bridge`, then a match will be made if the search string is `ext` or `rIDge`.
Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> parameters. Only one parameter can be selected.</p> There are ten parameter options; `bridge.name`, `bridge.title`, `bridge.protocol`, `bridge.acp_name`, `bridge.workload_name`, `bridge.created`, `bridge.updated`, `status_state` and `status_last_seen`.</p> The default is `bridge.name`
An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> `status_state`. This is the communication protocol used by the bridge. This is given as an array, for example `[failed,stopped]`.</p> There are five options available; `running`, `stopped`, `failed`, `deploying`, `offline`.
Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='blank'>Kelvin Bridge</a> `workload_name`. This is given as an array, for example `[extruder,tank]`.</p> The filter is done on the full workload_name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end).</p> For example a filter with `[extruder,tank]` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the parameter workload_name `extruder` but not with the workload_name `demo-extruder-bridge` or `bridge-tank`.
Request optional parameters
List Bridge Assets List Bridge Assets Returns a dictionary with a data property containing a list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. Pagination Sortable Columns: `asset.name`, `asset.title`, `asset.created`, `asset.updated`, `asset_type.title` Permission Required: `kelvin.permission.bridge.read`
Filter on the parameter <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='blank'>Kelvin Bridge</a> by its name.</p> The filter is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end).</p> For example a filter with `demo-bridge-one` will return <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> linked to the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> with the name `demo-bridge-one` but not with the names `demo-bridge` or `bridge-one`.
An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> objects.
Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> parameters. Only one parameter can be selected.</p> There are ten parameter options; `asset.name`, `asset.title`, `asset.created`, `asset.updated` and `asset_type.title`.</p> The default is `asset.name`
An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
Request optional parameters
List Bridge Data Streams List Bridge Data Streams Returns a list of all the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> // <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> pairs that have been deployed with the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. The specific connection details for each Kelvin Asset / Kelvin Metric pair are also returned in a payload. The payload structure will depend on the type of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. There are four types; OPC UA, MQTT, Modbus and ROC. You can apply a number of filters to the return list. Pagination Sortable Columns: `bridge_metric_asset.asset_name`, `bridge_metric_asset.metric_name` Permission Required: `kelvin.permission.bridge.read`
Filter the data stream objects of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> which contain specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> names.
<a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='blank'>Kelvin Bridge</a> name to retrieve the data stream objects.</p> This is the unique identifier name and not the display name (title) of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response parameter under pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
Filter the data stream objects of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> which contain specific <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> names.
Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> objects.
Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> parameters. Only one parameter can be selected.</p> There are two parameter options; `bridge_metric_asset.asset_name`, `bridge_metric_asset.metric_name`.</p> The default is `bridge_metric_asset.asset_name`
An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response parameter under pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
Request optional parameters
List Bridge Metrics List Bridge Metrics Returns a dictionary with a data property containing a list of all <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. Pagination Sortable Columns: `metric.name`, `metric.title`, `metric.created`, `metric.updated`, `metric.data_type_name` Permission Required: `kelvin.permission.bridge.read`
Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='blank'>Kelvin Bridge</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
An alphanumeric string to move to the previous page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> previous_page alphanumeric string should be used here to show a list of the previous page of results.
Number of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> objects to be returned. Page size can be between 1 and 1000 objects.</p> The default is 20 <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metric</a> objects.
Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> parameters. Only one parameter can be selected.</p> There are ten parameter options; `metric.name`, `metric.title`, `metric.created`, `metric.updated` and `metric.data_type_name`.</p> The default is `metric.name`
An alphanumeric string to move to the next page of <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-metrics/' target='_blank'>Kelvin Metrics</a> in the list.</p> The alphanumeric string which are the bookmarks for the beginning and end of the current list is given in the previous JSON response value under the key pagination -> previous_page and pagination -> next_page respectively.</p> The pagination -> next_page alphanumeric string should be used here to show a list of the next page of results.
Request optional parameters
List MQTT Topics List MQTT Topics Returns a dictionary with a data property containing a list of the MQTT topic payload options available on the <a href='https://docs.kelvininc.com/latest/kelvin-overview/overview/#kelvin-platform' target='_blank'>Kelvin Platform</a>. The MQTT topic payload definitions defines how <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridges</a> which are using the `mqtt` protocol will interpret incoming messages on a topic. Sortable Columns: `bridge_mqtt_topic.name`, `bridge_mqtt_topic.title`, `bridge_mqtt_topic.topic`, `bridge_mqtt_topic.created`, `bridge_mqtt_topic.updated` Permission Required: `kelvin.permission.bridge.read`
Filter on the MQTT Topics by its name.</p> The filter is done on the full name only according to unique identifier name rules (Must contain only lowercase alphanumeric characters. The `.`, `_` and `-` characters are also allowed to separate words instead of a space but not at the beginning or end).</p> For example a filter with `topic-one` will return MQTT topics with the name `topic-one` but not with the names `topic-one-extended` or `topic`.
Search and filter the MQTT Topic list. The Display Name, the Name and the Topic will be included in the search field criteria. This is given as an array, for example `[one,two]`.</p> The search is case insensitive and will find partial matches as well. For example if a MQTT TOpic name, display name or topic is `topic-one`, then a match will be made if the search string is `one` or `oPic`.
Sorting order for the results according to the `sort_by` parameter.</p> There are two options; `true` (ascending order) and `false` (descending order).</p> The default is `true` (ascending).
Sort the results by one of the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/' target='_blank'>Kelvin Assets</a> parameters. Only one parameter can be selected.</p> There are five parameter options; `bridge_mqtt_topic.name`, `bridge_mqtt_topic.title`, `bridge_mqtt_topic.topic`, `bridge_mqtt_topic.created`, `bridge_mqtt_topic.updated`.</p> The default is `bridge_mqtt_topic.name`
Request optional parameters
Start Bridge Start Bridge application Start a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. The <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> must already be deployed to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>. Permission Required: `kelvin.permission.bridge.update`
Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='blank'>Kelvin Bridge</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
Request optional parameters
Stop Bridge Stop Bridge application Stop a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a>. The <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='_blank'>Kelvin Bridge</a> must already be deployed to a <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-nodes/' target='_blank'>Kelvin Node</a>. Permission Required: `kelvin.permission.bridge.update`
Unique identifier name for the <a href='https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-bridges/' target='blank'>Kelvin Bridge</a>.</p> This must contain only lowercase alphanumeric characters. The `.`, `` and `-` characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.
Request optional parameters
Kelvin SDK Client Library Reference