List all Data Extracts for an Organization

List all Data extracts for an organization with ability to filter and sort results.

Request
Security:
query Parameters
o
required
integer

Limit response to a specific Automox organization

limit
integer [ 1 .. 500 ]
Default: 25

A limit on the number of results to be returned, between 1 and 500, with a default of 25. Use with page parameter. See About Automox API - Pagination

page
integer
Default: 0

The page of results you wish to be returned with page numbers starting at 0. Default: 0. See About Automox API - Pagination

sort
Array of strings

The sort for the results. Options: created_at:desc/asc and status:desc/asc. Default: created_at:desc

Items Enum: "created_at:desc" "created_at:asc" "status:desc" "status:asc"
type:equals
string
Default: "patch-history"

The type of Data Extracts to list. Options: patch-history.

Value: "patch-history"
created_at:greater_than
string <date-time>

Created at date is greater than the value submitted. If a time is not specified, greater_than will have a time of start of day.

created_at:lesser_than
string <date-time>

Created at date is less than the value submitted. If a time is not specified, less_than will have a time of end of day.

created_at:greater_than_or_equals
string <date-time>

Created at date is greater than or equals the value submitted. If a time is not specified, greater_than_or_equals will have a time of start of day.

created_at:lesser_than_or_equals
string <date-time>

Created at date is lesser than or equals the value submitted. If a time is not specified, less_than_or_equals will have a time of end of day.

status:equals
string

Find jobs with a specific status. Options: queued, running, complete, failed, canceled, expired

Enum: "queued" "running" "complete" "failed" "canceled" "expired"
status:in
Array of strings

Find jobs with one or more of these statuses.

Items Enum: "queued" "running" "complete" "failed" "canceled" "expired"
Responses
200

Successful Operation

400

Invalid Request

401

Access token is missing or invalid

403

You do not have permission to perform this action.

404

Entity not found

429

Too many requests

get/data-extracts
Request samples
$apiKey = 'your_automox_api_key'
$headers = @{ "Authorization" = "Bearer $apiKey" }
$url = "https://console.automox.com/api/data-extracts?o=0000&limit=25&page=0&status:in=queued"

$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content
Response samples
application/json
[
  • {
    • "id": 0,
    • "organization_id": 0,
    • "user_id": 0,
    • "status": "queued",
    • "is_completed": true,
    • "created_at": "2019-08-24T14:15:22Z",
    • "download_expires_at": "2019-08-24T14:15:22Z",
    • "download_url": "string",
    • "parameters": {
      • "start_time": "2019-08-24T14:15:22Z",
      • "end_time": "2019-08-24T14:15:22Z"
      }
    }
]