ActiveGates API - GET an auto-update job

Gets the parameters of the specified auto-update job.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

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}

Authentication

To execute this request, you need the Read ActiveGates using API V2 (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	required
jobId	string	A unique identifier for a update-job of ActiveGate.	path	required

Response format

Response parameters JSON model

The UpdateJob object

Configuration of the ActiveGate update job.

Element	Type	Description
jobId	string	The ID of the update job.
jobState	string	The status of the update job. The jobState element can hold these values.
updateMethod	string	The method of updating the ActiveGate or its component. The updateMethod element can hold these values.
updateType	string	The component to be updated. The updateType element can hold these values.
cancelable	boolean	The job can (`true`) or can't (`false`) be cancelled at the moment.
startVersion	string	The initial version of the ActiveGate.
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.
timestamp	integer	The timestamp of the update job completion. The `null` value means the job is still running.
agType	string	The type of the ActiveGate. The agType element can hold these values.
environments	string[]	A list of environments (specified by IDs) the ActiveGate can connect to.
error	string	The information about update error.
duration	integer	The duration of the update, in milliseconds.

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

Possible values

Possible values for the agType element in the UpdateJob object:

CLUSTER
ENVIRONMENT
ENVIRONMENT_MULTI

Possible values for the updateType element in the UpdateJob object:

ACTIVE_GATE
REMOTE_PLUGIN_AGENT
SYNTHETIC
Z_REMOTE

Possible values for the updateMethod element in the UpdateJob object:

AUTOMATIC
MANUAL_INSTALLATION
ON_DEMAND

Possible values for the jobState element in the UpdateJob object:

FAILED
IN_PROGRESS
PENDING
ROLLBACK
SKIPPED
SUCCEED

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 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