Agents, modules and tools
Beta Preview
The facade clients are in beta in istari-digital-client 14.0.0, and their API may change between releases. Facade clients (beta) explains how they work.
Register agents and pools, publish modules and tools, and read functions. These managers are on IstariIntegrations.
The same domain on the other clients: Client: Agents, modules and tools. V3Client: none.
integrations.agents
| Method | What it does |
|---|---|
integrations.agents.list | List agents, with filters |
integrations.agents.get | Fetch one agent |
integrations.agents.register | Enroll a new agent |
integrations.agents.register_public_key | Register an agent's job-signing public key |
integrations.agents.update_display_name | Rename an agent |
integrations.agents.update_status | Set an agent's status |
integrations.agents.update_information | Report an agent's version, OS, API hashes and capabilities |
integrations.agents.update_modules | Report the modules loaded on an agent |
integrations.agents.available_jobs | Unclaimed jobs an agent can take |
integrations.agents.archive | Archive an agent so it takes no new jobs |
integrations.agents.restore | Restore an archived agent |
integrations.agent_pools
| Method | What it does |
|---|---|
integrations.agent_pools.list | List agent pools |
integrations.agent_pools.get | Fetch one pool |
integrations.agent_pools.create | Create a pool |
integrations.agent_pools.update | Change a pool's name or description |
integrations.agent_pools.archive | Archive a pool |
integrations.agent_pools.restore | Restore an archived pool |
integrations.modules
| Method | What it does |
|---|---|
integrations.modules.list | List modules |
integrations.modules.get | Fetch one module |
integrations.modules.create | Publish a module from its manifest |
integrations.modules.deprecate | Deprecate a module |
integrations.modules.list_versions | List a module's versions |
integrations.modules.get_version | Fetch one module version |
integrations.tools
| Method | What it does |
|---|---|
integrations.tools.list | List tools |
integrations.tools.get | Fetch one tool |
integrations.tools.create | Create a tool |
integrations.tools.list_versions | List all tool versions |
integrations.tools.get_version | Fetch one tool version |
integrations.tools.create_version | Add a version to a tool |
integrations.functions
| Method | What it does |
|---|---|
integrations.functions.list | List functions, with filters |
integrations.functions.get | Fetch one function |
integrations.functions.get_schema | Input and output schema of a function version |
integrations.function_auth_secrets
| Method | What it does |
|---|---|
integrations.function_auth_secrets.list | List stored credentials used to run functions |
integrations.function_auth_secrets.get | Fetch one stored credential |
integrations.function_auth_secrets.create | Store a credential for running a function |
integrations.operating_systems
| Method | What it does |
|---|---|
integrations.operating_systems.list | List operating systems |
integrations.operating_systems.get | Fetch one operating system |
integrations.operating_systems.create | Add an operating system |
integrations.operating_systems.update | Rename an operating system |