API Reference

Describes an Asset in Red Cloak TDR.

Count of assets

Describes the history of an asset.

Describes the contact of an asset history.

Describes the event of an asset history.

Contains the host id and instance id of an asset history.

Describes the Red Cloak agent history of an asset.

Describes the return type of the <code>AllAssets</code> and <code>SearchAssets</code> queries.

Describes the endpoint group information of a Taegis agent asset.

Describes the endpoint information of a Red Cloak agent asset.

Describes the ethernet address of an asset.

Describes the hostname of an asset.

Describes the ignition details of a Red Cloak agent asset.

Describes the IP Address of an asset.

Describes the ModuleHealth of a Red Cloak agent asset.

Describes the module event processing time of a Red Cloak agent asset on TDR.

Describes the module status of a Red Cloak agent asset.

Describes the system information of a Red Cloak agent asset.

Describes the tag data associated with an asset

Describes the tag data associated with an asset

Describes the user of an asset.

Describes the input of Asset data for creating an Asset Tag

Type of Red Cloak endpoint agent.

Describes the enums available for the ordering of the <code>AllAssets</code> and <code>SearchAssets</code> queries.

Describes the order direction available for the order field of the <code>AllAssets</code> and <code>SearchAssets</code> queries.

Default time implementation for this library.

Defines the fields of an Audit log

Defines the attributes of an Audit Event

AuditEventResult represents a list of AuditEvents along with metadata like total events

AuditResult represents a list of Audit logs along with metadata for pagination and relation

Defines the fields for retrieving paginated Audit logs

Internal use only - Defines the fields of an audit log

Defines the fields used for searching Audit logs along with pagination input like offset and limit

Defines the types of AuditEvent

Default time implementation for this library.

Connection is a per-tenant configuration of a connector/actions

ConnectionMethod references a service that implements connectors of a specific connection method (e.g. http, grpc, graphql)

Connector is an entry in catalog of available connectors (e.g. service now connector based on generic http connector service)

ConnectorAction declares a method or activity that can be called on a connector and its corresponding input and output

ConnectorCategory is a grouping/categorization of available connectors (e.g. IP reputation services, DNS lookup, etc)

ConnectorVersion contains the versioned attributes of a connector interface

ConnectionInput defines the mutable fields of a connection

ConnectionMethodInput defines the fields required to register a new connection method

ConnectorActionInput defines the mutable fields of a connector action declaration

ConnectorCategoriesArguments defines the filters and options for listing connectorCategories

ConnectorVersionArguments defines the filters and options for listing connectorVersions

ConnectorVersionsArguments defines the filters and options for listing connectorVersions

ConnectorInput defines the fields required to create a connector

CreateConnectorVersionInput defines the versioned fields of a connector

DeleteConnectorInput defines the mutable metadata fields of a connector

DeleteConnectorVersionInput

PublishConnectorVersionInput

UpdateConnectorInput defines the mutable metadata fields of a connector

UpdateConnectorVersionInput defines the versioned fields of a connector

Enumeration of supported auth types

ConnectionVersionStrategy determines how the connection is upgraded when new versions are published

list of IDs

JSON payload

JSON Schema

version string in semver format

list of tags

Time implementation for this library.

EventQuery defines the overall query status and metadata

EventQueryProgress provides basic metrics about query progress

EventQueryResult returns query status and if available a page of results for a specific event type

EventQueryResults contains overall query status and optionally results for a specific event type

EventUser is the user that submitted query

EventQueryOptions provides ability to override default query behavior

JSON payload

Time implementation for this library.