Save Log Insight Agent Settings Data V2 Using POST

This API is used to save log insight agent settings.

Request

URI

POST

https://{api_host}/lcm/lcops/api/v2/settings/log-insight-agent

COPY

Request Body

logInsightAgentConfigurationDTO

LogInsightAgentConfigurationDTO of type(s) application/json

Required

{
    "bundleFilePath": "string",
    "hostName": "FQDN of vRLI server",
    "maxBufferSize": 2000,
    "portNumber": 9543,
    "protocol": "CFAPI",
    "reconnect": 30,
    "sslCommonName": "string",
    "sslEnabled": true,
    "sslTrustAcceptAny": false,
    "sslTrustAcceptTrusted": false
}

string

bundleFilePath

Optional

Bundle File Path

string

hostName

Optional

Log Insight server hostname

string

maxBufferSize

Optional

Maximum Buffer Size

string

portNumber

Optional

Port Number

string

protocol

Optional

Protocol

string

reconnect

Optional

Reconnect time

string

sslCommonName

Optional

SSL Common name

boolean

sslEnabled

Optional

SSH status

boolean

sslTrustAcceptAny

Optional

SSL Trust Accept Any

boolean

sslTrustAcceptTrusted

Optional

SSL Trust Accept Trusted

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

Returns LogInsightAgentConfigurationDTO of type(s) application/json

{
    "bundleFilePath": "string",
    "hostName": "FQDN of vRLI server",
    "maxBufferSize": 2000,
    "portNumber": 9543,
    "protocol": "CFAPI",
    "reconnect": 30,
    "sslCommonName": "string",
    "sslEnabled": true,
    "sslTrustAcceptAny": false,
    "sslTrustAcceptTrusted": false
}

string

bundleFilePath

Optional

Bundle File Path

string

hostName

Optional

Log Insight server hostname

string

maxBufferSize

Optional

Maximum Buffer Size

string

portNumber

Optional

Port Number

string

protocol

Optional

Protocol

string

reconnect

Optional

Reconnect time

string

sslCommonName

Optional

SSL Common name

boolean

sslEnabled

Optional

SSH status

boolean

sslTrustAcceptAny

Optional

SSL Trust Accept Any

boolean

sslTrustAcceptTrusted

Optional

SSL Trust Accept Trusted

201

Created

Operation doesn't return any data structure

400

Bad Request

Returns GenericErrorResponseDTO of type(s) application/json

{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}

string

errorCode

Optional

errorCode

string

errorLabel

Optional

errorLabel

string

message

Optional

message

array of string

recommendations

Optional

recommendations

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Returns GenericErrorResponseDTO of type(s) application/json

{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}

string

errorCode

Optional

errorCode

string

errorLabel

Optional

errorLabel

string

message

Optional

message

array of string

recommendations

Optional

recommendations

500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json

{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}

string

errorCode

Optional

errorCode

string

errorLabel

Optional

errorLabel

string

message

Optional

message