Page Contents

IPLookup

IPLookup¶

IPLookup - Delete¶

Delete the IPLookup Table with given ID

DELETE

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/IPLookup/{id}

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing IPLookup Table id. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "/monitorapi/v1/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

IPLookup - Install¶

Install a given application

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/IPLookup/install

Parameter

Field	Label in UI	Type	Description
file_location	-	String	Location of the file to install. can be either ‘private’ or ‘public’. Mandatory Field
file_name	File	String	Name of the csv file for IP Lookup. Mandatory Field
name	Name	String	Name of IPLookup table to be created. Mandatory Field

Request Example

{
    "data": {
        "file_location": "private",
        "file_name": "ip_lookup.csv",
        "name": "IP"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/v1/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

IPLookup - List¶

List all IPLookup tables

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/IPLookup

Success Response

[
    {
        "filepath": "/opt/immune/app_store/IPLookup/IP.csv",
        "id": "5a1fd6ffd8aaa41eeee5e5cd",
        "name": "IP",
        "tid": ""
    },
    {
        "filepath": "/opt/immune/app_store/IPLookup/IP5.csv",
        "id": "5a20f85bd8aaa41eeee5e5d0",
        "name": "IP5",
        "tid": ""
    }
]

IPLookup - TrashPrivate¶

Delete the file with given name from private storage

DELETE

https://api-server-host-name/configapi/{pool_UUID}/IPLookup/{file_name}

Parameter

Field	Label in UI	Type	Description
file_name		String	File to be deleted. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "IP1.csv successfully deleted"
}

IPLookup - TrashPublic¶

Delete the file with given name from public storage

DELETE

https://api-server-host-name/configapi/IPLookup/{file_name}

Parameter

Field	Label in UI	Type	Description
file_name		String	File to be deleted. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "IP1.csv successfully deleted"
}

IPLookup - Upload¶

Upload files to private storage

POST

https://api-server-host-name/configapi/{pool_UUID}/IPLookup/upload

Header

Field	Label in UI	Description
file_name		File name of the file.
Content-Type		application/octet-stream
replace_existing		Set the value of this parameter as ‘true’ to replace the existing file with the same name with the new file. Default value is ‘false’. Value can be ‘true’ or ‘false’. Optional field

Parameter

Field	Label in UI	Type	Description
file	-	[Object]	(csv) to be uploaded. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "IP1.csv successfully uploaded in private storage. "
}

IPLookup - UploadPublic¶

Upload files to public storage

POST

https://api-server-host-name/configapi/IPLookup/publicupload

Header

Field	Label in UI	Description
file_name		File name of the file.
Content-Type		application/octet-stream
replace_existing		Set the value of this parameter as ‘true’ to replace the existing file with the same name with the new file. Default value is ‘false’. Value can be ‘true’ or ‘false’. Optional field

Parameter

Field	Label in UI	Type	Description
file	-	[Object]	(csv) to be uploaded. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "IP1.csv successfully uploaded in public storage."
}

IPLookup - UploadsList¶

List all files in private storage

GET

https://api-server-host-name/configapi/{pool_UUID}/IPLookup/list

Success Response

[
    "test.csv"
]

IPLookup - UploadsListPublic¶

List all files in public storage

GET

https://api-server-host-name/configapi/IPLookup/list

Success Response

[
    "test.csv"
]

Helpful?