Integrations /
Update log sink
Required permission
Account > Sinks > General > Update
Path parameters
logSinkId
string requiredID of the log sink
Request body
- {object}
restricted
booleanIf
true
, only logs from the projects inprojects
will be sent to the log sink.projects
[array]If
restricted
istrue
, only logs from these projects will be sent to the log sink.- string
The ID of a project.
pattern^[A-Za-z0-9-]+$ options
{object}useCustomLabels
booleanIf
true
, we will do additional parsing on your JSON formatted log lines and your extract custom labelsforwardCdnLogs
booleanForward CDN logs from your workloads
forwardIngressLogs
booleanForward ingress logs from your workloads
forwardMeshLogs
booleanForward mesh logs from your workloads
sinkData
(multiple options: oneOf)Data about the log sink.
- {object}
Loki Sink Schema.
endpoint
stringThe endpoint of the Loki log sink.
auth
{object}Object containing authentication data for the log sink.
strategy
stringThe authentication method.
one ofbasicuser
stringThe username for the log sink.
password
stringThe password for the log sink.
- {object}
Datadog Sink Schema.
default_api_key
stringThe Datadog API key.
region
stringThe Datadog region.
one ofeu, us, us3, us5- (multiple options: oneOf)
Papertrail Sink Schema.
- {object}
Authenticate with a host/port
authenticationStrategy
string requiredThe authentication strategy.
one ofporthost
string requiredThe host for the Papertrail log destination.
port
number requiredThe port for the Papertrail log destination.
- {object}
Authenticate with a token.
authenticationStrategy
string requiredThe authentication strategy.
one oftokenuri
string requiredThe uri for the Papertrail log destination.
token
string requiredThe HTTP Token for the Papertrail log destination.
- {object}
HTTP Sink Schema.
uri
string requiredUri to send logs to.
encoding
{object}Encoding options
codec
string requiredCodec to encode logs in
one oftext, jsonauth
(multiple options: oneOf) required- (multiple options: oneOf)
- {object}
No authentication strategy
strategy
string requiredNo authentication strategy
one ofnone- {object}
Authenticate with a basic http strategy.
strategy
string requiredBasic HTTP authentication strategy.
one ofbasicuser
stringUsername for basic http authentication.
password
string requiredPassword for basic http authentication.
- {object}
Authenticate with a bearer token strategy.
strategy
string requiredBearer token authentication strategy.
one ofbearertoken
stringToken for bearer token authentication.
- {object}
AWS S3 or compatible API Sink Schema.
endpoint
string requiredEndpoint for the AWS S3 or compatible API bucket.
region
string requiredRegion of the S3 bucket.
one ofeu-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-east2auth
{object}Authentication object.
accessKeyId
string requiredAccess key id for the bucket.
secretAccessKey
string requiredSecret access key for the bucket.
bucket
string requiredName of the S3 Bucket.
compression
string requiredLog file compression method.
one ofgzip, none- {object}
Better Stack (Previously Logtail) Sink Schema.
token
string requiredBetter Stack Source Token
- {object}
LogDNA Sink Schema.
api_key
string requiredIngestion Key
- {object}
Honeycomb Sink Schema.
api_key
string requiredHoneycomb API Key
dataset
string requiredName of the dataset
- {object}
dataset
string requiredName of the data
token
string requiredAxiom API/Personal token
tokenType
string requiredUsing a personal token
one ofpersonal, apiorgId
stringThe ID of the organisation, required if using a personal token
url
string requiredThe Axiom url to use. Only change if self hosting axiom.
resumeLogSink
booleanIf
true
, and the log sink is currently paused, the log sink will be resumed after updating.
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
Response body
- {object}
Response object.
data
{object} requiredResult data.
POST /v1/integrations/log-sinks/{logSinkId}/settings
Example request
curl --header "Content-Type: application/json" \
--header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
--request POST \
--data '{"restricted":true,"projects":["default-project"],"options":{"useCustomLabels":true,"forwardCdnLogs":true,"forwardIngressLogs":true,"forwardMeshLogs":true},"sinkData":{"endpoint":"https://logs.example.com","auth":{"strategy":"basic","user":"admin","password":"password1234"}},"resumeLogSink":false}' \
https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settings
Example response
200 OK
JSON
{
"data": {}
}