Connections

Update connection

Update a device connection's configuration.

Required scope: connections:write

put/api/connections/{id}

Request

  • Base URL: https://api.chirpwireless.io
  • URL: https://api.chirpwireless.io/api/connections/{id}
  • Auth: API key in header X-API-Key and API key in header X-Organization-Id

Path parameters

idstring required

Connection UUID

Request body

configurationobject
connectorIdinteger required
namestring required

Example request

{
  "connectorId": 3,
  "name": "Updated Connection Name"
}

Response

OK

configurationobject
connectedDevicesinteger
connectorIdinteger
connectorType'lorawan' | 'mqtt_cloud' | 'mqtt_external' | 'tracker'
createdAtstring
idstring
namestring
organizationIdstring
updatedAtstring

Example response

{
  "connectedDevices": 5,
  "connectorId": 3,
  "connectorType": "mqtt_cloud",
  "createdAt": "2024-01-15T10:30:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My MQTT Cloud Connection",
  "organizationId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "updatedAt": "2024-01-20T14:22:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.