Fetch IP Footprints Across Sources

Fetches the list of sources where the IP traces are found. It is a solution for retrieving IP trace data from multiple sources through a unified, generic API.

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.

Request Structure

Endpoint: /ddi-ip-footprints
Type: POST
Sample URL: https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ddi-ip-footprints?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
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

Sample Request/Response

Use Case

This API is designed to retrieve a list of data sources that contain traces for a given IP address.

Request URL
https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ddi-ip-footprints?gwsource=external
Request Payload 
{
  "payload": {
    "ipAddress": "10.10.10.3"
  }
}
Sample Response 
{
  "sources": ["adc", "cmdb", "tanium", "forwardNetworks"]
}

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.