agents¶

The following methods allow for interaction with the ZMS Agents API endpoints.

Methods are accessible via zms.agents

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class AgentsAPI¶

Bases: APIClient

A Client object for the ZMS Agents domain.

Provides access to agent operations including: - List agents with pagination, search, and sorting - Agent connection status statistics - Agent version statistics

get_agent_connection_status_statistics(customer_id, search=None)¶

Retrieve aggregated statistics for agent connection statuses.

Parameters:

customer_id – The customer ID.
search – Optional search filter.

Returns:

(statistics dict, response, error)

Return type:

tuple

Examples

Get connection status stats:

>>> result, _, err = client.zms.agents.get_agent_connection_status_statistics(
...     customer_id="123456789"
... )
>>> if err:
...     print(err)
>>> print(result.get("totalCount"))

get_agent_version_statistics(customer_id, search=None)¶

Retrieve aggregated statistics for agent versions.

Parameters:

customer_id – The customer ID.
search – Optional search filter.

Returns:

(statistics dict, response, error)

Return type:

tuple

Examples

Get agent version stats:

>>> result, _, err = client.zms.agents.get_agent_version_statistics(
...     customer_id="123456789"
... )
>>> if err:
...     print(err)
>>> for v in result.get("agentVersions", []):
...     print(v.get("version"), v.get("count"))

list_agents(customer_id, page=1, page_size=20, search=None, sort=None, sort_dir=None)¶

Get a paginated list of agents for a customer.

Parameters:

customer_id – The customer ID.
page – Page number (default 1).
page_size – Number of items per page (default 20).
search – Search filter string.
sort – Sort field.
sort_dir – Sort direction (ASC or DESC).

Returns:

(agents_connection dict, response, error)

Return type:

tuple

Examples

List agents:

>>> result, _, err = client.zms.agents.list_agents(
...     customer_id="123456789",
...     page=1,
...     page_size=20
... )
>>> if err:
...     print(err)
>>> for agent in result.get("nodes", []):
...     print(agent.get("name"))