• Home
  • Dynatrace API
  • Environment
  • ActiveGates
  • ActiveGates auto-update jobs
  • GET an auto-update job

ActiveGate API - GET an auto-update job

Gets the parameters of the specified ActiveGate auto-update job.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs/{jobId}
Environment ActiveGatehttps://{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

ParameterTypeDescriptionInRequired
agIdstring

The ID of the required ActiveGate.

pathrequired
jobIdstring

A unique identifier for a update-job of ActiveGate.

pathrequired

Response

Response codes

CodeTypeDescription
200UpdateJob

Success

404ErrorEnvelope

Not found. See response body for details.

Response body objects

The UpdateJob object

Configuration of the ActiveGate update job.

ElementTypeDescription
jobIdstring

The ID of the update job.

jobStatestring

The status of the update job.

The element can hold these values
  • FAILED
  • IN_PROGRESS
  • PENDING
  • ROLLBACK
  • SCHEDULED
  • SKIPPED
  • SUCCEED
updateMethodstring

The method of updating the ActiveGate or its component.

The element can hold these values
  • AUTOMATIC
  • MANUAL_INSTALLATION
  • ON_DEMAND
updateTypestring

The component to be updated.

The element can hold these values
  • ACTIVE_GATE
  • REMOTE_PLUGIN_AGENT
  • SYNTHETIC
  • Z_REMOTE
agTypestring

The type of the ActiveGate.

The element can hold these values
  • CLUSTER
  • ENVIRONMENT
  • ENVIRONMENT_MULTI
startVersionstring

The initial version of the ActiveGate.

environmentsstring[]

A list of environments (specified by IDs) the ActiveGate can connect to.

cancelableboolean

The job can (true) or can't (false) be cancelled at the moment.

timestampinteger

The timestamp of the update job completion.

The null value means the job is still running.

durationinteger

The duration of the update, in milliseconds.

targetVersionstring

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.

errorstring

The information about update error.

Response body JSON model

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

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

plaintext
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

Related topics
  • Dynatrace ActiveGate

    Understand the basic concepts related to ActiveGate.