ActiveGate API - GET an auto-update job
Gets the parameters of the specified ActiveGate auto-update job.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId} |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs/{jobId} | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId} |
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 |
jobId | string | A unique identifier for a update-job of ActiveGate. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Update | Success |
404 | ErrorEnvelope | Not found. See response body for details. |
Response body objects
The UpdateJob
object
Configuration of the ActiveGate update job.
Element | Type | Description |
---|---|---|
jobState | string | The status of the update job. |
updateMethod | string | The method of updating the ActiveGate or its component. |
updateType | string | The component to be updated. |
agType | string | The type of the ActiveGate. |
startVersion | string | The initial version of the ActiveGate. |
environments | string[] | A list of environments (specified by IDs) the ActiveGate can connect to. |
jobId | string | The ID of the update job. |
error | string | The information about update error. |
targetVersion | string | The target version of the update. Specify the version in the To update to the latest available version, use the |
cancelable | boolean | The job can ( |
duration | integer | The duration of the update, in milliseconds. |
timestamp | integer | The timestamp of the update job completion. The |
Response body JSON model
{
"jobState": "SUCCEED",
"updateMethod": "AUTOMATIC",
"updateType": "ACTIVE_GATE",
"agType": "ENVIRONMENT",
"startVersion": "1.185.0.20200201-120000",
"environments": [
"string"
],
"jobId": "-3524498778810258605",
"error": "string",
"targetVersion": "1.190.0.20200301-130000",
"cancelable": false,
"duration": 3608000,
"timestamp": 1582031917814
}
Example
In this example, the request lists the parameters of the auto-update job with the ID of -7537034309286328684 from the ActiveGate with the ID of 2131628184.
The API token is passed in the Authorization header.
Curl
curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684
Response body
{
"jobId": "-7537034309286328684",
"jobState": "SUCCEED",
"updateMethod": "AUTOMATIC",
"updateType": "SYNTHETIC",
"cancelable": false,
"startVersion": "1.198.0.20200629-183024",
"targetVersion": "1.198.0.20200630-114457",
"timestamp": 1593518788274,
"agType": "ENVIRONMENT",
"environments": [
"mySampleEnv"
],
"error": null,
"duration": 596047
}
Response code
200