HTTP Log API

Overview

The HTTP Log API is responsible for receiving incoming tenant log data via HTTP(S).

Media Types

The API supports application/json encoded as UTF-8.

API Versioning

See the Versioning API

HTTP(S) Publish Message

This resource accepts a structured message (log data). The incoming message structure should follow the prescribed message format for Meniscus.

Template

*indicates required field

POST /v1/{tenant_id}/publish HTTP/1.1
{
    "log_message": {
    	"host": "{string}*",
    	"pname": "{string}*",
    	"time": "{date-rfc3339}*",
    	"native": {object},
        "msg": {string},
        "profile": {string},
        "ver": {string},
        "msgid": {string},
        "pri": {string},
        "pid": {string},
    }
}

Request

POST /v1/973dcbd2-3af9-462a-8c89-541879b5a557/publish HTTP/1.1
ACCEPT: application/json
CONTENT-TYPE: application/json
MESSAGE-TOKEN: 94d6177b-9188-4209-8548-7374d0326a6b
{
    "log_message": {
        "profile": "http: //projectmeniscus.org/cee/profiles/base",
        "ver": "1",
        "msgid": "-",
        "pri": "46",
        "pid": "-",
        "host": "corky",
        "pname": "rsyslogd",
        "time": "2013-04-02T14: 12: 04.873490-05: 00",
        "msg": "start",
        "native": {
            "origin": {
                "x-info": "http: //www.rsyslog.com",
                "swVersion": "7.2.5",
                "x-pid": "12662",
                "software": "rsyslogd"
            }
        }
    }
}

Tenant's expected response from the API:

HTTP/1.1 202 ACCEPTED
CONTENT-TYPE: application/json

Tenant's expected response from the API:

HTTP/1.1 204 NO CONTENT