Fetch IP Trace Details by Source

This API takes a source name and an IP address as input parameters. It queries the specified source to retrieve detailed trace information related to the given IP address. The response may include additional data from associated sub-sources, providing a comprehensive view of the IP trace.

Before you begin

  • Verify ACF permission for IP Search
    1. Go to Platform > IDENTITY > Role.
    2. Under Role, click the role name, select the Authorized functions tab.
    3. Expand DDI+ > IP Compliance.
    4. Select IP Search to ensure the permission is enabled.
  • Verify that the entered IP address is valid.
  • Confirm that the specified source name is accurate and recognized by the system.

Request Structure

Endpoint: /ddi-ip-trace-details-by-source
Type: POST
Sample URL: https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ddi-ip-trace-details-by-source?gwsource=external

To understand the elements of the sample URL, click here.
Headers:
Content-Type: application/json
Table 1. Input Parameter
Name Description
sessionId

Header

 (Mandatory) After successfully logging in, a unique identifier assigned to a user's session after successful authentication. The session ID remains valid until it expires. The session ID is a string value.

Example: "ce7f1a14-2bf9-4e4a-89a8-bc780a255813"
Or
username

Header

 (Mandatory) AppViewX login username, represented as a string value.

Example: "User"
password

Header

 (Mandatory) AppViewX login username, represented as a string value.

Example: "AppViewX@123"
Payload (Mandatory) Input data for request body in application/json format. For payload details, see Payload section.

Payload

Name Description
source

String

 (Mandatory) Enter the source of the IP address.

Example: cmdb
ipAddress

String

 (Mandatory) Enter the IP address to retrieve the list of sources containing its trace details.

Example: 10.10.10.3

Response Structure

  • Status Code: 200 OK
  • Message:
  • Headers:
    • Content-Type: application/json
Table 2. Response Parameters
Name Description
response Contains the response attributes for the get policy request.
message Success message or failure description in case of error.
appStatusCode Application specific status code for the response. Will be non-null for failure response.
tags More info in case of failure response.

Status Codes

HTTP Code appStatusCode Response Message
200 OK
400 Bad Request VALIDATION_ERROR_0004 Invalid 'ipAddress'
400 Bad Request VALIDATION_ERROR_0004 Mandatory Field 'ipAddress' is missing or empty
400 Bad Request VALIDATION_ERROR_0004 Mandatory Field 'source' is missing or empty
400 Bad Request DNS_RECORDMGMT_026 Invalid source. Requested source not supported for ip search

Sample Request/Response

Use Case

This API is designed to retrieve detailed IP trace information from a specified source identified by source discovery.

Request URL
https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ddi-ip-trace-details-by-source?gwsource=external
Request Payload 
{
  "payload": {
    "source": "cmdb",
    "ipAddress": "10.10.10.3"
  }
}
Sample Response Example 1 (Single Source): 
{
    "response": {
        "DNS Details": [
            {
                "Record Type": "HOST_IPV4ADDR",
                "Vendor": "Infoblox",
                "type": "General",
                "Vendor Account Name": "infobloxSmall",
                "Domain Name": "test3",
                "Name": "test3"
            }
        ]
    }
   }
Sample Response Example 2 (Multiple Sub-Sources) 
{
  "cmdb_source_1": [
    {
      // IP trace details for CMDB sub-source 1
    }
  ],
  "cmdb_source_2": [
    {
      // IP trace details for CMDB sub-source 2
    }
  ]
}

What's Next

Reference

Understanding the sample URL:
  • IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
    • IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication

      The IP address will be included in the endpoint URL for an on-prem deployment.

    • HostName: A human-readable label assigned to a device (host) on a network

      The hostname will be included in the endpoint URL for an on-prem deployment.

    • TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify

      The tenant name will be included in the endpoint URL for a SaaS deployment.

  • GWPORT: AppViewX gateway port

    A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.

    Example: 31443

  • avxapi: Path parameter value (static) that is part of the endpoint's URL
  • Endpoint: Endpoint of the API, for example: execute-hook
  • gwsource: Source or origin of a gateway, for example: external.