ActiveGate API - GET ActiveGates with auto-update jobs
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 |
Authentication
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.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
from | string | The start of the requested timeframe for update jobs. You can use one of the following formats:
If not set, the relative timeframe of one day is used ( Maximum timeframe is 31 days. | query | optional |
to | string | The end of the requested timeframe for update jobs. You can use one of the following formats:
If not set, the current timestamp is used. | query | optional |
startVersionCompareType | string | Filters the resulting set of update jobs by the specified initial version. Specify the comparison operator here.
| query | optional |
startVersion | string | Filters the resulting set of update-jobs by the initial version (required format | query | optional |
updateType | string | Filters the resulting set of update-jobs by the update type.
| query | optional |
targetVersionCompareType | string | Filters the resulting set of update jobs by the specified target version. Specify the comparison operator here.
| query | optional |
targetVersion | string | Filters the resulting set of update-jobs by the target version (required format | query | optional |
lastUpdates | boolean | If | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Update | Success |
400 | Error | Failed. The input is invalid. |
4XX | Error | Client side error. |
5XX | Error | Server side error. |
Response body objects
The UpdateJobsAll
object
A list of ActiveGates with update jobs.
Element | Type | Description |
---|---|---|
allUpdateJobs | Update | A list of ActiveGates with update jobs. |
The UpdateJobList
object
A list of update jobs of the ActiveGate.
Element | Type | Description |
---|---|---|
agId | string | The ID of the ActiveGate. |
updateJobs | Update | A list of update jobs of the ActiveGate. |
The UpdateJob
object
Configuration of the ActiveGate update job.
Element | Type | Description |
---|---|---|
agType | string | The type of the ActiveGate.
|
cancelable | boolean | The job can ( |
duration | integer | The duration of the update, in milliseconds. |
environments | string[] | A list of environments (specified by IDs) the ActiveGate can connect to. |
error | string | The information about update error. |
jobId | string | The ID of the update job. |
jobState | string | The status of the update job.
|
startVersion | string | The initial version of the ActiveGate. |
targetVersion | string | The target version of the update. Specify the version in the To update to the latest available version, use the |
timestamp | integer | The timestamp of the update job completion. The |
updateMethod | string | The method of updating the ActiveGate or its component.
|
updateType | string | The component to be updated.
|
Response body JSON model
{"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"}]}]}