Process group logs API v1 - DELETE analysis job

deprecated

This API is deprecated.

  • For Log monitoring - Custom devices, Hosts, or Process Groups, what to use instead depends on which version of Log Monitoring you use:
  • For Calculated metrics - Log Monitoring, use the Settings API endpoint with schemaId builtin:logmonitoring.schemaless-log-metric.

Deletes or cancels the specified log analysis job.

The request produces an application/json payload.

DELETESaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/process-groups/{pgId}/logs/jobs/{jobId}
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{pgId}/logs/jobs/{jobId}

Authentication

To execute this request, you need an access token with LogExport scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
pgIdstring

The Dynatrace entity ID of the required process group.

pathrequired
jobIdstring

The ID of the log analysis job to be deleted.

You can retrieve it from the response of the POST analysis job request.

pathrequired

Response

Response codes

CodeTypeDescription
200LogJobDeleteResult

Success. The job has been deleted.

400ErrorEnvelope

Failed. See response body for details

404ErrorEnvelope

Not found. See response body for details

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The LogJobDeleteResult object

ElementTypeDescription
messagestring-

Response body JSON model

{
  "message": "string"
}

Example

In this example the request deletes the log analysis job with the ID 32502e45-ed3d-47b9-b150-23e787ee285e.

The API token is passed in the Authorization header.

The response confirms job deletion.

Curl

curl -X DELETE \
  https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-54A8B0B75D36E463/logs/jobs/707306f2-f3c2-4f7b-a457-cf00f7a65b1d \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-54A8B0B75D36E463/logs/jobs/707306f2-f3c2-4f7b-a457-cf00f7a65b1d

Response content

{
  "message":"Job has been deleted successfully"
}

Response code

200

Related topics