Installing VPCFlowLog¶

Uploading VPCFlowLog to the Fabric Storage¶

Private Location¶

You can upload VPCFlowLog to a private location in the Fabric Storage using the Upload - Upload API.

Endpoint URL:

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

Method:

POST

Header:

FIELD	DESCRIPTION
file_name	Name of the VPCFlowLog .pak file.
Content-Type	Mandatory value: `(application/octet-stream)`.

Parameters:

FIELD	TYPE	DESCRIPTION	REQUIRED
file	[Object]	The VPCFlowLog .pak file to upload.	Mandatory

Success Response:

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

Public Location¶

You can upload VPCFlowLog to a public location in the Fabric Storage using the Upload - UploadPublic files API.

Endpoint URL:

https://api-server-host-name/configapi/Uploads/PublicUpload

Method:

POST

Header:

FIELD	DESCRIPTION
file_name	Name of the VPCFlowLog .pak file.
Content-Type	Mandatory value: `(application/octet-stream)`.

Parameters:

FIELD	TYPE	DESCRIPTION	REQUIRED
file	[Object]	The VPCFlowLog .pak file to upload.	Mandatory

Success Response:

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

Installing VPCFlowLog in Logpoint¶

You can install VPCFlowLog in a Fabric-enabled Logpoint using the Upload - Install API. It must be uploaded to the Fabric Storage before the installation.

Endpoint URL:

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

Method:

POST

Parameters:

FIELD	LABEL IN UI	TYPE	DESCRIPTION	REQUIRED
application_type	–	String	Mandatory value: `Application`.	Mandatory
file_name	–	String	Name of the application file. Obtain it from the public location using the Upload - ListPublic API and the private location using the Upload - List API.	Mandatory
file_location	–	String	Location of the application file. Can be either `private` or `public`.	Mandatory

Request Example:

 {
 "data": {
     "application_type": "Application",
     "file_name": "VPCFlowLog_6.1.0.pak",
     "file_location": "private"
 }
}

Success Response:

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

Uninstalling VPCFlowLog¶

You can uninstall VPCFlowLog in a Fabric-enabled Logpoint using the Plugins - Uninstall API. You must first remove the VPCFlowLog configuration to uninstall it.

Endpoint URL:

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

Method

Delete

Parameters:

FIELD	LABEL IN UI	TYPE	DESCRIPTION	REQUIRED
id	–	String	VPCFlowLog application ID. Obtain it using the Plugins - List API.	Mandatory

Success Response:

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

Helpful?