Upgrade connector agents.

Privileges: CLUSTER_MODIFY

Upgrade connector agents to the version of the connector agent installer the cluster ships. Only connections of type connector agent are eligible. The request body decides the scope: an empty JSON object upgrades every connector agent under all tenants (fleet-wide); tenantIds upgrades all connections under the listed tenants; connectionIds upgrades just those connections; both lists may be combined. The upgrade is processed asynchronously by the cluster. This API targets only connector agent type connections. If a non connector agent type connection is provided as part of connectionIds, entire request will be rejected with an error. By default, the upgrade is retried forever and is configurable via the retryForever flag. This returns a UUID that can be used to track the upgrade progress.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Specifies the scope of the connector agent upgrade.

Request params for upgrading connector agents. If both tenantIds and connectionIds are provided, the two scopes are merged: all connections under the listed tenants along with the individually listed connections are upgraded. If both are empty/absent, the upgrade is scoped to all connector agents under all tenants (fleet-wide).

connectionIds
array of int64s | null

Specifies the specific connections whose connector agents should be upgraded.

connectionIds
boolean | null
Defaults to true

When true or omitted, the upgrade is retried indefinitely until it succeeds. When false, the cluster retries up to 3 times before giving up.

tenantIds
array of strings | null

Specifies the tenants whose connector agents should be upgraded (all connections under each listed tenant).

tenantIds
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json