Tables¶

Tables - Create¶

Creates a dynamic table that stores the specified field and field values synchronously during the runtime for a limited or an unlimited period of time.

POST

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

Parameter

Field	Label in UI	Type	Description
agelimit_day	Day	int	Expiration time for the values in the table. The values expire after the specified age limit. The value of the parameter must be in days and the maximum value should not be more than 9999 days. Mandatory Field.
agelimit_hour	Hour	int	Specify the value of the age limit in hours. The maximum value for this field is 23. Mandatory Field.
agelimit_minute	Minute	int	Specify the value of the age limit in minutes. The maximum value for this field is 59. The age limit must be at least 30 or 0 minutes. If you do not want the values to expire, set the age limit to 0. Mandatory Field.
source_name	Name	String	Specify the name for the table which is automatically represented in uppercase. The value can be alphanumeric characters with underscore(_) and the value should not begin or end with white space character and hyphen(-). Mandatory Field.

Request Example

{
    "data": {
        "agelimit_day": 4,
        "agelimit_hour": 5,
        "agelimit_minute": 39,
        "source_name": "TABLE"
    }
}

Success Response

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

Tables - Edit¶

Updates a dynamic table that stores the specified field and field values during the runtime for a limited or an unlimited period of time with given ID.

PUT

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

Parameter

Field	Label in UI	Type	Description
agelimit_day	Day	int	Expiration time for the values in the table. The values expire after the specified age limit. The value of the parameter must be in days and the maximum value should not be more than 9999 days. Mandatory Field.
agelimit_hour	Hour	int	Specify the value of the age limit in hours. The maximum value for this field is 23. Mandatory Field.
agelimit_minute	Minute	int	Specify the value of the age limit in minutes. The maximum value for this field is 59. The age limit must be at least 30 or 0 minutes. If you do not want the values to expire, set the age limit to 0. Mandatory Field.
id	-	String	Existing table ID. Mandatory Field.

Request Example

{
    "data": {
        "agelimit_day": 4,
        "agelimit_hour": 5,
        "agelimit_minute": 39
    }
}

Success Response

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

Tables - Get¶

Fetches a single dynamic table with given ID.

GET

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing table ID. Obtain the current data of tables with Logpoint’s tables using EnrichmentSource-RefreshList.

Success Response

{
    "active": true,
    "age_limit": 365940,
    "delete_status": "",
    "id": "634e3c347d022ec4084f8d83",
    "last_updated": 1666071858,
    "plugin_info": {
        "enrichment_options": {
            "age_limit": 365940
        },
        "source_fields": [
            {
                "field": "device_ip",
                "type": "IP"
            },
            {
                "field": "norm_id",
                "type": "string"
            }
        ],
        "table_option": {
            "dynamictable_name": "DEVICE_IP_TABLE"
        }
    },
    "reason": null,
    "result": "Updated",
    "source_info": {
        "id": "a62b1ae1d316ba691fb7549bc4210e7f",
        "source_name": "dynamictable"
    },
    "source_name": "DEVICE_IP_TABLE",
    "source_type": "DynamicTable",
    "tid": ""
}

Tables - List¶

Lists all dynamic tables. Obtain the current data of tables with Logpoint’s tables using EnrichmentSource-RefreshList.

GET

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

Success Response

[
    {
        "active": true,
        "age_limit": 365940,
        "delete_status": "",
        "id": "634e3c347d022ec4084f8d83",
        "last_updated": 1666071858,
        "plugin_info": {
            "enrichment_options": {
                "age_limit": 365940
            },
            "source_fields": [
                {
                    "field": "device_ip",
                    "type": "IP"
                },
                {
                    "field": "norm_id",
                    "type": "string"
                }
            ],
            "table_option": {
                "dynamictable_name": "DEVICE_IP_TABLE"
            }
        },
        "reason": null,
        "result": "Updated",
        "source_info": {
            "id": "a62b1ae1d316ba691fb7549bc4210e7f",
            "source_name": "dynamictable"
        },
        "source_name": "DEVICE_IP_TABLE",
        "source_type": "DynamicTable",
        "tid": ""
    }
]

Tables - Trash¶

Deletes the dynamic table with the given ID.

DELETE

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing table ID. Mandatory Field.

Success Response

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

Helpful?