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	Managed	`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 Read ActiveGates (activeGates.read) permission assigned to your API token. 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	optional
jobId	string	A unique identifier for a update-job of ActiveGate.	path	optional

Response

Response codes

Code	Type	Description
200	UpdateJob	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	Required
agType	string	The type of the ActiveGate. The element can hold these values `CLUSTER` `ENVIRONMENT` `ENVIRONMENT_MULTI`	optional
updateMethod	string	The method of updating the ActiveGate or its component. The element can hold these values `AUTOMATIC` `MANUAL_INSTALLATION` `ON_DEMAND`	optional
updateType	string	The component to be updated. The element can hold these values `ACTIVE_GATE` `REMOTE_PLUGIN_AGENT` `SYNTHETIC` `Z_REMOTE`	optional
jobId	string	The ID of the update job.	optional
environments	string[]	A list of environments (specified by IDs) the ActiveGate can connect to.	optional
startVersion	string	The initial version of the ActiveGate.	optional
jobState	string	The status of the update job. The element can hold these values `FAILED` `IN_PROGRESS` `PENDING` `ROLLBACK` `SCHEDULED` `SKIPPED` `SUCCEED`	optional
cancelable	boolean	The job can (`true`) or can't (`false`) be cancelled at the moment.	optional
duration	integer	The duration of the update, in milliseconds.	optional
timestamp	integer	The timestamp of the update job completion. The `null` value means the job is still running.	optional
error	string	The information about update error.	optional
targetVersion	string	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.	required

Response body JSON model

json
{
  "agType": "ENVIRONMENT",
  "updateMethod": "AUTOMATIC",
  "updateType": "ACTIVE_GATE",
  "jobId": "-3524498778810258605",
  "environments": [
    "string"
  ],
  "startVersion": "1.185.0.20200201-120000",
  "jobState": "SUCCEED",
  "cancelable": false,
  "duration": 3608000,
  "timestamp": 1582031917814,
  "error": "string",
  "targetVersion": "1.190.0.20200301-130000"
}

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

bash
curl -L -X GET 'https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

http
https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/2131628184/updateJobs/-7537034309286328684

Response body

json
{
  "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