Creates a new auto-update job on the specified ActiveGate.
The job updates the ActiveGate to the specified version. You can fetch the list of available versions with the GET available versions of ActiveGate call.
The request consumes and produces an application/json payload.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs |
| Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs |
To execute this request, you need an access token with activeGates.write scope.
To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| agId | string | The ID of the required ActiveGate. | path | Required |
| body | Update | JSON body of the request, containing update-job parameters. | body | Required |
UpdateJob objectConfiguration of the ActiveGate update job.
| Element | Type | Description | Required |
|---|---|---|---|
| agType | string | The type of the ActiveGate. The element can hold these values
| Optional |
| cancelable | boolean | The job can ( | Optional |
| duration | integer | The duration of the update, in milliseconds. | Optional |
| environments | string[] | A list of environments (specified by IDs) the ActiveGate can connect to. | Optional |
| error | string | The information about update error. | Optional |
| jobId | string | The ID of the update job. | Optional |
| jobState | string | The status of the update job. The element can hold these values
| Optional |
| startVersion | string | The initial version of the ActiveGate. | Optional |
| targetVersion | string | The target version of the update. Specify the version in the To update to the latest available version, use the | Required |
| timestamp | integer | The timestamp of the update job completion. The | Optional |
| updateMethod | string | The method of updating the ActiveGate or its component. The element can hold these values
| Optional |
| updateType | string | The component to be updated. The element can hold these values
| Optional |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"agType": "ENVIRONMENT","cancelable": false,"duration": 3608000,"environments": ["string"],"error": "string","jobId": "-3524498778810258605","jobState": "SUCCEED","startVersion": "1.185.0.20200201-120000","targetVersion": "1.190.0.20200301-130000","timestamp": 1582031917814,"updateMethod": "AUTOMATIC","updateType": "ACTIVE_GATE"}
| Code | Type | Description |
|---|---|---|
| 201 | Update | Success. The update-job have been created. |
| 400 | Error | Failed. The input is invalid. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
UpdateJob objectConfiguration of the ActiveGate update job.
| Element | Type | Description |
|---|---|---|
| agType | string | The type of the ActiveGate. The element can hold these values
|
| cancelable | boolean | The job can ( |
| duration | integer | The duration of the update, in milliseconds. |
| environments | string[] | A list of environments (specified by IDs) the ActiveGate can connect to. |
| error | string | The information about update error. |
| jobId | string | The ID of the update job. |
| jobState | string | The status of the update job. The element can hold these values
|
| startVersion | string | The initial version of the ActiveGate. |
| targetVersion | string | The target version of the update. Specify the version in the To update to the latest available version, use the |
| timestamp | integer | The timestamp of the update job completion. The |
| updateMethod | string | The method of updating the ActiveGate or its component. The element can hold these values
|
| updateType | string | The component to be updated. The element can hold these values
|
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code |
| constraintViolations | Constraint | A list of constraint violations |
| message | string | The error message |
ConstraintViolation objectA list of constraint violations
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"agType": "ENVIRONMENT","cancelable": false,"duration": 3608000,"environments": ["string"],"error": "string","jobId": "-3524498778810258605","jobState": "SUCCEED","startVersion": "1.185.0.20200201-120000","targetVersion": "1.190.0.20200301-130000","timestamp": 1582031917814,"updateMethod": "AUTOMATIC","updateType": "ACTIVE_GATE"}
{"error": {"code": 1,"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}],"message": "string"}}
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json payload.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs/validator |
| Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/validator |
To execute this request, you need an access token with activeGates.write scope.
To learn how to obtain and use it, see Tokens and authentication.
| Code | Type | Description |
|---|---|---|
| 204 | - | Validated. The submitted update-job is valid. Response doesn't have a body. |
| 400 | Error | Failed. The input is invalid. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code |
| constraintViolations | Constraint | A list of constraint violations |
| message | string | The error message |
ConstraintViolation objectA list of constraint violations
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"error": {"code": 1,"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}],"message": "string"}}
In this example, the request creates an update job to update the ActiveGate with the ID of 1812885988 to the 1.198.0.20200630-163221 version.
The API token is passed in the Authorization header.
curl -L -X POST 'https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/1812885988/updateJobs' \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \-H 'Content-Type: application/json' \--data-raw '{"targetVersion": "1.198.0.20200630-163221"}'
https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/1812885988/updateJobs
{"targetVersion": "1.198.0.20200630-163221"}
{"jobId": "-7240069678607892845","jobState": "PENDING","updateMethod": null,"updateType": null,"cancelable": true,"startVersion": "1.195.5.20200522-174041","targetVersion": "1.198.0.20200630-163221","timestamp": null,"agType": "ENVIRONMENT","environments": ["mySampleEnv"],"error": null,"duration": null}
201