Non-String Values in the Configuration Field for Connection Options

Specifying a non-string value associated with an individual configuration key within the options.configuration field when updating connections via the Management API (PATCH - /api/v2/connections/{id}) is no longer allowed. In addition, specifying the options.configuration field itself as an array object is also no longer permitted when creating (POST - /api/v2/connections) or updating (PATCH - /api/v2/connections/{id}) connections.

Example of a request message content containing an invalid non-string configuration value for an individual configuration key:

{
    "options": {
        // other options redacted for brevity
        "configuration": { "xyz_count": 1 }
    }
}

Attempting to update a connection using the above configuration results in the following error response:

{
	"statusCode": 400,
	"error": "Bad Request",
	"message": "Payload validation error: 'Expected type string,null but found type integer' on property configuration.xyz_count.",
	"errorCode": "invalid_body"
}

Example of a request message content with an invalid array object for the configuration field itself:

{
    "options": {
        // other options redacted for brevity
        "configuration": ["A", "B"]
    }
}

Attempting to update a connection using the above configuration results in the following error response:

{
	"statusCode": 400,
	"error": "Bad Request",
	"message": "Payload validation error: 'Expected type object,null but found type array' on property configuration (Stores encrypted string only configurations for connections).",
	"errorCode": "invalid_body"
}

• Management API
• Connections

The service imposed additional constraints when creating or updating the configuration field for connections as part of a calendar year 2025 scheduled change to improve the overall experience and consistency around connection configuration.

Tenants with connections using a configuration that is not valid based on the additional constraints received multiple notifications about the planned change between February and August 2025. Starting in October 2025, those tenants will no longer be able to update connections with an invalid configuration syntax.

Management API requests to create or update connections must specify a valid syntax for the options.configuration field. They must provide the configuration field as an object, with strings as keys and associated values.

Example of a request message content containing valid syntax:

{
    "options": {
        // other options redacted for brevity
        "configuration": { "xyz_count": "1", "abc_flag": "true" }
    }
}

When fixing the configuration for a connection that historically relied on a no longer allowed syntax, it is crucial to update any associated logic that may depend on the configuration to support the new syntax. For example, custom database connection scripts that read/process the connection configuration may need to be revised to ensure compatibility with the new requirements.