Agents & modules

Data types for agents, agent pools, modules, functions, tools, and operating systems.

info

All data types support standard serialization methods (to_json, from_json, to_dict, from_dict, to_str) which are omitted from the tables below.

Agent

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
display_name_history	Optional[List[AgentDisplayName]]
information_history	Optional[List[AgentInformation]]
status_history	Optional[List[AgentStatus]]
modules_history	Optional[List[AgentModules]]
created_by_id	Optional[str]

AgentDisplayName

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
agent_id	str
display_name	str
created_by_id	Optional[str]

AgentInformation

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
agent_id	str
agent_version	str
host_os	str
tenant_id	Optional[str]
created_by_id	Optional[str]

AgentModuleVersion

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
agent_modules_id	str
module_version_id	str
module_name	str
module_version	str
created_by_id	Optional[str]

AgentModules

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
agent_id	str
module_versions	List[AgentModuleVersion]
created_by_id	Optional[str]

AgentPool

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
name	str
description	Optional[str]
agent_memberships	List[AgentPoolAgentMembership]
user_memberships	List[AgentPoolUserMembership]

AgentPoolAgentMembership

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
agent_id	str
agent_pool_id	str

AgentPoolAgentMembershipWithAgent

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
agent_id	str
agent_pool_id	str
agent	Agent

AgentPoolUserMembership

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
user_id	str
agent_pool_id	str

AgentPoolUserMembershipWithUser

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
user_id	str
agent_pool_id	str
user	User

AgentStatus

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
agent_id	str
name	AgentStatusName
created_by_id	Optional[str]
message	Optional[str]

AgentStatusName

Attributes:

Name	Type	Description
IDLE	—
CLAIMINGJOB	—
VALIDATINGJOB	—
EXECUTINGJOB	—
UPLOADINGJOB	—
EXECUTIONFAILED	—
EXECUTIONSUCCESS	—
UPDATINGAGENT	—
SUCCESSFULAGENTUPDATE	—
FAILEDAGENTUPDATE	—
UPDATINGMODULE	—
SUCCESSFULMODULEUPDATE	—
FAILEDMODULEUPDATE	—
PAUSED	—
UNKNOWN	—

AgentStatusRetentionDuration

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
retention_days	Optional[int]
created_by_id	Optional[str]

NewAgent

Attributes:

Name	Type	Description
agent_version	str
host_os	str

NewAgentDisplayName

Attributes:

Name	Type	Description
display_name	str

NewAgentInformation

Attributes:

Name	Type	Description
agent_version	str
host_os	str

NewAgentModuleVersion

Attributes:

Name	Type	Description
module_name	str
module_version	str

NewAgentPool

Attributes:

Name	Type	Description
name	str
description	Optional[str]

NewAgentPoolAgentMembership

Attributes:

Name	Type	Description
agent_id	str

NewAgentPoolUserMembership

Attributes:

Name	Type	Description
user_id	str

NewAgentStatus

Attributes:

Name	Type	Description
name	AgentStatusName

NewAgentStatusRetentionDuration

Attributes:

Name	Type	Description
retention_days	int

Module

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
name	str
module_type	ModuleType
internal	bool
tool	Optional[str]
module_versions	Optional[List[ModuleVersion]]
functions	Optional[List[Function]]

ModuleAuthor

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
name	str
email	str

ModuleAuthorManifest

Attributes:

Name	Type	Description
name	str
email	str

ModuleType

Attributes:

Name	Type	Description
FUNCTION	—
AUTHENTICATION	—

ModuleVersion

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
module_version	str
check_sum	str
agent_version	str
module_id	str
status	ModuleVersionStatus
module_display_name	Optional[str]
tool_display_name	Optional[str]
tool_versions	Optional[List[str]]
operating_systems	Optional[List[str]]
authors	Optional[List[ModuleAuthor]]
functions	Optional[Dict[str, List[FunctionVersion]]]

ModuleVersionStatus

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
name	UsabilityStatusName
reason	Optional[str]
module_version_id	str

NewModuleAuthor

Attributes:

Name	Type	Description
name	str
email	str

NewModuleManifest

Attributes:

Name	Type	Description
module_name	str
module_version	str
module_type	ModuleType
module_checksum	str
internal	bool
operating_systems	List[str]
agent_version	str
authors	List[ModuleAuthorManifest]
functions	Dict[str, List[NewFunctionManifest]]
module_display_name	Optional[str]
tool_display_name	Optional[str]
tool	Optional[str]
tool_versions	Optional[List[str]]

Function

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
name	str
module_name	str
tool_name	Optional[str]
function_versions	Optional[List[FunctionVersion]]

FunctionAuthSecret

Represents a function authentication secret backed by a file.

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
file	File
comments	List[Comment]
archive_status_history	List[ResourceArchiveStatus]
created_by_id	str
function_auth_type	FunctionAuthType
sha	Optional[str]
salt	Optional[str]
auth_integration_id	Optional[str]
expiration	Optional[datetime.datetime]

Methods:

Name	Description
update_properties	Update one or more metadata fields on the underlying file.
update_description	Update the file’s description.
update_display_name	Update the file’s display name.
update_external_identifier	Update the file’s external identifier.
update_version_name	Update the file’s version name.
read_bytes	Read and return the raw byte contents of the associated file revision.
read_text	Read the contents as decoded text.
copy_to	Copy the contents to a local file.
read_json	Parse the contents as JSON.
cleanup_cache	Clean up cached files if they exist.
get_cache_stats	Get filesystem cache statistics.

FunctionAuthType

Attributes:

Name	Type	Description
JWT	—
TOKEN	—
BASIC	—
OAUTH1	—
OAUTH2	—
CAS_DELEGATED_3DX	—

FunctionSchema

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
inputs	Optional[List[InputSchema]]
outputs	Optional[List[OutputSchema]]

FunctionStatus

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
created_by_id	str
name	UsabilityStatusName
reason	Optional[str]
function_id	str

FunctionVersion

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
name	str
version	str
module_name	str
module_version	str
entrypoint	str
function_schema	Optional[str]
run_command	str
created_by_id	str
status	FunctionStatus
tool_name	Optional[str]
tool_display_name	Optional[str]
tool_versions	Optional[List[ToolVersion]]
operating_systems	Optional[List[OperatingSystem]]

NewFunctionAuthSecret

Attributes:

Name	Type	Description
revision	FileRevision
function_auth_type	FunctionAuthType
auth_integration_id	Optional[str]
sha	Optional[str]
salt	Optional[str]
expiration	Optional[datetime.datetime]

NewFunctionManifest

Attributes:

Name	Type	Description
entrypoint	str
run_command	str
function_schema	NewFunctionSchemaManifest
operating_systems	Optional[List[str]]
tool_versions	Optional[List[str]]

NewFunctionSchemaManifest

Attributes:

Name	Type	Description
inputs	Optional[Dict[str, NewInputSchemaManifest]]
outputs	Optional[List[NewOutputSchemaManifest]]

NewInputSchemaManifest

Attributes:

Name	Type	Description
type	str
validation_types	Optional[List[str]]
optional	Optional[bool]

NewOutputSchemaManifest

Attributes:

Name	Type	Description
name	str
type	str
required	bool
upload_as	Optional[str]
version_of	Optional[str]

InputSchema

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
key	str
type	InputType
validation_types	Optional[List[str]]
optional	Optional[bool]

InputType

Attributes:

Name	Type	Description
PARAMETER	—
USER_MODEL	—
USER_LINK	—
AUTH_INFO	—

OutputSchema

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
name	str
type	OutputType
required	bool
upload_as	Optional[UploadAs]
version_of	Optional[str]

OutputType

Attributes:

Name	Type	Description
DIRECTORY	—
FILE	—

Properties

Class for holding file properties.

Attributes:

Name	Type	Description
native	istari_digital_core.Properties

Tool

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
name	str
functions	Optional[List[Function]]
tool_versions	Optional[List[ToolVersion]]

ToolInclude

Attributes:

Name	Type	Description
FUNCTIONS	—
FUNCTION_VERSIONS	—

ToolVersion

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
tool_version	str

NewTool

Attributes:

Name	Type	Description
name	str
tool_versions	Optional[List[NewToolVersion]]

NewToolVersion

Attributes:

Name	Type	Description
tool_version	str

UpdateTool

Attributes:

Name	Type	Description
name	str

DeprecationReason

Attributes:

Name	Type	Description
reason	str

NewOperatingSystem

Attributes:

Name	Type	Description
name	str

OperatingSystem

Attributes:

Name	Type	Description
id	str
created	datetime.datetime
name	str

OS

Attributes:

Name	Type	Description
WINDOWS_11	—
WINDOWS_10	—
WINDOWS_SERVER_2019	—
WINDOWS_SERVER_2022	—
UBUNTU_24_DOT_04	—
UBUNTU_22_DOT_04	—
UBUNTU_20_DOT_04	—
RHEL_8	—
RHEL_9	—

PageAgent

Attributes:

Name	Type	Description
items	List[Agent]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageAgentPool

Attributes:

Name	Type	Description
items	List[AgentPool]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageAgentPoolAgentMembershipWithAgent

Attributes:

Name	Type	Description
items	List[AgentPoolAgentMembershipWithAgent]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageAgentPoolUserMembershipWithUser

Attributes:

Name	Type	Description
items	List[AgentPoolUserMembershipWithUser]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageAgentStatus

Attributes:

Name	Type	Description
items	List[AgentStatus]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageFunction

Attributes:

Name	Type	Description
items	List[Function]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageFunctionVersion

Attributes:

Name	Type	Description
items	List[FunctionVersion]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageModule

Attributes:

Name	Type	Description
items	List[Module]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageModuleAuthor

Attributes:

Name	Type	Description
items	List[ModuleAuthor]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageModuleVersion

Attributes:

Name	Type	Description
items	List[ModuleVersion]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageOperatingSystem

Attributes:

Name	Type	Description
items	List[OperatingSystem]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageTool

Attributes:

Name	Type	Description
items	List[Tool]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]

PageToolVersion

Attributes:

Name	Type	Description
items	List[ToolVersion]
total	Optional[int]
page	Optional[int]
size	Optional[int]
pages	Optional[int]