Integrations /

List log sinks

Gets a list of log sinks added to this account.

Required permission

Account > Sinks > General > Read

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

logSinks
[array] required
An array of log sinks added to this account.

{object}
A log sink object.

name
string required
Name of the log sink.
id
string required
Identifier for the Log Sink
description
string
Description of the log sink.
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
restricted
boolean required
If `true`, only logs from the projects in `projects` will be sent to the log sink.
projects
[array] required
If `restricted` is `true`, only logs from these projects will be sent to the log sink.

string
The ID of a project.
pattern
^[A-Za-z0-9-]+$

status
string required
Current status of the log sink
one of
paused, running, failing, creating
options
{object}

useCustomLabels
boolean
If `true`, we will do additional parsing on your JSON formatted log lines and your extract custom labels
forwardCdnLogs
boolean
Forward CDN logs from your workloads
forwardIngressLogs
boolean
Forward ingress logs from your workloads
forwardMeshLogs
boolean
Forward mesh logs from your workloads

sinkType
string required
The type of the log sink.
one of
loki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, axiom, newRelic
createdAt
string required
Timestamp of when the log sink was created.
updatedAt
string required
Timestamp of when the log sink was last updated.

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/integrations/log-sinks

Example response

200 OK

The list of log sinks.

JSON

{
  "data": {
    "logSinks": [
      {
        "name": "example-log-sink",
        "id": "example-project",
        "description": "This is an example log sink.",
        "restricted": true,
        "projects": [
          "default-project"
        ],
        "options": {
          "useCustomLabels": true,
          "forwardCdnLogs": true,
          "forwardIngressLogs": true,
          "forwardMeshLogs": true
        },
        "sinkType": "loki",
        "createdAt": "2022-06-14 15:10:42.842Z",
        "updatedAt": "2022-06-14 15:10:42.842Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}