ActiveGate API - DELETE an auto-update job

Deletes the specified ActiveGate auto-update job.

DELETESaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/updateJobs/{jobId}
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/{agId}/updateJobs/{jobId}

Authentication

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.

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

Response codes

Code
Type
Description
204
-

Success. The update-job have been deleted. Response doesn't have a body.

400

Failed. The input is invalid.

404

Not found. See response body for details.

4XX

Client side error.

5XX

Server side error.

Example

In this example, the request deletes the update job with the ID of -7240069678607892845 from the ActiveGate with the ID of 1812885988. The response code of 204 indicates that the deletion was successful.

The API token is passed in the Authorization header.

Curl

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

Request URL

https://mySampleEnv.live.dynatrace.com/api/v2/activeGates/1812885988/updateJobs/-7240069678607892845

Response code

204

Related topics