Retrieve a paged list of Action Sets

Retrieve a paged list of Action Sets for the specified organization. See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
path Parameters
orgID
required
integer <int64>

The ID of the target organization

Example: 123456
query Parameters
page
integer
Default: 0

First page of data to display default: 0

Example: page=0
limit
integer

The maximum number of results to display, between 0 and 500.

Example: limit=500
sort
Array of strings

Supported sort orders: source_name, source_type, status, updated_at, created_at, configuration_id

Items Enum: "source_name" "source_type" "status" "updated_at" "created_at" "configuration_id"
Example: sort=source_name
groupSort
Array of strings

Supported sort orders: asc, desc, latest_updated_at:asc, latest_updated_at:desc, source:asc, source:desc

Items Enum: "asc" "desc" "latest_updated_at:asc" "latest_updated_at:desc" "source:asc" "source:desc"
Example: groupSort=asc
source_type:in[]
Array of strings

Filter on report source.

Items Enum: "Generic Report" "Crowdstrike" "Rapid7" "TenableIO" "Qualys"
Example: source_type:in[]=Generic Report
status:not_in[]
Array of strings

Filter on status, where status is NOT in building | ready | error.

Items Enum: "building" "ready" "error"
Example: status:not_in[]=building
status:in[]
Array of strings

Filter on status, where status IS in building | ready | error.

Items Enum: "building" "ready" "error"
Example: status:in[]=ready
configuration_id:equals
string <uuid>

Filter on a specific configuration ID.

Example: configuration_id:equals=1ee24da5-654d-6464-bb90-4b1496b4b3a0
configuration_id:is_set
boolean

Filter based on whether the configuration ID is set.

Example: configuration_id:is_set=true
include_all_runs:equals
boolean

Choose whether to include all runs in the response.

Example: include_all_runs:equals=true
Responses
200

Successful Operation

4XX

Invalid Request

get/orgs/{orgID}/remediations/action-sets
Request samples 
$apiKey = 'your_automox_api_key'
$headers = @{ "Authorization" = "Bearer $apiKey" }
$url = "https://console.automox.com/api/orgs/{orgID}/remediations/action-sets?limit=25&page=0&sort=updated_at:desc&status:not_in[]=error&groupBy=configuration_id&groupSort=latest_updated_at:desc&configuration_id:is_set=true&include_all_runs:equals=true"

$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers -ContentType "application/json").Content
Response samples
application/json
{
  • "summary": "Action sets list example",
  • "description": "Example response for retrieving multiple action sets with pagination metadata and vulnerability statistics",
  • "value": {
    • "metadata": {
      • "total_pages": 3,
      • "current_page": 0,
      • "limit": 30,
      • "total_count": 50
      },
    • "data": [
      • {
        • "id": 17194,
        • "statistics": {
          • "issues": {
            • "unknown-host": {
              • "count": 78
              }
            },
          • "solutions": {
            • "patch-now": {
              • "count": 1,
              • "device_count": 1,
              • "vulnerability_count": 1
              },
            • "patch-with-worklet": {
              • "count": 96,
              • "device_count": 1,
              • "vulnerability_count": 4
              }
            }
          },
        • "configuration_id": "1ee24da5-654d-6464-bb90-4b1496b4b3a0",
        • "organization_id": 1191100,
        • "status": "ready",
        • "source": {
          • "name": "AVR Testing Config",
          • "type": "Rapid7"
          },
        • "created_by_user": {
          • "id": 901250,
          • "firstname": "Jane",
          • "lastname": "Doe",
          • "email": "janedoe@web.com"
          },
        • "created_at": "2023-07-27T10:00:53+0000",
        • "updated_at": "2023-07-27T10:02:52+0000"
        }
      ]
    }
}