25.09.2024

Breaking Change: Connectors API

A breaking change to our Connectors API will be going into effect on September 25. This update is part of our ongoing efforts to strengthen security even further. 

This change will affect the response object when you retrieve Connectors. The API won’t return certain configuration options to the client. With this update, instead of returning the specific properties, you will see a meta property with is_set and last_updated_at. If is_set is set to false and last_updated_at is set to a value then the value of that property has been deleted and is not set at the time.

You can find the Connectors affected, a detailed breakdown of the changes, and what you should be aware of below. 

Affected Connectors 

The response object of the following Connectors will change 

• TLS Connector
• Microsoft Azure DPS Connector
• Microsoft Azure IoT Connector

TLS Connector

The response object will no longer return the fields key, cert, and ca. 

An example of a new TLS connector configuration response object:

{
    "name": "my-tls-connector",
    "type": "tls",
    "passthrough": [],
    "tags": [],
    "options": {
        "host": "foobar",
        "port": 1234
    },
    "meta": {
        "ca": {
            "is_set": true,
            "last_updated_at": "2023-10-17T10:02:01.222Z"
        },
        "key": {
            "is_set": true,
            "last_updated_at": "2023-10-17T10:02:01.222Z"
        },
        "cert": {
            "is_set": true,
            "last_updated_at": "2023-10-17T10:02:01.222Z"
        }
    }
} 

Microsoft Azure DPS Connector

The response object will not return the key, keypass, and cert properties.

An example of a new Azure DPS Connector configuration object returned from the API, see below:

{
    "name": "my-azure-dps-connector",
    "type": "microsoft_azure_dps",
    "passthrough": [],
    "tags": [],
    "options": {
        "idScope": "10",
        "provisioningHost": "global.azure-devices-provisioning.net",
        "defaultProtocol": "tcp",
        "defaultPort": 1234
    },
    "meta": {
        "key": {
            "is_set": true,
            "last_updated_at": "2023-10-17T10:50:26.685Z"
        },
        "cert": {
            "is_set": true,
            "last_updated_at": "2023-10-17T10:50:26.685Z"
        },
        "keyPass": {
            "is_set": true,
            "last_updated_at": "2023-10-17T10:50:26.685Z"
        }
    }
}

Microsoft Azure IoT Connector

The Microsoft Azure IoT Connector will no longer return the connectionString property.

See below for an example of how a new Microsoft Azure IoT Connector configuration object returned from the API:

{
    "name": "my-microsoft-azure-iot-connector",
    "type": "microsoft_azure_iot",
    "passthrough": [],
    "tags": [],
    "options": {},
    "meta": {
        "connectionString": {
            "is_set": true,
            "last_updated_at": "2023-10-17T10:58:09.003Z"
        }
    }
}

For more information, check out our API documentation linked here.

If you have any questions or need assistance, please don’t hesitate to reach out to our support team at support@onomondo.com.

Thank you for your attention and your continued trust in our services.