ActiveGate API - GET all auto-update jobs
Lists all update jobs for the specified ActiveGate. The list includes completed jobs (successful or failed) and jobs in progress.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/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 |
---|---|---|---|---|
agId | string | The ID of the required ActiveGate. | path | 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 week 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 |
404 | ErrorEnvelope | Not found. See response body for details. |
Response body objects
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
{
"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"
}
]
}
Example
In this example, the request lists all auto-update jobs of the ActiveGate with the ID of 2100855201.
The API token is passed in the Authorization header.
Curl
curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/2100855201/updateJobs' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/2100855201/updateJobs
Response body
{
"agId": "2100855201",
"updateJobs": [
{
"jobId": "-3137933319273211278",
"jobState": "SUCCEED",
"updateMethod": "MANUAL_INSTALLATION",
"updateType": "ACTIVE_GATE",
"cancelable": false,
"startVersion": "1.198.0.20200629-221007",
"targetVersion": "1.198.0.20200630-163221",
"timestamp": 1593683526719,
"agType": "ENVIRONMENT",
"environments": [
"mySampleEnv"
],
"error": null,
"duration": 556574
},
{
"jobId": "-6733215466838702651",
"jobState": "SUCCEED",
"updateMethod": "AUTOMATIC",
"updateType": "REMOTE_PLUGIN_AGENT",
"cancelable": false,
"startVersion": "1.198.0.20200629-123323",
"targetVersion": "1.198.0.20200630-155408",
"timestamp": 1593545522797,
"agType": "ENVIRONMENT",
"environments": [
"mySampleEnv"
],
"error": null,
"duration": 42669
}
]
}
Response code
200