loki/docs/api.md

API

nb Authentication is out of scope for this project. You are expected to run an authenticating reverse proxy in front of our services, such as an Nginx with basic auth or a OAuth2 proxy.

There are 4 API endpoints:

• POST /api/prom/push

  For sending log entries, expects a snappy compressed proto in the HTTP Body.

• GET /api/prom/query

  For doing queries, accepts the following parameters in the query-string:

  • query: a logQL query
  • limit: max number of entries to return
  • start: the start time for the query, as a nanosecond Unix epoch (nanoseconds since 1970)
  • end: the end time for the query, as a nanosecond Unix epoch (nanoseconds since 1970)
  • direction: forward or backward, useful when specifying a limit
  • regexp: a regex to filter the returned results, will eventually be rolled into the query language

  Responses looks like this:

  {
    "streams": [
      {
        "labels": "{instance=\"...\", job=\"...\", namespace=\"...\"}",
        "entries": [
          {
            "timestamp": "2018-06-27T05:20:28.699492635Z",
            "line": "..."
          },
          ...
        ]
      },
      ...
    ]
  }
  

• GET /api/prom/label

  For retrieving the names of the labels one can query on.

  Responses looks like this:

  {
    "values": [
      "instance",
      "job",
      ...
    ]
  }
  

• GET /api/prom/label/<name>/values For retrieving the label values one can query on.

  Responses looks like this:

  {
    "values": [
      "default",
      "cortex-ops",
      ...
    ]
  }