--- title: "Get status" slug: "get-status-2" tags: ["Product Usage", "EDR", "Endpoint Security"] updated: 2026-09-03T18:14:40Z published: 2026-09-03T18:14:40Z canonical: "docs.trellix.com/get-status-2" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.trellix.com/llms.txt > Use this file to discover all available pages before exploring further. # Get status ### Overview This endpoint retrieves the current status of a previously initiated asynchronous search. By providing the unique `search-id` in the path, you can poll this endpoint to track the progress of a real-time or historical search. While the job is running, the API returns the current status; once complete, it provides a redirect to the location where the final results can be retrieved. You should use this API after initiating a search to monitor its progress. It is designed to be polled periodically within a script or automated workflow to determine when the search results are ready for collection. ### Authentication Authentication type: Bearer Token, API Key. You can create a token using client credentials obtained through the [developer portal](https://developer.manage.trellix.com/). 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/searches/queue-jobs/{search-id} ``` Example — `{search-id}: rts-12212` ### Request ###### Request headers ``` Authorization: Bearer Content-Type: application/vnd.api+json x-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](https://developer.manage.trellix.com/public) 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 | | --- | --- | --- | | searchId | string | Search id of the search in progress. | | export | boolean | Applicable only for specific related historical/device searches. If set to `True`, this parameter must be used in the following APIs: - `/edr/vv2/searches/historical` - `/edr/v2/searches/queue-jobs/{searchId}` - `/edr/v2/searches/historical/{searchId}/results` Default value: `False`. | ### Response ###### Response example ``` {  "data": {    "type": "queue-jobs",    "id": "hs-01b5865f-0905-0572-002a-7003d239d812.346565425a0b6b2b7174aa555f67a043",    "attributes": {      "status": "in-progress"    }  } } ``` ### Response codes | Status | Response | Description | | --- | --- | --- | | 200 | OK | Your request was successful. The response contains the current job status. The search is still in progress, and you must wait until it finishes before retrieving the results. | | 303 | See Other | The search job has completed. The response includes a redirect (Location header) to the results endpoint, where you can retrieve the final search 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 `(Content-Type)` is not supported. | | 429 | Too Many Requests | You've exceeded the rate limit by sending too many requests in a short period. The `Retry-After` header in the response will tell you how long to wait before trying again. | | 500 | Internal Server Error | Something went wrong on the server's end. This is not an issue with your request. |