API Reference

List triggers for the authenticated organization.

get
https://api.controlup.com/vdi/config/v1/Triggers

Returns a paginated list of triggers. Supports filtering, sorting, and optional scope-based lookups via the machine or folder parameters.

When include=perMachine is specified, the response data array changes shape: instead of trigger items it returns
per-machine groups. The machine or folder parameter is required in that case.

Error codes returned in the errorCode field: scope_params_conflict (both machine and folder specified),
scope_params_required (include token requires scope), machine_not_found (404), folder_not_found (404),
scope_resolution_too_broad (folder resolved too many machines, also includes resolvedCount and limit),
scope_params_invalid (malformed scope input).

Query Params
int32
1 to 10000

Gets or sets the page number for pagination (1-based).

int32
1 to 200

Gets or sets the number of items per page.

string
^(name|createdAt|updatedAt|type)$

Gets or sets the field to sort results by.

string
^(asc|desc)$

Gets or sets the sort direction.

boolean

Gets or sets a filter by enabled status. Omit to return both enabled and disabled triggers.

string
^(StressLevel|WindowsEvent|MachineDown|ProcessStarted|ProcessEnded|UserLoggedOn|UserLoggedOff|SessionStateChanged|Advanced|Scheduled)$

Gets or sets a filter by trigger type.

string

Gets or sets a filter by entity type (e.g. Computers, Sessions).

boolean

Gets or sets a filter by whether the trigger is a built-in (common) trigger. Set to false to return only custom triggers.

string
length ≤ 200

Gets or sets a filter by name. Filter triggers whose name contains the given string. Case-insensitive. Maximum 200 characters.

include
array of strings

Gets or sets optional expansions. 'scope' adds scopeSummary (included/excluded counts) to each trigger item. 'summary' adds top-level aggregate counts by type, enabled status, and common/custom. Can be combined: include=scope∈clude=summary or include=scope,summary.

include
string
length ≤ 512

Gets or sets a filter by machine FQDN or hostname. Cannot be combined with 'folder'. Required when using scopeMatch, resolvedMachines, or perMachine includes. Maximum 512 characters.

string
length ≤ 1024

Gets or sets a filter by folder path. Cannot be combined with 'machine'. Maximum 1024 characters.

Responses

Updated 13 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago

Did this page help you?