fn getStatus()
Authenticate (local login) and report account + license status. Read-only health check.
fn assetsOverview()
Fetch the asset dashboard summary (counts + risk breakdown) from transformerDataApi/assetsOverview.
fn listAssets(pageSize: number, pageNumber: number, sortBy: string, globalSearch: string)
List discovered assets (risk level, vendor, type, connection data) via the /sepio-data GraphQL layer.
| Argument | Type | Required | Description |
|---|
| pageSize | number | yes | Rows per page |
| pageNumber | number | yes | 1-based page number |
| sortBy | string | yes | Sort key, e.g. riskLevel_desc or lastSeen_desc |
| globalSearch | string | yes | Free-text search across assets |
fn listDeviceTypes()
List the device-type distribution (asset categories with asset/risk counts) from transformerDataApi/assetsDistribuition.
fn analyzeRisks()
Risk-insights rollup: network port anomalies, vulnerable switches, and uncommon + vulnerable peripherals. Per-source detail is in `raw`.
fn listEvents(pageSize: number, pageNumber: number, minimumSeverity?: number, category?: string, globalSearch?: string)
List events from the event log (Events/GetEvents), with severity/category/search filters.
| Argument | Type | Required | Description |
|---|
| pageSize | number | yes | Rows per page |
| pageNumber | number | yes | 1-based page number |
| minimumSeverity? | number | no | Minimum severity to include |
| category? | string | no | Filter by event category |
| globalSearch? | string | no | Free-text search |
fn listAlarmDestinations()
List configured alarm destinations / SIEM-syslog targets (Events/GetAlarmDests).
fn listPolicies()
List policy-engine policies (policyEngine/policy).
fn listScopes()
List scopes (scopes-api/scopes).
fn listTags()
List all tags (tagsApi/tags).
fn listUserAttributes(pageSize: number, pageNumber: number, globalSearch?: string)
List user attributes (UserAttributes), paginated.
| Argument | Type | Required | Description |
|---|
| pageSize | number | yes | Rows per page |
| pageNumber | number | yes | 1-based page number |
| globalSearch? | string | no | Free-text search |
fn createTag(tagName: string)
Create a tag by name (tagsApi/tags/add-tag/{tagName}). Idempotent — already-exists converges on the existing tag. Mutating.
| Argument | Type | Required | Description |
|---|
| tagName | string | yes | Tag name to create |
fn addUserAttribute(field: string)
Create a user attribute (UserAttributes/AddUserAttribute). Mutating.
| Argument | Type | Required | Description |
|---|
| field | string | yes | User-attribute name/field to add |
fn createPolicy(policy: record)
Create a policy (policyEngine/policy). `policy` is a PolicyDto: name, description, ruleList[], matchCriteria[], defaultAction/defaultActionType, isActive, scopes[]. Mutating.
| Argument | Type | Required | Description |
|---|
| policy | record | yes | PolicyDto object |
fn createScope(scope: record)
Create a scope (scopes-api/scope). `scope` is a ScopeDto: name, matchCriteria[], agentMode. Mutating.
| Argument | Type | Required | Description |
|---|
| scope | record | yes | ScopeDto object |
fn listSwitches()
List switches Sepio sees on the network (Switches/Switches).
fn getSwitchPort(switchDataId: string, portDataId: string)
Get detail for one switch port (Switches/Switches/{switchDataId}/{portDataId}).
| Argument | Type | Required | Description |
|---|
| switchDataId | string | yes | Switch data id |
| portDataId | string | yes | Port data id |
fn listScanEngines()
List external scan engines (Netpollers) the platform knows about, with connection status, admin/activation status, poller health (alive/total), version, CPU, utilization, and error count (Switches/NetPollers). Note: scan engines are NOT host agents — they do not appear in listAgents.
fn listPeripherals(pageSize: number, pageNumber: number, globalSearch?: string, severity?: string, sortBy: string)
List connected peripherals/endpoints with vendor and risk via the transformer view (transformerDataApi/GetPeripherals).
| Argument | Type | Required | Description |
|---|
| pageSize | number | yes | Rows per page |
| pageNumber | number | yes | 1-based page number |
| globalSearch? | string | no | Free-text search |
| severity? | string | no | Filter by severity |
| sortBy | string | yes | Sort key (required by this endpoint, e.g. severity_desc) |
fn getPeripheral(uuid: string)
Get detail for one peripheral by uuid (peripherals/{uuid}). Requires the agent peripherals API (agent-mode deployments); on agentless instances use getAsset.
| Argument | Type | Required | Description |
|---|
| uuid | string | yes | Peripheral uuid |
fn listAgents(pageSize: number, pageNumber: number, globalSearch?: string, status?: string)
List Sepio agents/collectors with status, version, and risk flags (agents).
| Argument | Type | Required | Description |
|---|
| pageSize | number | yes | Rows per page |
| pageNumber | number | yes | 1-based page number |
| globalSearch? | string | no | Free-text search |
| status? | string | no | Filter by agent status |
fn getAgent(agentId: string)
Get detail for one agent by id (agents/agent/{agentId}).
| Argument | Type | Required | Description |
|---|
| agentId | string | yes | Agent id |
fn getAsset(assetId: string)
Full detail for one asset by id (fingerprint, connection, risk) via the /sepio-data GraphQL layer.
| Argument | Type | Required | Description |
|---|
| assetId | string | yes | Asset id (the `id` field from listAssets) |
fn listReports()
List stored report queries you can run (reportManagerApi/queries).
fn listReportDownloads()
List generated report downloads (reportManagerApi/available-downloads).
fn triggerReport(id: string, request?: record)
Trigger a stored report query to generate a download (reportManagerApi/trigger). `request` is a TriggerRequestViewRequest body. Mutating.
| Argument | Type | Required | Description |
|---|
| id | string | yes | Stored query id to trigger |
| request? | record | no | TriggerRequestViewRequest body |
fn apiRequest(method: enum, path: string, query?: record, body?: unknown)
Generic authenticated passthrough to any CybrIQ endpoint (all /prime/webui/* REST routes or /sepio-data). Logs in, attaches the bearer token, returns the JSON response.
| Argument | Type | Required | Description |
|---|
| method | enum | yes | HTTP method |
| path | string | yes | Host-relative path (e.g. /prime/webui/Switches/Switches) or an absolute https URL |
| query? | record | no | Query-string parameters |
| body? | unknown | no | JSON request body for POST/PUT/PATCH (or a {operationName,query,variables} object for /sepio-data) |
Resources
status(1d)— Authenticated account + license status
assetsOverview(7d)— Asset dashboard summary: counts and risk breakdown
assets(7d)— A page of discovered assets from the GraphQL data layer
collection(7d)— Generic list/analysis result (device types, risks, events, alarms, policies, scopes, tags, user attributes)
mutationResult(30d)— Result of a create/update operation (tag, user attribute, policy, scope)
detail(7d)— Single-object drill-down detail (switch port, peripheral, agent, asset)
apiResult(7d)— Result of a generic authenticated API passthrough call