Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

The "Migrate Agents" operation under the "Agent" resource is designed to facilitate the migration and management of agents between companies within a system. This node allows users to perform actions such as migrating agents from one company to another, restarting agents, or updating agent information. It is particularly useful in scenarios where organizational restructuring occurs, or when agents need to be reassigned or refreshed programmatically.

Practical examples include:

  • Migrating a set of agents from an old company account to a new company account after a merger.
  • Restarting specific agents remotely to apply updates or resolve issues.
  • Updating agent configurations or metadata in bulk.

Properties

Name Meaning
X USER ID The user identifier making the request; required for authentication or tracking purposes.
Company Id The numeric ID of the source company from which agents will be migrated or managed.
Dest Company Id The numeric ID of the destination company to which agents will be migrated.
Message The action to perform on the agents. Options: "Migrate Company", "Restart Agent", "Update Agent".
Agent Ids A JSON array containing the IDs of the agents to be affected by the operation.

Output

The node outputs JSON data representing the result of the requested operation on the agents. This typically includes status information about the migration, restart, or update process, such as success confirmation, error messages, or details about the affected agents.

If binary data were involved (e.g., logs or files), it would be summarized here, but this node appears to focus solely on JSON responses related to agent operations.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • Depends on the Connect Secure API endpoint that handles agent migration and management.
  • The node uses routing to send headers and body parameters correctly formatted for the API.

Troubleshooting

  • Common Issues:

    • Missing or invalid "X USER ID" header can cause authentication failures.
    • Incorrect company IDs or agent IDs may lead to errors or no changes applied.
    • Providing malformed JSON in the "Agent Ids" property can cause parsing errors.
  • Error Messages:

    • Authentication errors indicating missing or invalid user ID header.
    • Validation errors if required fields like company IDs or message type are missing.
    • API errors returned from the Connect Secure service, such as "Agent not found" or "Migration failed".
  • Resolutions:

    • Ensure all required properties are provided and correctly formatted.
    • Validate JSON input for agent IDs before execution.
    • Confirm that the API credentials have sufficient permissions.

Links and References

Discussion