Integrations /

Get log sink details

Gets details about a given log sink.

Required permission

Account > Sinks > General > Read

Path parameters

logSinkId
string required
ID of the log sink

Response body

{object}
Response object.

data
{object} required
Result data.

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.
sinkData
(multiple options: oneOf)
Data about the log sink.

{object}

endpoint
string required
The endpoint of the Loki log sink.
encoding
{object}
Encoding options

codec
string required
Codec to encode logs in
one of
text, json

auth
{object}
Object containing authentication data for the log sink.

strategy
string
The authentication strategy.
one of
basic
user
string
The username for the log sink.
password
string
The password for the log sink.

{object}

default_api_key
string required
The Datadog API key.
region
string required
The Datadog region.
one of
eu, us, us3, us5

(multiple options: oneOf)

Papertrail Sink Schema.

{object}

Authenticate with a host/port

authenticationStrategy
string required
The authentication strategy.
one of
port
host
string required
The host for the Papertrail log destination.
port
number required
The port for the Papertrail log destination.

{object}

Authenticate with a token.

authenticationStrategy
string required
The authentication strategy.
one of
token
uri
string required
The uri for the Papertrail log destination.
token
string required
The HTTP Token for the Papertrail log destination.

{object}

HTTP Sink Schema.

uri
string required
Uri to send logs to.
encoding
{object}
Encoding options

codec
string required
Codec to encode logs in
one of
text, json

auth
(multiple options: oneOf) required

(multiple options: oneOf)

{object}

No authentication strategy

strategy
string required
No authentication strategy
one of
none

{object}

Authenticate with a basic http strategy.

strategy
string required
Basic HTTP authentication strategy.
one of
basic
user
string
Username for basic http authentication.
password
string required
Password for basic http authentication.

{object}

Authenticate with a bearer token strategy.

strategy
string required
Bearer token authentication strategy.
one of
bearer
token
string
Token for bearer token authentication.

{object}

AWS S3 or compatible API Sink Schema.

endpoint
string required
Endpoint for the AWS S3 or compatible API bucket.
region
string required
Region of the S3 bucket.
one of
eu-west-1, eu-west-2, eu-west-3, eu-central-1, eu-south-1, eu-north-1, us-west-1, us-west-2, us-east-1, us-east2
auth
{object}
Authentication object.

accessKeyId
string required
Access key id for the bucket.
secretAccessKey
string required
Secret access key for the bucket.

bucket
string required
Name of the S3 Bucket.
compression
string required
Log file compression method.
one of
gzip, none

{object}

Better Stack (Previously Logtail) Sink Schema.

token
string required
Better Stack Source Token

{object}

LogDNA Sink Schema.

api_key
string required
Ingestion Key

{object}

Honeycomb Sink Schema.

api_key
string required
Honeycomb API Key
dataset
string required
Name of the dataset

{object}

dataset
string required
Name of the data
token
string required
Axiom API/Personal token
tokenType
string required
Using a personal token
one of
personal, api
orgId
string
The ID of the organisation, required if using a personal token
url
string required
The Axiom url to use. Only change if self hosting axiom.

API

CLI

JS Client

GET /v1/integrations/log-sinks/{logSinkId}

Example response

200 OK

Details about a log sink.

JSON

{
  "data": {
    "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",
    "sinkData": {
      "endpoint": "https://logs.example.com",
      "encoding": {
        "codec": "json"
      },
      "auth": {
        "strategy": "basic",
        "user": "admin",
        "password": "password1234"
      }
    }
  }
}