Page Contents

LabelPackages

LabelPackages¶

LabelPackages - Activate¶

Activates a LabelPackage with given ID.

POST

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

Parameter

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

Request Example

{
    "data": {}
}

Success Response

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

LabelPackages - Clone¶

Clones a LabelPackage with given ID.

POST

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

Parameter

Field	Label in UI	Type	Description
clone_name	Choose New Names	String	Name of the label package after getting cloned. Each label package name must be unique, and the value of the name parameter can contain alphanumeric characters, hyphen (-), white space character, and underscore (_). It must begin and end with an alphanumeric character and the total length must be between 2 and 100 characters. It must not begin with LP_. Mandatory Field
package_id	-	String	Existing LabelPackage ID. Mandatory Field
replace	Replace Existing?	String	Value can be “on” or “off”. Set value as “on”(exact) to replace an existing package with the same name. Optional Field

Request Example

{
    "data": {
        "clone_name": "mylabelpackage",
        "package_id": "57591a2cd8aaa41bfef54888",
        "replace": "on"
    }
}

Success Response

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

LabelPackages - Create¶

Creates a new Label Package

POST

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

Parameter

Field	Label in UI	Type	Description
description	Description	String	Description of the Label Package. Optional Field
name	Name	String	Name of the label package. Each label package name must be unique, and the value of the name parameter can contain alphanumeric characters, hyphen (-), white space character, and underscore (_). It must begin and end with an alphanumeric character and the total length must be between 2 and 100 characters. It must not begin with LP_. Mandatory Field

Request Example

{
    "data": {
        "description": "this is custom package",
        "name": "mylabelpackage"
    }
}

Success Response

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

LabelPackages - Deactivate¶

Deactivates a LabelPackage with given ID.

POST

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

Parameter

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

Request Example

{
    "data": {}
}

Success Response

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

LabelPackages - Edit¶

Edits the Label Package with given id

PUT

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

Parameter

Field	Label in UI	Type	Description
description	Description	String	Description of the Label Package. Optional Field
id	-	String	LabelPackage id. Mandatory Field
name	Name	String	Name of the label package. Each label package name must be unique, and the value of the name parameter can contain alphanumeric characters, hyphen (-), white space character, and underscore (_). It must begin and end with an alphanumeric character and the total length must be between 2 and 100 characters. It must not begin with LP_. Mandatory Field

Request Example

{
    "data": {
        "description": "this is custom package",
        "name": "mylabelpackage"
    }
}

Success Response

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

LabelPackages - Get¶

Gets the LabelPackage with given ID.

GET

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

Parameter

Field	Label in UI	Type	Description
id	-	String	ID of the existing LabelPackage that you want to fetch.

Success Response

{
    "active": true,
    "description": "abc",
    "id": "5ff5536d6581a5a5aba953b6",
    "labels": [
        {
            "active": false,
            "id": "4bebdbadd8aaa44216bdfc32",
            "labels": [
                "Update",
                "Successful"
            ],
            "package_id": "5ff5536d6581a5a5aba953b6",
            "package_name": "LP_Trend Micro Control Manager ",
            "query": "norm_id=TrendMicroControlManager event_category=*UPDATE_SUCCESS*",
            "share_is": false,
            "tid": "",
            "user": "LogPoint",
            "vid": "SEARCHLABEL_22000"
        }
    ],
    "name": "abc",
    "sharing_policy": "private",
    "tid": "",
    "user": "admin",
    "version": null,
    "vid": ""
}

LabelPackages - Install¶

Install a given labelpackage pak file

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/LabelPackages/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	Search Labels	String	Name of the pak file for LabelPackage. Mandatory Field

Request Example

{
    "data": {
        "file_location": "private",
        "file_name": "labelpackage.pak"
    }
}

Success Response

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

LabelPackages - List¶

Lists all LabelPackages in the Fabric-enabled LogPoint.

GET

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

Success Response

[
    {
        "active": true,
        "description": "abc",
        "id": "5ff5536d6581a5a5aba953b6",
        "labels": [
            {
                "active": false,
                "id": "4bebdbadd8aaa44216bdfc32",
                "labels": [
                    "Update",
                    "Successful"
                ],
                "package_id": "5ff5536d6581a5a5aba953b6",
                "package_name": "LP_Trend Micro Control Manager ",
                "query": "norm_id=TrendMicroControlManager event_category=*UPDATE_SUCCESS*",
                "share_is": false,
                "tid": "",
                "user": "LogPoint",
                "vid": "SEARCHLABEL_22000"
            }
        ],
        "name": "abc",
        "sharing_policy": "private",
        "tid": "",
        "user": "admin",
        "version": null,
        "vid": ""
    }
]

LabelPackages - ListPrivateUploads¶

List all the pak files that contains labelpackages in private storage

GET

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

Success Response

[
    "LabelPackages.pak"
]

LabelPackages - ListPublicUploads¶

List all the pak files that contains labelpackages in public storage

GET

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

Success Response

[
    "LabelPackages.pak"
]

LabelPackages - Trash¶

Removes the LabelPackage with given ID.

DELETE

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

Parameter

Field	Label in UI	Type	Description
id	-	String	ID of the existing LabelPackage that you want to delete. Mandatory Field

Success Response

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

LabelPackages - TrashPrivateUploads¶

Delete the file with given name from private storage

DELETE

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

Parameter

Field	Label in UI	Type	Description
file_name	-	String	Name of the file to be deleted. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "LabelPackages.pak successfully deleted"
}

LabelPackages - TrashPublicUploads¶

Delete the file with given name from public storage

DELETE

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

Parameter

Field	Label in UI	Type	Description
file_name	-	String	Name of the file to be deleted. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "LabelPackages.pak successfully deleted"
}

LabelPackages - Upload¶

Upload pak file containing labelpackages to private storage.

POST

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

Header

Field	Label in UI	Description
file_name		Name of the file to be uploaded.
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]	(pak) to be uploaded. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "LabelPackages.pak successfully uploaded in private storage. "
}

LabelPackages - UploadPublic¶

Upload pak file containing labelpackages to private storage.

POST

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

Header

Field	Label in UI	Description
file_name		Name of the file to be uploaded.
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]	(pak) to be uploaded. Mandatory Field

Success Response

{
    "status": "Success",
    "message": "LabelPackages.pak successfully uploaded in public storage."
}

Helpful?