Detect whether the Xconf Log Server is active or not.

• {{ip_address}} is the IP Address for the log server.
• {{version}} is a string literal indicating the version number for the API.

Reponse

The response for this request will be a JSON formatted string.

{
    "message": "pong"
}

Example

http://192.168.1.28:8080/api/v1/ping

where 192.168.1.28 is the IP Address of the log server and v1 is version 1 of the API.

Upload a log file to the log server.

• {{ip_address}} is the IP Address for the log server.
• {{version}} is a string literal indicating the version number for the API.

Body Defintion

The body is comprised of three key/value pairs:

• filename : The file to upload.
• description : A description of the file (optional).
• contact : Contact information for the file, i.e. email address (optional).

The RDK LLC Xconf Data Server requires the filename parameter. The description and contact parameters are not currently supported by the RDK LLC Xconf clients.

Reponse

The reponse to this request will be a JSON formatted string.

Success Response

Upon success the string will contain the meta-data associated with the uploaded file.

{
    "message": "Log upload success",
    "reason": "",
    "info": [
        {
            "timeID": {{uuid}},
            "fileName": {{file_name}},
            "location": {{file_location}},
            "size": {{file_size}},
            "createDate": {{create_data}},
            "owner": {{owner}},
            "contact": {{email}},
            "description": {{description}}
        }
    ]
}

{{uuid}} is a unique identifier based on a timestamp when the log was uploaded. This identifier is generated by the log server.

{{file_name}} is the name of the log file.

{{file_location}} is the location on the file server where the log is stored. The location will be determined by the log server configuration.

{{file_size}} is the size of the log files, in Bytes.

{{create_data}} is the creation date for the log file, extracted from the file_name.

{{owner}} is the owner of the log file, extracted from the file_name.

{{email}} is contact information for the log file. This value is not currently supported by the Xconf client.

{{description}} is textual information describing the contents of the log file. This value isnot currently supported by the Xconf client.

For example:

{
    "message": "Log upload success",
    "reason": "",
    "info": [
        {
            "timeID": "d8f9724b-7dd2-11ea-81e1-000c29c9ae51",
            "fileName": "B827EBEADCAB_Logs_03-31-20-09-55PM.tgz",
            "location": "file:///opt/logserver/logs",
            "size": 119042,
            "createDate": "2020-03-31T21:55:00-06:00",
            "owner": "B827EBEADCAB",
            "contact": "mmillard@alticast.com",
            "description": "Xconf Log Files Package"
        }
    ]
}

Error Response

In addition to the HTTP status, an error response will return a JSON formatted string:

{
    "message": "Upload error",
    "reason": {{reason_for_error}}
}

where {{reason_for_error}} will be a textual description for the error.

For example:

{
    "message": "GET Form error",
    "reason": "http: no such file"
}

Example

http://192.168.1.28:8080/api/v1/logs/upload.

where 192.168.1.28 is the log server IP Address and v1 is version 1 of the API.