{"info":{"_postman_id":"ff69b819-eb7b-42db-a9cd-f5f3d0b22ec3","name":"XConf Log Server","description":"

This collection defines the REST API between the Alticast Xconf Log Server and the RDK LLC Xconf Data Server. The API is used to upload log files to the Log Server as well as gather meta-data associated with the logs.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5341212","collectionId":"ff69b819-eb7b-42db-a9cd-f5f3d0b22ec3","publishedId":"SzmcbzBm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-05-11T23:20:08.000Z"},"item":[{"name":"Admin","item":[{"name":"Ping logserver Request","id":"7e00d912-0d7f-4b1a-900a-33fe6a81a125","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://{{ip_address}}:8080/api/{{version}}/ping","description":"

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.

{\n    \"message\": \"pong\"\n}\n

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.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","{{version}}","ping"],"host":["{{ip_address}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7e00d912-0d7f-4b1a-900a-33fe6a81a125"}],"id":"362bf12f-fb77-4b54-b840-c3d085b962b1","description":"

The Admin APIs are used to administer the Alticast Xconf Log Server.

\n","_postman_id":"362bf12f-fb77-4b54-b840-c3d085b962b1"},{"name":"API v1","item":[{"name":"Upload File Request","id":"4365f7a1-33d8-433a-9fe9-9dd6601f17d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"filename","description":"

The name of the file to upload.

\n","type":"file","value":null},{"key":"description","value":"Xconf Log Files Package","description":"

Description of the uploaded file.

\n","type":"text"},{"key":"contact","value":"mmillard@alticast.com","description":"

Contact information, i.e. email address for file submitter.

\n","type":"text"}]},"url":"http://{{ip_address}}:8080/api/{{version}}/logs/upload","description":"

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.

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

{{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:

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

Error Response

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

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

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

For example:

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

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.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","{{version}}","logs","upload"],"host":["{{ip_address}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4365f7a1-33d8-433a-9fe9-9dd6601f17d0"},{"name":"Download File Request","id":"553cb22d-bbe3-4bd5-aeb7-b84e049b21ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://{{ip_address}}:8080/api/{{version}}/logs/download?name={{file_name}}","description":"

Download 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.
{{file_name}} is the name of the file to download.

Reponse

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

Success Response

Upon success the contents of the file will be downloaded.

Error Response

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

{\n    \"message\": \"Download error\",\n    \"reason\": {{reason_for_error}}\n}\n

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

For example:

{\n    \"message\": \"Download log error\",\n    \"reason\": \"stat /opt/logserver/logs/_Logs_03-31-20-09-55PM.tgz: no such file or directory\"\n}\n

Example

http://192.168.1.28:8080/api/v1/logs/download?name=B827EBEADCAB_Logs_03-31-20-09-55PM.tgz.

where 192.168.1.28 is the log server IP Address, v1 is version 1 of the API and B827EBEADCAB_Logs_03-31-20-09-55PM.tgz is the name of the file to download.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","{{version}}","logs","download"],"host":["{{ip_address}}"],"query":[{"description":{"content":"

The name of the log to download.

\n","type":"text/plain"},"key":"name","value":"{{file_name}}"}],"variable":[]}},"response":[],"_postman_id":"553cb22d-bbe3-4bd5-aeb7-b84e049b21ba"},{"name":"Delete File Request","id":"3c6e912f-bfbe-490d-8712-b33ce8ea8bdc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"http://{{ip_address}}:8080/api/{{version}}/logs/{{file_name}}","description":"

Delete a log from the Xconf Log Server.

{{ip_address}} is the IP Address for the log server.
{{version}} is a string literal indicating the version number for the API.
{{file_name}} is the name of the file to delete.

Reponse

The response for this request will be a JSON formatted string indicating success or failure.

Success Response

{\n    \"message\": \"Delete success\",\n    \"reason\": \"\"\n}\n

Error Response

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

{\n    \"message\": \"Delete error\",\n    \"reason\": {{reason_for_error}}\n}\n

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

For example:

{\n    \"message\": \"Delete error\",\n    \"reason\": \"stat /opt/logserver/logs/B827EBEADCAB_Logs_03-31-20-09-55PM.tgz: no such file or directory\"\n}\n

Example

http://192.168.1.28:8080/api/v1/logs/B827EBEADCAB_Logs_03-31-20-09-55PM.tgz

where 192.168.1.28 is the IP Address of the log server, v1 is version 1 of the API and B827EBEADCAB_Logs_03-31-20-09-55PM.tgz is the name of the file to delete.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","{{version}}","logs","{{file_name}}"],"host":["{{ip_address}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c6e912f-bfbe-490d-8712-b33ce8ea8bdc"},{"name":"Info Request","id":"099cfbef-8726-456d-b7f2-69d37666c709","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://{{ip_address}}:8080/api/{{version}}/logs/info?id={{uuid}}&fileName={{file_name}}&owner={{owner}}&createDate={{create_date}}&size={{size}}","description":"

Retrieve log files' meta-data from 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.

Filtering parameters include:

{{uuid}} is a unique identifier assigned to the log when it is uploaded to the server.
{{file_name}} is the name of the file that was uploaded to the server.
{{owner}} is the name of the log file's owner (i.e. the device MAC Address).
{{create_date}} is the creation date timestamp for the log file.
{{size}} is the size of the file (in KB).

Based on the filtering parameters, the query will find all matching entries in the log server database. If no parameters are specified, then all entries in the database will be returned. If no match is found in the database for the specified parameters, then success will be returned but the array of info JSON elements will be empty.

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(s). The response may contain information for multiple logs based on the parameters passed as part of the query.

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

{{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.

Error Response

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

{\n    \"message\": \"Info error\",\n    \"reason\": {{reason_for_error}}\n}\n

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

For example:

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

Examples

File name filtering example

http://192.168.1.28:8080/api/v1/logs/info?fileName=B827EBEADCAB_Logs_03-31-20-09-55PM.tgz.

where 192.168.1.28 is the log server IP Address, v1 is version 1 of the API and B827EBEADCAB_Logs_03-31-20-09-55PM.tgz is the name of the log to retrieve the meta-data for.

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

No matching filtering example

http://192.168.1.28:8080/api/v1/logs/info?fileName=log_does_not_exist.tgz.

where 192.168.1.28 is the log server IP Address, v1 is version 1 of the API and log_does_not_exist is the name of the log to retrieve the meta-data for (but it does not exist on the log erver).

{\n    \"message\": \"Info retrieval success\",\n    \"reason\": \"\",\n    \"info\": []\n}\n

","urlObject":{"protocol":"http","port":"8080","path":["api","{{version}}","logs","info"],"host":["{{ip_address}}"],"query":[{"description":{"content":"

A unique identifier for the file meta-data

\n","type":"text/plain"},"key":"id","value":"{{uuid}}"},{"description":{"content":"

The name of the file to retrieve.

\n","type":"text/plain"},"key":"fileName","value":"{{file_name}}"},{"description":{"content":"

The owner of the file to retrieve.

\n","type":"text/plain"},"key":"owner","value":"{{owner}}"},{"description":{"content":"

The date of creation for the file to retrieve.

\n","type":"text/plain"},"key":"createDate","value":"{{create_date}}"},{"description":{"content":"

The size of the file to retrieve.

\n","type":"text/plain"},"key":"size","value":"{{size}}"}],"variable":[]}},"response":[],"_postman_id":"099cfbef-8726-456d-b7f2-69d37666c709"}],"id":"189e8220-a7cc-4e5d-b1e1-24e9397e9184","description":"

Version v1 of the log server REST APIs.

\n","_postman_id":"189e8220-a7cc-4e5d-b1e1-24e9397e9184"}]}