Remote Actions Object Models
Objects used to build Remote Actions execution requests and parse Remote Actions catalog or execution responses.
nexthink_api.RemoteActions
Models for the Nexthink Remote Actions API.
NxtRemoteActionErrorResponse
Bases: BaseModel
Error details returned by the Remote Actions API.
code: str = Field(min_length=1)
class-attribute
instance-attribute
message: str = Field(min_length=1)
class-attribute
instance-attribute
NxtRemoteActionExecutionRequest
Bases: BaseModel
Request body used to trigger a remote action.
remoteActionId: str = Field(min_length=1)
class-attribute
instance-attribute
devices: list[str] = Field(min_length=1, max_length=10000)
class-attribute
instance-attribute
params: dict[str, str] | None = None
class-attribute
instance-attribute
expiresInMinutes: int | None = Field(default=None, ge=60, le=10080)
class-attribute
instance-attribute
triggerInfo: NxtRemoteActionTriggerInfoRequest | None = None
class-attribute
instance-attribute
NxtRemoteActionExecutionResponse
Bases: BaseModel
Response returned when a remote action execution request is accepted.
requestId: str = Field(min_length=1)
class-attribute
instance-attribute
expiresInMinutes: int | None = Field(default=None, ge=1, le=10080)
class-attribute
instance-attribute
NxtRemoteAction
Bases: BaseModel
Remote action configuration metadata.
id: str
instance-attribute
uuid: str
instance-attribute
name: str
instance-attribute
description: str | None = None
class-attribute
instance-attribute
origin: str
instance-attribute
builtInContentVersion: str | None = None
class-attribute
instance-attribute
purpose: list[NxtRemoteActionPurpose]
instance-attribute
targeting: NxtRemoteActionTargeting
instance-attribute
scriptInfo: NxtRemoteActionScriptInfo
instance-attribute
NxtRemoteActionInput
Bases: BaseModel
Remote action input parameter metadata.
id: str
instance-attribute
name: str
instance-attribute
description: str | None = None
class-attribute
instance-attribute
usedByWindows: bool
instance-attribute
usedByMacOs: bool
instance-attribute
options: list[str]
instance-attribute
allowCustomValue: bool
instance-attribute
NxtRemoteActionOutput
Bases: BaseModel
Remote action output parameter metadata.
id: str
instance-attribute
name: str
instance-attribute
type: str
instance-attribute
description: str | None = None
class-attribute
instance-attribute
usedByWindows: bool
instance-attribute
usedByMacOs: bool
instance-attribute
NxtRemoteActionPurpose
Bases: str, Enum
Remote action purpose values.
DATA_COLLECTION = 'DATA_COLLECTION'
class-attribute
instance-attribute
REMEDIATION = 'REMEDIATION'
class-attribute
instance-attribute
NxtRemoteActionRunAsOption
Bases: str, Enum
Remote action run-as options.
LOCAL_SYSTEM = 'LOCAL_SYSTEM'
class-attribute
instance-attribute
INTERACTIVE_USER = 'INTERACTIVE_USER'
class-attribute
instance-attribute
DELEGATE_TO_SERVICE = 'DELEGATE_TO_SERVICE'
class-attribute
instance-attribute
NxtRemoteActionScriptInfo
Bases: BaseModel
Remote action script metadata.
executionServiceDelegate: str | None = None
class-attribute
instance-attribute
runAs: NxtRemoteActionRunAsOption
instance-attribute
timeoutSeconds: int
instance-attribute
hasScriptWindows: bool
instance-attribute
hasScriptMacOs: bool
instance-attribute
inputs: list[NxtRemoteActionInput] = Field(default_factory=list)
class-attribute
instance-attribute
outputs: list[NxtRemoteActionOutput] = Field(default_factory=list)
class-attribute
instance-attribute
NxtRemoteActionTargeting
Bases: BaseModel
Remote action targeting metadata.
apiEnabled: bool
instance-attribute
manualEnabled: bool
instance-attribute
workflowEnabled: bool
instance-attribute
manualAllowMultipleDevices: bool
instance-attribute
NxtRemoteActionTriggerInfoRequest
Bases: BaseModel
Optional context describing why a remote action was triggered.