• Home
  • Dynatrace API
  • Environment
  • ActiveGates
  • ActiveGates auto-update jobs
  • GET all auto-update jobs

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.

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

ParameterTypeDescriptionInRequired
agIdstring

The ID of the required ActiveGate.

pathrequired
fromstring

The start of the requested timeframe for update jobs.

You can use one of the following formats:

  • Timestamp in UTC milliseconds.
  • Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.
  • Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are:
    • m: minutes
    • h: hours
    • d: days
    • w: weeks
    • M: months
    • y: years

If not set, the relative timeframe of one week is used (now-1w).

Maximum timeframe is 31 days.

queryoptional
tostring

The end of the requested timeframe for update jobs.

You can use one of the following formats:

  • Timestamp in UTC milliseconds.
  • Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional.
  • Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are:
    • m: minutes
    • h: hours
    • d: days
    • w: weeks
    • M: months
    • y: years

If not set, the current timestamp is used.

queryoptional
startVersionCompareTypestring

Filters the resulting set of update jobs by the specified initial version.

Specify the comparison operator here.

The element can hold these values
  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL
queryoptional
startVersionstring

Filters the resulting set of update-jobs by the initial version (required format <major>.<minor>.<revision>).

queryoptional
updateTypestring

Filters the resulting set of update-jobs by the update type.

The element can hold these values
  • ACTIVE_GATE
  • REMOTE_PLUGIN_AGENT
  • SYNTHETIC
  • Z_REMOTE
queryoptional
targetVersionCompareTypestring

Filters the resulting set of update jobs by the specified target version.

Specify the comparison operator here.

The element can hold these values
  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL
queryoptional
targetVersionstring

Filters the resulting set of update-jobs by the target version (required format <major>.<minor>.<revision>).

queryoptional
lastUpdatesboolean

If true, filters the resulting set of update jobs to the most recent update of each type.

queryoptional

Response

Response codes

CodeTypeDescription
200UpdateJobList

Success

404ErrorEnvelope

Not found. See response body for details.

Response body objects

The UpdateJobList object

A list of update jobs of the ActiveGate.

ElementTypeDescription
updateJobsUpdateJob[]

A list of update jobs of the ActiveGate.

agIdstring

The ID of the ActiveGate.

The UpdateJob object

Configuration of the ActiveGate update job.

ElementTypeDescription
cancelableboolean

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

environmentsstring[]

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

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.

jobIdstring

The ID of the update job.

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.

durationinteger

The duration of the update, in milliseconds.

timestampinteger

The timestamp of the update job completion.

The null value means the job is still running.

errorstring

The information about update error.

Response body JSON model

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

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

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

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/2100855201/updateJobs

Response body

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

Related topics
  • Dynatrace ActiveGate

    Understand the basic concepts related to ActiveGate.