SearchLabels¶

SearchLabels - Activate¶

Activates the search label with given id .

POST

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

Parameter

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

Request Example

{
    "data": {}
}

Success Response

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

SearchLabels - Create¶

Creates a new search label in a Fabric-enabled LogPoint.

POST

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

Parameter

Field	Label in UI	Type	Description
package_id	Package	String	ID of the label package. Obtain the value of the required Label Package id using LabelPackages - List API. Mandatory Field
search_label	List of Labels	[String]	List of the labels. Mandatory Field
search_query	Search Query	String	Complete and valid Query or value can contain the name of the existing Macros inside ``. Optional Field

Request Example

{
    "data": {
        "package_id": "574fceedd8aaa40740736302",
        "search_label": [
            "ip",
            "device_ip"
        ],
        "search_query": "device_ip=127.0.0.1"
    }
}

Success Response

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

SearchLabels - Deactivate¶

Deactivates the search label with given id .

POST

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

Parameter

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

Request Example

{
    "data": {}
}

Success Response

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

SearchLabels - Edit¶

Edits the search label with given ID in a Fabric-enabled LogPoint.

PUT

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing Search Label id . Obtain the value of the required Search Label id using SearchLabels - List API. Mandatory Field
search_label	List of Labels	[String]	List of the labels. Mandatory Field
search_query	Search Query	String	Complete and valid Query or value can contain the name of the existing Macros inside ``. Optional Field

Request Example

{
    "data": {
        "search_label": [
            "ip",
            "device_ip"
        ],
        "search_query": "device_ip=127.0.0.1"
    }
}

Success Response

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

SearchLabels - Trash¶

Removes the search label with given ID.

DELETE

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

Parameter

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

Success Response

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

Helpful?