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

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
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs

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

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 2019-12-21T05: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. For example, now-1y/w is one year back, aligned by a week. The alignment rounds to the past. 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.

query optional
to string

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 2019-12-21T05: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. For example, now-1y/w is one year back, aligned by a week. The alignment rounds to the past. 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.

query optional
startVersionCompareType string

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

Specify the comparison operator here.

The startVersionCompareType element can hold these values.
query optional
startVersion string

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

query optional
updateType string

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

The updateType element can hold these values.
query optional
targetVersionCompareType string

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

Specify the comparison operator here.

The targetVersionCompareType element can hold these values.
query optional
targetVersion string

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

query optional

Possible values

Possible values for the targetVersionCompareType element:

  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL

Possible values for the updateType element:

  • ACTIVE_GATE
  • REMOTE_PLUGIN_AGENT
  • SYNTHETIC
  • Z_REMOTE

Possible values for the startVersionCompareType element:

  • EQUAL
  • GREATER
  • GREATER_EQUAL
  • LOWER
  • LOWER_EQUAL

Response format

The UpdateJobList object

A list of update jobs of the ActiveGate.

Element Type Description
agId string

The ID of the ActiveGate.

updateJobs UpdateJob[]

A list of update jobs of the ActiveGate.

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.

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 all auto-update jobs of the ActiveGate with the ID of 2100855201.

The API token is passed in the Authorization header.

Curl

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

Request URL

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

Response body

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