Lists all ActiveGates that have auto-update jobs. The list includes completed jobs (successful or failed) and jobs in progress.
You can narrow down the output by specifying filtering parameters in your request.
The request produces an application/json
payload.
GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/updateJobs |
Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/updateJobs |
To execute this request, you need an access token with activeGates.read
scope.
To learn how to obtain and use it, see Tokens and authentication.
The start of the requested timeframe for update jobs.
You can use one of the following formats:
2021-01-25T05:57:01.123+01:00
. If no time zone is specified, UTC is used. You can use a space character instead of the T
. Seconds and fractions of a second are optional.now-NU/A
, where N
is the amount of time, U
is the unit of time, and A
is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w
is one year back, aligned by a week.
You can also specify relative timeframe without an alignment: now-NU
.
Supported time units for the relative timeframe are:
m
: minutesh
: hoursd
: daysw
: weeksM
: monthsy
: yearsIf not set, the relative timeframe of one day is used (now-1d
).
Maximum timeframe is 31 days.
The end of the requested timeframe for update jobs.
You can use one of the following formats:
2021-01-25T05:57:01.123+01:00
. If no time zone is specified, UTC is used. You can use a space character instead of the T
. Seconds and fractions of a second are optional.now-NU/A
, where N
is the amount of time, U
is the unit of time, and A
is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w
is one year back, aligned by a week.
You can also specify relative timeframe without an alignment: now-NU
.
Supported time units for the relative timeframe are:
m
: minutesh
: hoursd
: daysw
: weeksM
: monthsy
: yearsIf not set, the current timestamp is used.
Filters the resulting set of update jobs by the specified initial version.
Specify the comparison operator here.
EQUAL
GREATER
GREATER_EQUAL
LOWER
LOWER_EQUAL
Filters the resulting set of update-jobs by the initial version (required format <major>.<minor>.<revision>
).
Filters the resulting set of update-jobs by the update type.
ACTIVE_GATE
REMOTE_PLUGIN_AGENT
SYNTHETIC
Z_REMOTE
Filters the resulting set of update jobs by the specified target version.
Specify the comparison operator here.
EQUAL
GREATER
GREATER_EQUAL
LOWER
LOWER_EQUAL
Filters the resulting set of update-jobs by the target version (required format <major>.<minor>.<revision>
).
If true
, filters the resulting set of update jobs to the most recent update of each type.
UpdateJobsAll
objectA list of ActiveGates with update jobs.
UpdateJobList
objectA list of update jobs of the ActiveGate.
The ID of the ActiveGate.
UpdateJob
objectConfiguration of the ActiveGate update job.
The type of the ActiveGate.
CLUSTER
ENVIRONMENT
ENVIRONMENT_MULTI
The job can (true
) or can't (false
) be cancelled at the moment.
The duration of the update, in milliseconds.
A list of environments (specified by IDs) the ActiveGate can connect to.
The information about update error.
The ID of the update job.
The status of the update job.
FAILED
IN_PROGRESS
PENDING
ROLLBACK
SCHEDULED
SKIPPED
SUCCEED
The initial version of the ActiveGate.
The target version of the update.
Specify the version in the <major>.<minor>.<revision>.<timestamp>
format.
To update to the latest available version, use the latest
value.
The timestamp of the update job completion.
The null
value means the job is still running.
The method of updating the ActiveGate or its component.
AUTOMATIC
MANUAL_INSTALLATION
ON_DEMAND
The component to be updated.
ACTIVE_GATE
REMOTE_PLUGIN_AGENT
SYNTHETIC
Z_REMOTE
{"allUpdateJobs": [{"agId": "0x3efdd092","updateJobs": [{"agType": "ENVIRONMENT","cancelable": false,"duration": 3608000,"environments": ["string"],"error": "string","jobId": "-3524498778810258605","jobState": "SUCCEED","startVersion": "1.185.0.20200201-120000","targetVersion": "1.190.0.20200301-130000","timestamp": 1582031917814,"updateMethod": "AUTOMATIC","updateType": "ACTIVE_GATE"}]}]}