3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Update Console Restrictions" operation in this node allows users to modify access control settings for a console environment. This includes enabling or disabling access restrictions, specifying an IP whitelist, and setting the user's IP address. Such functionality is useful in scenarios where administrators want to enforce network-level security policies on their console access, ensuring only authorized IP addresses can interact with the system.

Practical examples:

  • Restricting console access to a specific set of office IP addresses.
  • Temporarily disabling access restrictions during maintenance.
  • Updating the list of allowed IPs after network changes.

Properties

Name Meaning
Access Restricted Boolean flag to enable (true) or disable (false) access restrictions on the console.
Id String identifier representing the specific console restriction record to update.
Ip Whitelist JSON array containing IP addresses that are allowed access to the console.
My Ip Address String representing the current user's IP address, potentially used for validation or logging.

Output

The node outputs JSON data reflecting the result of the update operation on console restrictions. This typically includes confirmation of the updated settings or any relevant status messages returned by the API. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authentication with the 3CX telephony system's API.
  • The base URL for API requests is configured dynamically based on the provided server URL credential.
  • The node sends HTTP requests with JSON payloads to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid IP Whitelist Format: If the IP whitelist JSON is malformed, the API may reject the request. Ensure the IP whitelist is valid JSON and contains proper IP address strings.
  • Missing or Incorrect Id: The Id property must correctly identify the console restriction record to update; otherwise, the API may return an error indicating the resource was not found.
  • Authentication Errors: Failure to provide valid API credentials will result in authorization errors. Verify that the API key or OAuth token is correctly configured.
  • Network Issues: Connectivity problems to the specified server URL can cause request failures. Confirm network accessibility and correct server URL configuration.

Links and References

Discussion