Connector Bindings

Connector Bindings define the configuration that enables a device to communicate with the Things platform through a specific connector.

While connectors provide the communication interfaces themselves, a device typically needs connector-specific settings—such as credentials, shared secrets, or protocol parameters—to authenticate and exchange uplinks or downlinks. This per-device configuration is captured in a Connector Binding.

The Things platform supports multiple binding types aligned with the available connectors:

  • http for devices sending SenML or Streamline-protocol uplinks over HTTP(S)

  • lora for devices using ThingPark LoRaWAN

  • mqtt for devices exchanging messages via MQTT

Connector Bindings let you precisely define how each device connects and communicates through the Things platform.

Lora Bindings

Download the specification.

Retrieve LoRa bindings, filtered by query parameters.

get

Retrieve all LoRa bindings that match the query parameters given.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
cursorstring · cursorOptional

String that encodes all necessary information to retrieve a page.

limitintegerOptional

Limit the number of results (per page).

Default: 50
sortstringOptional

Sorting fields separated by comma. Default order is Ascending (ASC), minus(-) should be used in front of field name for Descending (DESC) order.

Example: createdAt,-name
clientIdstring · uuidOptional

Include only LoRa bindings for devices that are owned by the provided clientId. If clientId is omitted, bindings from all devices owned by the calling client are included.

deviceIdstring · uuidOptional

Include only LoRa bindings for the device identified by the provided deviceId.

createdBeforestring · date-timeOptional

Include only LoRa bindings created before the provided date and time. The date-time must be in ISO 8601 format.

createdSincestring · date-timeOptional

Include only LoRa bindings created at or after the provided date and time. The date-time must be in ISO 8601 format.

modifiedBeforestring · date-timeOptional

Include only LoRa bindings modified before the provided date and time. The date-time must be in ISO 8601 format.

modifiedSincestring · date-timeOptional

Include only LoRa bindings modified at or after the provided date and time. The date-time must be in ISO 8601 format.

Responses
200

Page of filtered LoRa bindings. Only bindings that are accessible to the caller are returned.

application/json
Responseall of

A paginated list of LoRa bindings

and
get
/lora/bindings
No content

Create a new LoRa binding.

post

Create a new LoRa binding.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

A binding of a device to the LoRa connector.

idstring · uuidRead-onlyOptional

The id of the binding.

Example: 224ecc46-291d-482b-993f-c8b508adb0da
deviceIdstring · uuidRequired

The id of the device that is bound to the LoRa connector by the binding.

Example: 11fb8757-c3a7-4a53-96e8-8d6b5a2f3b05
createdAtstring · date-timeRead-onlyOptional

The timestamp when the binding is created in the system.

Example: 2025-09-01T23:00:00.000Z
createdBystringRead-onlyOptional

The user who created the binding.

Example: principal/9ebbb3b1-1b6b-46e7-8d58-bb8fe7ae24d4
modifiedAtstring · date-timeRead-onlyOptional

The timestamp when the binding is last modified in the system.

Example: 2025-09-01T23:00:00.000Z
modifiedBystringRead-onlyOptional

The user who last modified the binding.

Example: principal/9ebbb3b1-1b6b-46e7-8d58-bb8fe7ae24d4
appEuistringRequired

A globally unique identifier of the target application server. Must be a hex value with size 16 (8 bytes)

Example: 51b5a651b5a32b51Pattern: ^[0-9a-fA-F]{16}$
appKeystringWrite-onlyOptional

The encryption key used for messages during every over the air activation.

Example: abe284ec8f8a063a0790d782b7b4f7ccPattern: ^[0-9a-fA-F]{32}$
statusstringRequired

The status of a LoRa binding. Known values include: INVENTORY and ACTIVE

Responses
post
/lora/bindings
No content

Retrieve a LoRa binding by ID.

get
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
bindingIdstring · uuidRequired

LoRa binding identifier.

Responses
200

The LoRa binding.

application/json
get
/lora/bindings/{bindingId}
No content

Update a LoRa binding.

put
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
bindingIdstring · uuidRequired

LoRa binding identifier.

Body

A binding of a device to the LoRa connector.

idstring · uuidRead-onlyOptional

The id of the binding.

Example: 224ecc46-291d-482b-993f-c8b508adb0da
deviceIdstring · uuidRequired

The id of the device that is bound to the LoRa connector by the binding.

Example: 11fb8757-c3a7-4a53-96e8-8d6b5a2f3b05
createdAtstring · date-timeRead-onlyOptional

The timestamp when the binding is created in the system.

Example: 2025-09-01T23:00:00.000Z
createdBystringRead-onlyOptional

The user who created the binding.

Example: principal/9ebbb3b1-1b6b-46e7-8d58-bb8fe7ae24d4
modifiedAtstring · date-timeRead-onlyOptional

The timestamp when the binding is last modified in the system.

Example: 2025-09-01T23:00:00.000Z
modifiedBystringRead-onlyOptional

The user who last modified the binding.

Example: principal/9ebbb3b1-1b6b-46e7-8d58-bb8fe7ae24d4
appEuistringRequired

A globally unique identifier of the target application server. Must be a hex value with size 16 (8 bytes)

Example: 51b5a651b5a32b51Pattern: ^[0-9a-fA-F]{16}$
appKeystringWrite-onlyOptional

The encryption key used for messages during every over the air activation.

Example: abe284ec8f8a063a0790d782b7b4f7ccPattern: ^[0-9a-fA-F]{32}$
statusstringRequired

The status of a LoRa binding. Known values include: INVENTORY and ACTIVE

Responses
200

The updated LoRa binding.

application/json
put
/lora/bindings/{bindingId}
No content

Delete a LoRa binding.

delete
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
bindingIdstring · uuidRequired

LoRa Binding identifier.

Responses
delete
/lora/bindings/{bindingId}
204

LoRa binding has been deleted successfully.

No content

HTTP Bindings

Download the specification.

Retrieve HTTP bindings, filtered by query parameters.

get

Retrieve all HTTP bindings that match the query parameters given.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
cursorstring · cursorOptional

String that encodes all necessary information to retrieve a page.

limitintegerOptional

Limit the number of results (per page).

Default: 50
sortstringOptional

Sorting fields separated by comma. Default order is Ascending (ASC), minus(-) should be used in front of field name for Descending (DESC) order.

Example: createdAt,-name
clientIdstring · uuidOptional

Include only HTTP bindings for devices that are owned by the provided clientId. If clientId is omitted, bindings from all devices owned by the calling client are included.

deviceIdstring · uuidOptional

Include only HTTP bindings for the device identified by the provided deviceId.

typestringOptional

Include only HTTP bindings of the specified type. Currently supported values are http-streamline and http-senml.

createdBeforestring · date-timeOptional

Include only HTTP bindings created before the provided date and time. The date-time must be in ISO 8601 format.

createdSincestring · date-timeOptional

Include only HTTP bindings created at or after the provided date and time. The date-time must be in ISO 8601 format.

modifiedBeforestring · date-timeOptional

Include only HTTP bindings modified before the provided date and time. The date-time must be in ISO 8601 format.

modifiedSincestring · date-timeOptional

Include only HTTP bindings modified at or after the provided date and time. The date-time must be in ISO 8601 format.

Responses
200

Page of filtered HTTP bindings. Only bindings that are accessible to the caller are returned.

application/json
Responseall of

A paginated list of HTTP bindings

and
get
/http/bindings
No content

Create a new HTTP binding.

post

Create a new HTTP binding.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

A binding of a device to the HTTP connector, which configures that the device can connect to the Things Platform using HTTP

or
Responses
post
/http/bindings
No content

Retrieve a HTTP binding by ID.

get
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
bindingIdstring · uuidRequired

HTTP binding identifier.

Responses
200

The HTTP binding.

application/json
get
/http/bindings/{bindingId}
No content

Update a HTTP binding.

put
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
bindingIdstring · uuidRequired

HTTP binding identifier.

Body

A binding of a device to the HTTP connector, which configures that the device can connect to the Things Platform using HTTP

or
Responses
200

The updated HTTP binding.

application/json
put
/http/bindings/{bindingId}
No content

Delete a HTTP binding.

delete
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
bindingIdstring · uuidRequired

HTTP Binding identifier.

Responses
delete
/http/bindings/{bindingId}
204

HTTP binding has been deleted successfully.

No content

MQTT Bindings

Download the specification.

Retrieve MQTT bindings, filtered by query parameters.

get

Retrieve all MQTT bindings that match the query parameters given.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
cursorstring · cursorOptional

String that encodes all necessary information to retrieve a page.

limitintegerOptional

Limit the number of results (per page).

Default: 50
sortstringOptional

Sorting fields separated by comma. Default order is Ascending (ASC), minus(-) should be used in front of field name for Descending (DESC) order.

Example: createdAt,-name
clientIdstring · uuidOptional

Include only MQTT bindings for devices that are owned by the provided clientId. If clientId is omitted, bindings from all devices owned by the calling client are included.

deviceIdstring · uuidOptional

Include only MQTT bindings for the device identified by the provided deviceId.

usernamestringOptional

Include only MQTT bindings where the username equals the provided username.

createdBeforestring · date-timeOptional

Include only MQTT bindings created before the provided date and time. The date-time must be in ISO 8601 format.

createdSincestring · date-timeOptional

Include only MQTT bindings created at or after the provided date and time. The date-time must be in ISO 8601 format.

modifiedBeforestring · date-timeOptional

Include only MQTT bindings modified before the provided date and time. The date-time must be in ISO 8601 format.

modifiedSincestring · date-timeOptional

Include only MQTT bindings modified at or after the provided date and time. The date-time must be in ISO 8601 format.

Responses
200

Page of filtered MQTT bindings. Only bindings that are accessible to the caller are returned.

application/json
Responseall of

A paginated list of MQTT bindings

and
get
/mqtt/bindings
No content

Create a new MQTT binding.

post

Create a new MQTT binding.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

A binding of a device to the MQTT connector.

idstring · uuidRead-onlyOptional

The id of the binding.

Example: 224ecc46-291d-482b-993f-c8b508adb0da
deviceIdstring · uuidRequired

The id of the device that is bound to the MQTT connector by the binding.

Example: 11fb8757-c3a7-4a53-96e8-8d6b5a2f3b05
createdAtstring · date-timeRead-onlyOptional

The timestamp when the binding is created in the system.

Example: 2025-09-01T23:00:00.000Z
createdBystringRead-onlyOptional

The user who created the binding.

Example: principal/9ebbb3b1-1b6b-46e7-8d58-bb8fe7ae24d4
modifiedAtstring · date-timeRead-onlyOptional

The timestamp when the binding is last modified in the system.

Example: 2025-09-01T23:00:00.000Z
modifiedBystringRead-onlyOptional

The user who last modified the binding.

Example: principal/9ebbb3b1-1b6b-46e7-8d58-bb8fe7ae24d4
usernamestringRead-onlyOptional

The username the device uses when authenticating with the MQTT connector. This value is set to the device URN by the system when the binding is created.

Example: urn:dev:IMEI:357292748642776:
passwordstring · min: 24Write-onlyOptional

The password the device uses when authenticating with the MQTT connector. Must be at least 24 characters, with at least one lower case letter, upper case letter, number and special character.

Example: G6sdt9{4R8QmORTPt%zW.*:yr@}vRLzc
Responses
post
/mqtt/bindings
No content

Retrieve a MQTT binding by ID.

get
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
bindingIdstring · uuidRequired

MQTT binding identifier.

Responses
200

The MQTT binding.

application/json
get
/mqtt/bindings/{bindingId}
No content

Update a MQTT binding.

put
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
bindingIdstring · uuidRequired

MQTT binding identifier.

Body

A binding of a device to the MQTT connector.

idstring · uuidRead-onlyOptional

The id of the binding.

Example: 224ecc46-291d-482b-993f-c8b508adb0da
deviceIdstring · uuidRequired

The id of the device that is bound to the MQTT connector by the binding.

Example: 11fb8757-c3a7-4a53-96e8-8d6b5a2f3b05
createdAtstring · date-timeRead-onlyOptional

The timestamp when the binding is created in the system.

Example: 2025-09-01T23:00:00.000Z
createdBystringRead-onlyOptional

The user who created the binding.

Example: principal/9ebbb3b1-1b6b-46e7-8d58-bb8fe7ae24d4
modifiedAtstring · date-timeRead-onlyOptional

The timestamp when the binding is last modified in the system.

Example: 2025-09-01T23:00:00.000Z
modifiedBystringRead-onlyOptional

The user who last modified the binding.

Example: principal/9ebbb3b1-1b6b-46e7-8d58-bb8fe7ae24d4
usernamestringRead-onlyOptional

The username the device uses when authenticating with the MQTT connector. This value is set to the device URN by the system when the binding is created.

Example: urn:dev:IMEI:357292748642776:
passwordstring · min: 24Write-onlyOptional

The password the device uses when authenticating with the MQTT connector. Must be at least 24 characters, with at least one lower case letter, upper case letter, number and special character.

Example: G6sdt9{4R8QmORTPt%zW.*:yr@}vRLzc
Responses
200

The updated MQTT binding.

application/json
put
/mqtt/bindings/{bindingId}
No content

Delete a MQTT binding.

delete
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
bindingIdstring · uuidRequired

MQTT Binding identifier.

Responses
delete
/mqtt/bindings/{bindingId}
204

MQTT binding has been deleted successfully.

No content
PreviousGetting Started with the APINextDevices

Last updated

Was this helpful?