Macros

Macros - Create

Creates a new macro in a Fabric-enabled LogPoint.

POST

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

Parameters

Field	Label in UI	Type	Description
name	Name	String	Name for the macro. The field supports alpha-numeric and underscore (_) characters. Mandatory Field
query	Query	String	Complete and valid Query. Mandatory Field

Request Example

{
    "data": {
        "name": "admin_log",
        "query": "user=admin"
    }
}

Success Response

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

Macros - Edit

Edits the macro with given ID.

PUT

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

Parameters

Field	Label in UI	Type	Description
id	-	String	Existing Macro id. Obtain the value of the required Macro id using Macros - List API. Mandatory Field
name	Name	String	Name for the macro. The field supports alpha-numeric and underscore (_) characters. Mandatory Field
query	Query	String	Complete and valid Query. Mandatory Field

Request Example

{
    "data": {
        "name": "admin_log",
        "query": "user=admin"
    }
}

Success Response

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

Macros - Get

Fetches the macro with given ID.

GET

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

Parameters

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

Success Response

{
    "id": "4ffbe8018dc3ad85f8116940",
    "name": "admin_log",
    "query": "user=admin",
    "tid": "",
    "user": "admin"
}

Macros - Install

Install a given pak file containing macros.

POST

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

Parameters

Field	Label in UI	Type	Description
file_location	-	String	Location of the file uploaded to install. Can be either 'private' or 'public'. Mandatory Field
file_name	Macros	String	Name of the pak file containing Macros. Mandatory Field

Request Example

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

Success Response

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

Macros - List

Lists all macros in the Fabric-enabled LogPoint.

GET

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

Success Response

[
    {
        "id": "4ffbe8018dc3ad85f8116940",
        "name": "admin_log",
        "query": "user=admin",
        "tid": "",
        "user": "admin"
    }
]

---

Macros - ListPrivateUploads

List all the pak files that contain macro configurations in private storage.

GET

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

Success Response

[
    "macros.pak"
]

Macros - ListPublicUploads

List all the pak files that contain macro configurations in public storage.

GET

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

Success Response

[
    "macros.pak"
]

Macros - Trash

Removes the macro with given ID.

DELETE

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

Parameters

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

Success Response

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

Macros - TrashPrivateUploads

Delete the file with given name from private storage.

DELETE

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

Parameters

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

Success Response

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

Macros - TrashPublicUploads

Delete the file with given name from public storage.

DELETE

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

Parameters

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

Success Response

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

Macros - Upload

Upload pak files that contain macros to private storage. This upload should be used for macros only.

POST

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

Headers

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

Parameters

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

Success Response

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

Macros - UploadPublic

Upload pak files that contain macros to public storage. This upload should be used for macros only.

POST

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

Headers

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

Parameters

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

Success Response

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