Overview
This endpoint retrieves the current status of any asynchronous remediation job. By providing the remediationId returned when you initiated an action, you can poll this endpoint to track its progress. The response includes the job's overall status and a count of successful and failed endpoint responses. Use this API after initiating any remediation action that returns a job ID. It's the required method for programmatically determining when a long-running task is complete and whether it succeeded or failed on the target endpoints. This API provides a non-blocking mechanism to track long-running jobs, allowing your applications to manage asynchronous response actions efficiently.
Authentication
Authentication type: Bearer Token, API Key.
You can create a token using client credentials obtained through the developer portal. The API Key (x-api-key) is provided in your onboarding email or on the API Access Management page.
Path (or URL)
GET https://{Trellix EDR_gateway_URL}/edr/v2/remediation/queue-jobs/{remediationId}
Request
Request headers
Authorization: Bearer <your_bearer_token> Content-Type: application/vnd.api+json x-api-key: <your_api_key> Accept-Encoding: gzip
Authorization: This header is used to authenticate your request. You need to replace
<your_bearer_token>with the actual token you generate.Content-Type: This header tells the server that the request body format is
json:api. Even though this specific call has no request body, the API requires this header.x-api-key: This is a custom header required by the Trellix API for authentication. You'll need to replace
<your_api_key>with the key from your onboarding email or the API Access Management page.Accept-Encoding: This is an optional header you can include to tell the server you can accept a compressed response (using gzip), which can make the data transfer faster.
Request parameters
Parameters | Data type/Values | Description |
|---|---|---|
remediationId | string | ID of the particular remediation whose status is needed. Example:
|
Response
Response example
{
"data": {
"type": "queue-jobs",
"id": "hr-5432",
"attributes": {
"status": "in-progress",
"successHostResponses": 0,
"errorHostResponses": 1
}
}
}Response codes
Status | Response | Description |
|---|---|---|
200 | OK | Your request was processed successfully. The server has returned the requested data. |
400 | Bad request | The server couldn't understand your request, likely due to a syntax error or an invalid parameter. |
401 | Access denied request | Your request was rejected because it lacks valid authentication credentials. Check your API key and token. |
403 | Forbidden | You are not authorized to access this resource. While your credentials may be valid, you don't have the necessary permissions. |
404 | Not Found | The specific resource or endpoint you requested does not exist. |
415 | Unsupported Media Type | The server rejected your request because the data format |
429 | Too Many Requests | You've exceeded the rate limit by sending too many requests in a short period. The |
500 | Internal Server Error | Something went wrong on the server's end. This is not an issue with your request. |