Getting StartedAPI ReferenceRecipesGitHub
API Reference

Get the status of a connector agent upgrade run.

get
https://cluster.ip.address/v2/connector-agents/upgrade/

Privileges: CLUSTER_VIEW

Returns the current status of a connector agent upgrade run started with POST /connector-agents/upgrade. Returns status, a single state that maps every tenant's state in the run to one overall state, and one status object per tenant included in the run.

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

Specifies the ID of the upgrade run, as returned by POST /connector-agents/upgrade.

Query Params
tenantIds
array of strings

Filters the returned tenantStatuses to only these tenants. Tenants not part of this upgrade run are silently ignored. If omitted, every tenant in the run is returned.

tenantIds
connectionIds
array of int64s

Filters the connectionStatuses within each returned tenant to only these connections. Connections not part of this upgrade run are silently ignored. If omitted, every connection under each returned tenant is returned.

connectionIds
Responses

Updated about 5 hours ago

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

Updated about 5 hours ago

Did this page help you?