SystemSettingsHTTPS¶

SystemSettingsHTTPS - InstallCertificate¶

Install the certificate and key in the provided logpoint

POST

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

Parameter

Field	Label in UI	Type	Description
certificate	Certificate	String	Name of the certificate file to install. Mandatory Field
file_location	-	String	Location of the file to install. Can be either ‘private’ or ‘public’. Mandatory Field
key	Key	String	Name of the key file to install. Mandatory Field

Request Example

{
    "data": {
        "certificate": "ssl.crt",
        "file_location": "private",
        "key": "ssl.key"
    }
}

Success Response

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

List all the keys and certificate in private storage for the requested pool

GET

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

Success Response

[
    "ssl.key",
    "ssl.crt"
]

List all the keys and certificate in public storage

GET

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

Success Response

[
    "ssl.key",
    "ssl.crt"
]

Delete the file with given name from private storage

DELETE

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

Parameter

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

Success Response

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

Delete the file with given name from public storage

DELETE

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

Parameter

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

Success Response

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

Upload certificate and key to public storage

POST

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

Header

Field	Label in UI	Description
Content-Type		multipart/form-data
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

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"
}

Upload certificate and key to private storage

POST

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

Header

Field	Label in UI	Description
Content-Type		multipart/form-data
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

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?