Client IP Address Property in SuiteScript N/http Module

The client IP address property in SuiteScript's N/http module allows developers to access the remote client's IP address from within server scripts. Understanding how to utilize this property is crucial for tasks such as logging, security checks, and auditing user activities.

Property Description

• Property Name: clientIpAddress
• Description: The remote client IP address.
• Type: string (read-only)
• Module: N/http Module
• Parent Object: http.ServerRequest

Usage

The clientIpAddress property is part of the ServerRequest object, which represents the HTTP request information sent to an HTTP server, such as those received by Suitelets or RESTlets. Being a read-only property, developers cannot modify it.

Error Handling

Error Code

• READ_ONLY_PROPERTY: This error occurs when there is an attempt to edit the clientIpAddress property, as it is specified as read-only.

Code Example

To illustrate how this property can be used, here is a basic code snippet:

1// Example code to access remote client IP address
2define(['N/http'], function(http) {
3    function onRequest(context) {
4        var request = context.request;
5        var remoteAddress = request.clientIpAddress;  
6        // Use remoteAddress for logging or other purposes
7    }
8});

In this example, the onRequest function retrieves the client IP address and can be leveraged to log information or for various application logic needs.

Important Notes

• Ensure remote address captures only from trusted sources for enhanced security practices.
• This property is only available in scripts executed in NetSuite, running on the server side.

Utilizing the clientIpAddress effectively can assist in maintaining application integrity and improving security responses based on client data.

Key Takeaways

• The clientIpAddress is read-only and cannot be modified.
• It provides vital information for logging and security checks.
• Always use this property with trusted sources in mind.