View a new data extract job

This retrieves a specific data extract job.

get
data-extracts/{id}

https://console.automox.com/api/data-extracts
Request
Response
Request
Path Parameters
id
required
integer
ID of the data extract you want to view.
Headers
Authentication
required
string
Your Automox API Key for authentication. Format: Authentication: Bearer your_automox_api_key
Query Parameters
o
required
integer
The organization whose data extract job you want to view.
Response
200: OK
{
"id" : <integer: Data Extract Job ID>,
"organization_id": <integer: Organization ID>,
"user_id": <integer: User who initiated the job>,
"status": <string: Current status of Data Extract job. Options: queued, running, complete, failed, canceled, expired>,
"is_completed": <boolean: Is the Data Extract job completed?>,
"created_at": <DateTime: When the job request was received>,
"report": {
"download_expires_at": <DateTime: When the job download expires>,
"download_url": <string: S3 Download URL for Report>,
"start_time": "<DateTime: The start time for the report's data>,
"end_time": "DateTime: The end time for the report's data">
}
}

Example Requests

cURL
Python http.client
Python requests
C#
PowerShell
cURL
curl --location --request GET 'https://console.automox.com/api/data-extracts/156' \
--header 'Authorization: Bearer your_automox_api_key' \
Python http.client
import http.client
conn = http.client.HTTPSConnection("console.automox.com")
payload = ''
headers = {
'Authorization': 'Bearer your_automox_api_key'
}
conn.request("GET", "/api/data-extracts/156", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
Python requests
import requests
url = "https://console.automox.com/api/data-extracts/156"
payload={}
headers = {
'Authorization': 'Bearer your_automox_api_key'
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
C#
var client = new RestClient("https://console.automox.com/api/data-extracts/156");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer your_automox_api_key");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
PowerShell
$apiKey = 'your_automox_api_key'
$headers = @{ "Authorization" = "Bearer $apiKey" }
$url = "https://console.automox.com/api/data-extracts/000"
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content