Integrations /
Update log sink
Required permission
Account > Sinks > General > Update
Path parameters
- logSinkId string requiredID of the log sink
Request body
- {object}Update a log sink using Loki
- restricted booleanIf `true`, only logs from the projects in `projects` will be sent to the log sink.
- projects [array]If `restricted` is `true`, only logs from these projects will be sent to the log sink.
- stringThe 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 labels
- forwardCdnLogs booleanForward CDN logs from your workloads
- forwardIngressLogs booleanForward ingress logs from your workloads
- forwardMeshLogs booleanForward mesh logs from your workloads
- resumeLogSink booleanIf `true`, and the log sink is currently paused, the log sink will be resumed after updating.
- sinkType string requiredThe type of log sink to targetone ofloki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, solarWinds, axiom, newRelic
- sinkData {object} requiredDetails about the Loki log sink.
- endpoint stringThe endpoint of the Loki log sink.
- auth {object}Object containing authentication data for the log sink.
- strategy stringThe authentication method.one ofbasic
- user stringThe username for the log sink.
- password stringThe password for the log sink.
- {object}Update a log sink using Datadog
- restricted booleanIf `true`, only logs from the projects in `projects` will be sent to the log sink.
- projects [array]If `restricted` is `true`, only logs from these projects will be sent to the log sink.
- stringThe 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 labels
- forwardCdnLogs booleanForward CDN logs from your workloads
- forwardIngressLogs booleanForward ingress logs from your workloads
- forwardMeshLogs booleanForward mesh logs from your workloads
- resumeLogSink booleanIf `true`, and the log sink is currently paused, the log sink will be resumed after updating.
- sinkType string requiredThe type of log sink to targetone ofloki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, solarWinds, axiom, newRelic
- sinkData {object} requiredDetails about the Datadog log sink.
- default_api_key stringThe Datadog API key.
- region stringThe Datadog region.one ofeu, us, us3, us5
- {object}Update a log sink using Papertrail
- restricted booleanIf `true`, only logs from the projects in `projects` will be sent to the log sink.
- projects [array]If `restricted` is `true`, only logs from these projects will be sent to the log sink.
- stringThe 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 labels
- forwardCdnLogs booleanForward CDN logs from your workloads
- forwardIngressLogs booleanForward ingress logs from your workloads
- forwardMeshLogs booleanForward mesh logs from your workloads
- resumeLogSink booleanIf `true`, and the log sink is currently paused, the log sink will be resumed after updating.
- sinkType string requiredThe type of log sink to targetone ofloki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, solarWinds, axiom, newRelic
- sinkData (multiple options: oneOf) requiredPapertrail Sink Schema.
- {object}Authenticate with a host/port
- authenticationStrategy stringThe authentication strategy.one ofport
- host stringThe host for the Papertrail log destination.
- port numberThe port for the Papertrail log destination.
- {object}Authenticate with a token.
- authenticationStrategy stringThe authentication strategy.one oftoken
- uri stringThe uri for the Papertrail log destination.
- token stringThe HTTP Token for the Papertrail log destination.
OR
- {object}Update a log sink using HTTP
- restricted booleanIf `true`, only logs from the projects in `projects` will be sent to the log sink.
- projects [array]If `restricted` is `true`, only logs from these projects will be sent to the log sink.
- stringThe 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 labels
- forwardCdnLogs booleanForward CDN logs from your workloads
- forwardIngressLogs booleanForward ingress logs from your workloads
- forwardMeshLogs booleanForward mesh logs from your workloads
- resumeLogSink booleanIf `true`, and the log sink is currently paused, the log sink will be resumed after updating.
- sinkType string requiredThe type of log sink to targetone ofloki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, solarWinds, axiom, newRelic
- sinkData {object} requiredDetails about the HTTP log sink.
- uri string requiredUri to send logs to.
- encoding {object} requiredEncoding options
- codec stringCodec to encode logs inone oftext, json
- batch {object}
- maxEvents numberThe max number of events in a batch before sending
- maxBytes numberThe max size of a batch in bytes before sending
- auth (multiple options: oneOf) requiredAuth information.
- {object}No authentication strategy
- strategy stringNo authentication strategyone ofnone
- {object}Authenticate with a basic http strategy.
- strategy stringBasic HTTP authentication strategy.one ofbasic
- user stringUsername for basic http authentication.
- password stringPassword for basic http authentication.
- {object}Authenticate with a bearer token strategy.
- strategy stringBearer token authentication strategy.one ofbearer
- token stringToken for bearer token authentication.
- framing {object}
- method stringone ofnone, newline, length
OR
OR
- {object}Update a log sink using AWS S3
- restricted booleanIf `true`, only logs from the projects in `projects` will be sent to the log sink.
- projects [array]If `restricted` is `true`, only logs from these projects will be sent to the log sink.
- stringThe 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 labels
- forwardCdnLogs booleanForward CDN logs from your workloads
- forwardIngressLogs booleanForward ingress logs from your workloads
- forwardMeshLogs booleanForward mesh logs from your workloads
- resumeLogSink booleanIf `true`, and the log sink is currently paused, the log sink will be resumed after updating.
- sinkType string requiredThe type of log sink to targetone ofloki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, solarWinds, axiom, newRelic
- sinkData {object} requiredDetails about the AWS S3 log sink.
- endpoint stringEndpoint for the AWS S3 or compatible API bucket.
- region stringRegion 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-east2
- auth {object}Authentication object.
- accessKeyId stringAccess key id for the bucket.
- secretAccessKey stringSecret access key for the bucket.
- bucket stringName of the S3 Bucket.
- compression stringLog file compression method.one ofgzip, none
- {object}Update a log sink using Better Stack
- restricted booleanIf `true`, only logs from the projects in `projects` will be sent to the log sink.
- projects [array]If `restricted` is `true`, only logs from these projects will be sent to the log sink.
- stringThe 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 labels
- forwardCdnLogs booleanForward CDN logs from your workloads
- forwardIngressLogs booleanForward ingress logs from your workloads
- forwardMeshLogs booleanForward mesh logs from your workloads
- resumeLogSink booleanIf `true`, and the log sink is currently paused, the log sink will be resumed after updating.
- sinkType string requiredThe type of log sink to targetone ofloki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, solarWinds, axiom, newRelic
- sinkData {object} requiredDetails about the Better Stack log sink.
- token stringBetter Stack Source Token
- uri stringBetter stack ingestion host
- {object}Update a log sink using LogDNA
- restricted booleanIf `true`, only logs from the projects in `projects` will be sent to the log sink.
- projects [array]If `restricted` is `true`, only logs from these projects will be sent to the log sink.
- stringThe 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 labels
- forwardCdnLogs booleanForward CDN logs from your workloads
- forwardIngressLogs booleanForward ingress logs from your workloads
- forwardMeshLogs booleanForward mesh logs from your workloads
- resumeLogSink booleanIf `true`, and the log sink is currently paused, the log sink will be resumed after updating.
- sinkType string requiredThe type of log sink to targetone ofloki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, solarWinds, axiom, newRelic
- sinkData {object} requiredDetails about the LogDNA log sink.
- api_key stringIngestion Key
- {object}Update a log sink using Logz.io
- restricted booleanIf `true`, only logs from the projects in `projects` will be sent to the log sink.
- projects [array]If `restricted` is `true`, only logs from these projects will be sent to the log sink.
- stringThe 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 labels
- forwardCdnLogs booleanForward CDN logs from your workloads
- forwardIngressLogs booleanForward ingress logs from your workloads
- forwardMeshLogs booleanForward mesh logs from your workloads
- resumeLogSink booleanIf `true`, and the log sink is currently paused, the log sink will be resumed after updating.
- sinkType string requiredThe type of log sink to targetone ofloki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, solarWinds, axiom, newRelic
- sinkData {object} requiredDetails about the Logz.io log sink.
- region stringYour Logzio region codeone ofeu, uk, us, ca, au, nl, wa
- token stringThe Log Shipping Token of the account you want to ship to
- {object}Update a log sink using Solar Winds
- restricted booleanIf `true`, only logs from the projects in `projects` will be sent to the log sink.
- projects [array]If `restricted` is `true`, only logs from these projects will be sent to the log sink.
- stringThe 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 labels
- forwardCdnLogs booleanForward CDN logs from your workloads
- forwardIngressLogs booleanForward ingress logs from your workloads
- forwardMeshLogs booleanForward mesh logs from your workloads
- resumeLogSink booleanIf `true`, and the log sink is currently paused, the log sink will be resumed after updating.
- sinkType string requiredThe type of log sink to targetone ofloki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, solarWinds, axiom, newRelic
- sinkData {object} requiredDetails about the Solar Winds log sink.
- api_key stringSolar Winds API Key
- encoding {object}
- codec stringCodec to encode logs inone oftext, json
- endpointType stringSolar Winds endpoint typeone ofunitary, bulk
- {object}Update a log sink using Honeycomb
- restricted booleanIf `true`, only logs from the projects in `projects` will be sent to the log sink.
- projects [array]If `restricted` is `true`, only logs from these projects will be sent to the log sink.
- stringThe 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 labels
- forwardCdnLogs booleanForward CDN logs from your workloads
- forwardIngressLogs booleanForward ingress logs from your workloads
- forwardMeshLogs booleanForward mesh logs from your workloads
- resumeLogSink booleanIf `true`, and the log sink is currently paused, the log sink will be resumed after updating.
- sinkType string requiredThe type of log sink to targetone ofloki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, solarWinds, axiom, newRelic
- sinkData {object} requiredDetails about the Honeycomb log sink.
- api_key stringHoneycomb API Key
- dataset stringName of the dataset
- {object}Update a log sink using Axiom
- restricted booleanIf `true`, only logs from the projects in `projects` will be sent to the log sink.
- projects [array]If `restricted` is `true`, only logs from these projects will be sent to the log sink.
- stringThe 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 labels
- forwardCdnLogs booleanForward CDN logs from your workloads
- forwardIngressLogs booleanForward ingress logs from your workloads
- forwardMeshLogs booleanForward mesh logs from your workloads
- resumeLogSink booleanIf `true`, and the log sink is currently paused, the log sink will be resumed after updating.
- sinkType string requiredThe type of log sink to targetone ofloki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, solarWinds, axiom, newRelic
- sinkData {object} requiredDetails about the Axiom log sink.
- dataset string requiredName of the data
- token stringAxiom API/Personal token
- tokenType stringUsing a personal tokenone ofpersonal, api
- orgId stringThe ID of the organisation, required if using a personal token
- url stringThe Axiom url to use. Only change if self hosting axiom.
- {object}Update a log sink using New Relic
- restricted booleanIf `true`, only logs from the projects in `projects` will be sent to the log sink.
- projects [array]If `restricted` is `true`, only logs from these projects will be sent to the log sink.
- stringThe 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 labels
- forwardCdnLogs booleanForward CDN logs from your workloads
- forwardIngressLogs booleanForward ingress logs from your workloads
- forwardMeshLogs booleanForward mesh logs from your workloads
- resumeLogSink booleanIf `true`, and the log sink is currently paused, the log sink will be resumed after updating.
- sinkType string requiredThe type of log sink to targetone ofloki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, solarWinds, axiom, newRelic
- sinkData {object} requiredDetails about the New Relic log sink.
- accountId stringNew Relic Account ID
- licenseKey stringNew Relic License Key
- region stringone ofeu, us
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},"resumeLogSink":false,"sinkType":"http","sinkData":{"endpoint":"https://logs.example.com","auth":{"strategy":"basic","user":"admin","password":"password1234"}}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settingscurl --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},"resumeLogSink":false,"sinkType":"http","sinkData":{"default_api_key":"abcdef12345678900000000000000000","region":"eu"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settingscurl --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},"resumeLogSink":false,"sinkType":"http","sinkData":{"authenticationStrategy":"port","host":"logs1.papertrailapp.com:","port":8000}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settingscurl --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},"resumeLogSink":false,"sinkType":"http","sinkData":{"uri":"my.log-collector.com","encoding":{"codec":"json"},"batch":{"maxEvents":"10","maxBytes":"1e+7"},"auth":{"strategy":"none"}}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settingscurl --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},"resumeLogSink":false,"sinkType":"http","sinkData":{"endpoint":"my.bucket.com","region":"eu-west-2","auth":{"accessKeyId":"PMSACIHNUIASDBWQDS","secretAccessKey":"HA1PLMNOEAEYUHAJQMSDUJQS"},"bucket":"northflank-logs","compression":"gzip"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settingscurl --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},"resumeLogSink":false,"sinkType":"http","sinkData":{"token":"vhnqrLygVQ5GnSQUTZamKvAq","uri":"abc123.eu-nbg-2.betterstackdata.com"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settingscurl --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},"resumeLogSink":false,"sinkType":"http","sinkData":{"api_key":"b1dd3feb585asd1a3e9edpo9kmn5e590hg9"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settingscurl --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},"resumeLogSink":false,"sinkType":"http","sinkData":{"region":"eu","token":"sNFijNFgNFoNFrMsNFbNFObNFcgNFqoa"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settingscurl --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},"resumeLogSink":false,"sinkType":"http","sinkData":{"api_key":"Tr8BIEmYx1fuM3_XRMwU3xXEFnD20p9NFkRIu1COrDqMCM4g86qWZgVdgs1Y7mzWtFMI0Zc","encoding":{"codec":"json"}}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settingscurl --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},"resumeLogSink":false,"sinkType":"http","sinkData":{"api_key":"b1dd3feb585asd1a3e9","dataset":"staging-logs"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settingscurl --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},"resumeLogSink":false,"sinkType":"http","sinkData":{"dataset":"staging","token":"b1dd3feb585asd1a3e9edpo9kmn5e590hg9","tokenType":"api"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settingscurl --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},"resumeLogSink":false,"sinkType":"http","sinkData":{"accountId":"b1dd3feb585asd1a3e9","licenseKey":"b1dd3feb585asd1a3e9","region":"eu"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settingsExample response
200 OK
JSON
{
  "data": {}
}