Process group log monitoring API - DELETE analysis job

Deletes or cancels the specified log analysis job.

The request produces an application/json payload.

DELETE

Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/process-groups/{pgId}/logs/jobs/{jobId}
SaaS https://{your-environment-id}.live.dexp.ae/api/v1/entity/infrastructure/process-groups/{pgId}/logs/jobs/{jobId}

To execute this request, you need the Access logs permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter Type Description In Required

pgId

string

Parameter	Type	Description	In	Required
pgId	string	The entity ID of the process group.	path	required
jobId	string	The ID of the job to be deleted. You can retrieve it from the response of the `POST /entity/infrastructure/process-groups/{pgId}/logs/{logPath}` request.	path	required

The entity ID of the process group.

path

required

jobId

string

The ID of the job to be deleted.

You can retrieve it from the response of the POST /entity/infrastructure/process-groups/{pgId}/logs/{logPath} request.

path

required

Response format

Parameters Example

Element	Type	Description
message	string	The message on successful job deletion.

{
  "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.dexp.ae/api/v1/entity/infrastructure/process-groups/PROCESS_GROUP-54A8B0B75D36E463/logs/jobs/707306f2-f3c2-4f7b-a457-cf00f7a65b1d \
  -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/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