1. Account Administration
  2. Best Practices for Cloud Accounts
  3. Traffic Health
  4. RESTlets Traffic Health

RESTlets Traffic Health

All RESTlets traffic to your account using a data center-specific domain is listed in this section of the report.

Correcting Your RESTlets Integrations

The data listed in each column indicates where to find the RESTlet. You should update the RESTlet to use your account-specific domain or to use a dynamic service discovery method to obtain the URL.

Traffic Health reports identify URLs that use data center-specific domains in your account. You must change the data center-specific domains in the URLs to your account-specific domains. To make the necessary changes to a data center-specific URL:

  • You may need the help of a developer in your company.

  • You may need to ask your company’s IT department to locate the owner of the integration.

  • You may need to contact a partner who set up an integration, or the third-party supplier of an integration.

See URLs for Account-Specific Domains for more information.

The following procedure assumes that you have already generated a report. If this is not the case, or if you want to refresh the report data, see Generating a Traffic Health Report.

To correct the items reported for RESTlets:

  1. Click RESTlets.

    1. If you see the message No records to show, your RESTlet integrations are using account-specific domains.

    2. If you see items listed in this section of the report, you must identify the non-compliant traffic, and determine the severity.

      Use the number in the Count column to determine the priority of the updates you should make. The higher the count, the higher the priority to make updates to use an account-specific domain.

      Note:

      Every line reported in the list may indicate a separate integration or a specific use case of a RESTlet.

      • For RESTlets, the most important information is located in the Query String field.

      • The Source IP and the User Agent fields will help you to discover the source of the traffic.

      • The Identity contains the email address associated with the traffic.

        Column Name

        How This Information Can Help You Identify the Traffic

        Host

        Domain name (Host header) associated with an incoming HTTP request.

        Source IP

        Originating IP address of the request.

        Indicates the IP address that NetSuite sees as the IP address from which the traffic originates. This IP address may be translated by a NAT (Network Address Translation) device, which operates in the network where your integration server runs.

        User Agent

        A user agent is software that acts on behalf of the user. Browsers are one type of user agent. The information in this column can identify the application type, operating system, software vendor, or software version of the requesting software user agent.

        For RESTlets, the user agent indicates the name of your HTTP or integration client. The user agent may contain the name of the programming language used to create the integration client.

        Examples include python-requests or PHP RestClient.

        The Ruby programming language is becoming popular for RESTlet implementations. If the programming language is Ruby, you would see OAuth gem as part of the user agent.

        Query String

        Includes the Script ID or Deployment ID of the script. You do not need to locate the particular script using those IDs. The problem is with the user agent that is calling the script.

        The script, or query string parameter, identifies the RESTlet ID instance being called. Determining the purpose of a RESTlet will help you narrow down the scope of integration clients that need to be updated.

        Identity

        The email address can name the purpose of the integration, or indicate the use case. The email address could point to a partner or a third-party integration.

        • boomiuser2@example.com

        • salesforce-integr@example.com

        • commerce-refundintegration@example.com

        • billing-v4@example.com

        Response Code

        HTTP response status code.

        Failures of requests using a data center-specific URL with 200, 300, and 500 series response codes are listed in this report.

        • 200 series response codes: The request was processed, but it does not mean the request routing (the domain used in the request) is correct.

        • 300 series response codes: Indicate that the response was redirected. However, it also indicates that the request routing (the domain used in the request) should be fixed.

          Examples of some of the 300 series response codes include:

          • 301 Moved Permanently

          • 302 Found

          • 308 Permanent Redirect

        • 500 series response codes: The operation failed on the NetSuite side because the server could not process the response.

          • You may need to fix the request routing (the domain used in the request).

          • You should also investigate what else may be wrong with the request that caused the server to fail to process the request.

        For more information about HTTP status codes, refer to the following websites:

        Count

        The number of times during the reporting period that the traffic with the same parameters used a data center-specific domain.

        Count can help you to determine the severity of the problem. Prioritize correcting line items with a high value in the Count column. A higher number indicates a larger volume of traffic is using a data center-specific URL.

  2. Update RESTlet integrations so that they either use your account-specific domain or use a method to dynamically discover the correct URL. For more information about dynamic discovery for RESTlets, see The DataCenterUrls REST Service. To help you determine whether you should you use an account-specific domain or a dynamic discovery method, see the following:

    • If the integration will run in multiple NetSuite accounts, you must use getDataCenterURLs to retrieve the correct URL for the accounts that you integrate with from https://rest.netsuite.com/rest/datacenterurls. Situations where you must use dynamic discovery methods to determine the correct URL include, for example:

      • If you are a partner developing RESTlet integrations for more than one NetSuite customer.

      • If you are a NetSuite customer and you intend to run the RESTlet integration in your NetSuite production, sandbox, Release Preview, or other account type.

    • If the integration will run in a single NetSuite account, use a RESTlet URL with your account-specific domain. Administrators and other users with the Set Up Company permission can go to Setup> Company > Company Information and click the Company URLs subtab to view the account-specific domains available for the account where they are currently logged in.

  3. After you have updated all of the RESTlets listed in the original report, generate a fresh report to validate there are no RESTlets in your account that are using data center-specific domains.

  4. Repeat this entire procedure as needed to continue correcting items listed on your Traffic Health report until no items remain in the list.

Related Topics

General Notices