Page Contents

SystemSettingsSyslog

SystemSettingsSyslog¶

SystemSettingsSyslog - InstallCertificate¶

Installs the certificate and key in the selected Logpoint and updates Syslog settings.

POST

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

Parameter

Field	Label in UI	Type	Description
certificate	Certificate	String	Name of the certificate file to install. Mandatory only when the value of the key is present in the request. Optional Field.
file_location	-	String	Location of the file to install. Can be either ‘private’ or ‘public’. Mandatory only when the value of the key and the certificate is present in the request. Optional Field.
key	Key	String	Name of the key file to install. Mandatory only when the value of the certificate is present in the request. Optional Field.
sequence_number	Sequence Numbering	boolean	Flag for adding sequence numbers to the log received from the Syslog Collector. Value can be ‘true’ or ‘false’. Optional Field.
syslog_max_log_size_kb	Message Length	int	Maximum possible length of a syslog message in kb. Default value is 12kb. Minimum value is 1kb and it’s value cannot be greater than 64 kb. Optional Field.

Request Example

{
    "data": {
        "certificate": "client.crt",
        "file_location": "public",
        "key": "client.key",
        "sequence_number": "true",
        "syslog_max_log_size_kb": 7
    }
}

Success Response

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

SystemSettingsSyslog - List¶

List all the keys and certificates in private storage for the requested pool.

GET

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

Success Response

[
    "client.key",
    "client.crt"
]

SystemSettingsSyslog - ListPublic¶

List all the keys and certificates in public storage.

GET

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

Success Response

[
    "client.key",
    "client.crt"
]

SystemSettingsSyslog - ListSyslogSettings¶

Lists current syslog settings

GET

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

Success Response

[
    {
        "certificate_status": {
            "organization": "MGO",
            "server_name": false,
            "status": "MGO Certificates have already been installed"
        },
        "sequence_number": true,
        "syslog_max_log_size_kb": 8
    }
]

SystemSettingsSyslog - TrashPrivate¶

Deletes the file with the provided name from private storage.

DELETE

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

Parameter

Field	Label in UI	Type	Description
file_name		String	File to be deleted. Mandatory Field.

Success Response

{
    "status": "Success",
    "message": "client.crt successfully deleted"
}

SystemSettingsSyslog - TrashPublic¶

Deletes the file with the provided name from public storage.

DELETE

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

Parameter

Field	Label in UI	Type	Description
file_name		String	File to be deleted. Mandatory Field.

Success Response

{
    "status": "Success",
    "message": "client.key successfully deleted"
}

SystemSettingsSyslog - UploadCertificate¶

Uploads the certificate and the key to public storage.

POST

https://api-server-host-name/configapi/SystemSettingsSyslog/certificate

Header

Field	Label in UI	Description
Content-Type		multipart/form-data
replace_existing		Change the parameter value to ‘true’ to replace the existing file with a new one with the same name. Default value is ‘false’. Value can only be ‘true’ or ‘false’. Optional field.

Parameter

Field	Label in UI	Type	Description
certificate	Certificate	[Object]	ssl certificate to be uploaded. Mandatory Field.
key	Key	[Object]	ssl key to be uploaded. Mandatory Field.

Success Response

{
    "status": "Success",
    "message": "Certificate and key successfully uploaded"
}

SystemSettingsSyslog - UploadCertificateToPool¶

Uploads the certificate and the key to private storage.

POST

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

Header

Field	Label in UI	Description
Content-Type		multipart/form-data
replace_existing		Change the parameter value to ‘true’ to replace the existing file with a new one with the same name. Default value is ‘false’. Value can only be ‘true’ or ‘false’. Optional field.

Parameter

Field	Label in UI	Type	Description
certificate	Certificate	[Object]	ssl certificate to be uploaded. Mandatory Field.
key	Key	[Object]	ssl key to be uploaded. Mandatory Field.

Success Response

{
    "status": "Success",
    "message": "Certificate and key successfully uploaded"
}

Helpful?