v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Integrations /

Update log sink

Updates the settings for a log sink.

Required permission

Account > Sinks > General > Update

Path parameters

    • logSinkId

      string required
      ID of the log sink

Request body

  • {object}
    Update a log sink using Loki

    • restricted

      boolean
      If `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.
      • string
        The ID of a project.
        pattern
        ^[A-Za-z0-9-]+$

    • 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

    • resumeLogSink

      boolean
      If `true`, and the log sink is currently paused, the log sink will be resumed after updating.

    • sinkType

      string required
      The type of log sink to target
      one of
      loki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, axiom, newRelic

    • sinkData

      {object} required
      Details about the Loki log sink.

      • endpoint

        string
        The endpoint of the Loki log sink.

      • auth

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

        • strategy

          string
          The authentication method.
          one of
          basic

        • user

          string
          The username for the log sink.

        • password

          string
          The password for the log sink.
OR
  • {object}
    Update a log sink using Datadog

    • restricted

      boolean
      If `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.
      • string
        The ID of a project.
        pattern
        ^[A-Za-z0-9-]+$

    • 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

    • resumeLogSink

      boolean
      If `true`, and the log sink is currently paused, the log sink will be resumed after updating.

    • sinkType

      string required
      The type of log sink to target
      one of
      loki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, axiom, newRelic

    • sinkData

      {object} required
      Details about the Datadog log sink.

      • default_api_key

        string
        The Datadog API key.

      • region

        string
        The Datadog region.
        one of
        eu, us, us3, us5
OR
  • {object}
    Update a log sink using Papertrail

    • restricted

      boolean
      If `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.
      • string
        The ID of a project.
        pattern
        ^[A-Za-z0-9-]+$

    • 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

    • resumeLogSink

      boolean
      If `true`, and the log sink is currently paused, the log sink will be resumed after updating.

    • sinkType

      string required
      The type of log sink to target
      one of
      loki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, axiom, newRelic

    • sinkData

      (multiple options: oneOf) required
      Papertrail Sink Schema.
      • {object}
        Authenticate with a host/port

        • authenticationStrategy

          string
          The authentication strategy.
          one of
          port

        • host

          string
          The host for the Papertrail log destination.

        • port

          number
          The port for the Papertrail log destination.

        OR

      • {object}
        Authenticate with a token.

        • authenticationStrategy

          string
          The authentication strategy.
          one of
          token

        • uri

          string
          The uri for the Papertrail log destination.

        • token

          string
          The HTTP Token for the Papertrail log destination.
OR
  • {object}
    Update a log sink using HTTP

    • restricted

      boolean
      If `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.
      • string
        The ID of a project.
        pattern
        ^[A-Za-z0-9-]+$

    • 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

    • resumeLogSink

      boolean
      If `true`, and the log sink is currently paused, the log sink will be resumed after updating.

    • sinkType

      string required
      The type of log sink to target
      one of
      loki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, axiom, newRelic

    • sinkData

      {object} required
      Details about the HTTP log sink.

      • uri

        string required
        Uri to send logs to.

      • encoding

        {object} required
        Encoding options

        • codec

          string
          Codec to encode logs in
          one of
          text, json

      • batch

        {object}

        • maxEvents

          number
          The max number of events in a batch before sending

        • maxBytes

          number
          The max size of a batch in bytes before sending

      • auth

        (multiple options: oneOf) required
        Auth information.
        • {object}
          No authentication strategy

          • strategy

            string
            No authentication strategy
            one of
            none

          OR

        • {object}
          Authenticate with a basic http strategy.

          • strategy

            string
            Basic HTTP authentication strategy.
            one of
            basic

          • user

            string
            Username for basic http authentication.

          • password

            string
            Password for basic http authentication.

          OR

        • {object}
          Authenticate with a bearer token strategy.

          • strategy

            string
            Bearer token authentication strategy.
            one of
            bearer

          • token

            string
            Token for bearer token authentication.

      • framing

        {object}

        • method

          string
          one of
          none, newline, character, length
OR
  • {object}
    Update a log sink using AWS S3

    • restricted

      boolean
      If `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.
      • string
        The ID of a project.
        pattern
        ^[A-Za-z0-9-]+$

    • 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

    • resumeLogSink

      boolean
      If `true`, and the log sink is currently paused, the log sink will be resumed after updating.

    • sinkType

      string required
      The type of log sink to target
      one of
      loki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, axiom, newRelic

    • sinkData

      {object} required
      Details about the AWS S3 log sink.

      • endpoint

        string
        Endpoint for the AWS S3 or compatible API bucket.

      • region

        string
        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
          Access key id for the bucket.

        • secretAccessKey

          string
          Secret access key for the bucket.

      • bucket

        string
        Name of the S3 Bucket.

      • compression

        string
        Log file compression method.
        one of
        gzip, none
OR
  • {object}
    Update a log sink using Better Stack

    • restricted

      boolean
      If `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.
      • string
        The ID of a project.
        pattern
        ^[A-Za-z0-9-]+$

    • 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

    • resumeLogSink

      boolean
      If `true`, and the log sink is currently paused, the log sink will be resumed after updating.

    • sinkType

      string required
      The type of log sink to target
      one of
      loki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, axiom, newRelic

    • sinkData

      {object} required
      Details about the Better Stack log sink.

      • token

        string
        Better Stack Source Token

      • uri

        string
        Better stack ingestion host
OR
  • {object}
    Update a log sink using LogDNA

    • restricted

      boolean
      If `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.
      • string
        The ID of a project.
        pattern
        ^[A-Za-z0-9-]+$

    • 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

    • resumeLogSink

      boolean
      If `true`, and the log sink is currently paused, the log sink will be resumed after updating.

    • sinkType

      string required
      The type of log sink to target
      one of
      loki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, axiom, newRelic

    • sinkData

      {object} required
      Details about the LogDNA log sink.

      • api_key

        string
        Ingestion Key
OR
  • {object}
    Update a log sink using Logz.io

    • restricted

      boolean
      If `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.
      • string
        The ID of a project.
        pattern
        ^[A-Za-z0-9-]+$

    • 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

    • resumeLogSink

      boolean
      If `true`, and the log sink is currently paused, the log sink will be resumed after updating.

    • sinkType

      string required
      The type of log sink to target
      one of
      loki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, axiom, newRelic

    • sinkData

      {object} required
      Details about the Logz.io log sink.

      • region

        string
        Your Logzio region code
        one of
        eu, uk, us, ca, au, nl, wa

      • token

        string
        The Log Shipping Token of the account you want to ship to
OR
  • {object}
    Update a log sink using Honeycomb

    • restricted

      boolean
      If `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.
      • string
        The ID of a project.
        pattern
        ^[A-Za-z0-9-]+$

    • 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

    • resumeLogSink

      boolean
      If `true`, and the log sink is currently paused, the log sink will be resumed after updating.

    • sinkType

      string required
      The type of log sink to target
      one of
      loki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, axiom, newRelic

    • sinkData

      {object} required
      Details about the Honeycomb log sink.

      • api_key

        string
        Honeycomb API Key

      • dataset

        string
        Name of the dataset
OR
  • {object}
    Update a log sink using Axiom

    • restricted

      boolean
      If `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.
      • string
        The ID of a project.
        pattern
        ^[A-Za-z0-9-]+$

    • 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

    • resumeLogSink

      boolean
      If `true`, and the log sink is currently paused, the log sink will be resumed after updating.

    • sinkType

      string required
      The type of log sink to target
      one of
      loki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, axiom, newRelic

    • sinkData

      {object} required
      Details about the Axiom log sink.

      • dataset

        string required
        Name of the data

      • token

        string
        Axiom API/Personal token

      • tokenType

        string
        Using a personal token
        one of
        personal, api

      • orgId

        string
        The ID of the organisation, required if using a personal token

      • url

        string
        The Axiom url to use. Only change if self hosting axiom.
OR
  • {object}
    Update a log sink using New Relic

    • restricted

      boolean
      If `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.
      • string
        The ID of a project.
        pattern
        ^[A-Za-z0-9-]+$

    • 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

    • resumeLogSink

      boolean
      If `true`, and the log sink is currently paused, the log sink will be resumed after updating.

    • sinkType

      string required
      The type of log sink to target
      one of
      loki, datadog_logs, papertrail, http, aws_s3, logdna, coralogix, betterStack, honeycomb, logzio, axiom, newRelic

    • sinkData

      {object} required
      Details about the New Relic log sink.

      • accountId

        string
        New Relic Account ID

      • licenseKey

        string
        New Relic License Key

      • region

        string
        one of
        eu, us

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.
    API
    CLI
    JS Client

    POST /v1/integrations/log-sinks/{logSinkId}/settings

    Example request

    Request body
    Update a log sink using Loki
    curl
    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}/settings
    OR
    Update a log sink using Datadog
    curl
    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":{"default_api_key":"abcdef12345678900000000000000000","region":"eu"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settings
    OR
    Update a log sink using Papertrail
    curl
    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":{"authenticationStrategy":"port","host":"logs1.papertrailapp.com:","port":8000}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settings
    OR
    Update a log sink using HTTP
    curl
    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":{"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}/settings
    OR
    Update a log sink using AWS S3
    curl
    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":"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}/settings
    OR
    Update a log sink using Better Stack
    curl
    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":{"token":"vhnqrLygVQ5GnSQUTZamKvAq","uri":"abc123.eu-nbg-2.betterstackdata.com"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settings
    OR
    Update a log sink using LogDNA
    curl
    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":{"api_key":"b1dd3feb585asd1a3e9edpo9kmn5e590hg9"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settings
    OR
    Update a log sink using Logz.io
    curl
    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":{"region":"eu","token":"sNFijNFgNFoNFrMsNFbNFObNFcgNFqoa"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settings
    OR
    Update a log sink using Honeycomb
    curl
    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":{"api_key":"b1dd3feb585asd1a3e9","dataset":"staging-logs"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settings
    OR
    Update a log sink using Axiom
    curl
    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":{"dataset":"staging","token":"b1dd3feb585asd1a3e9edpo9kmn5e590hg9","tokenType":"api"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settings
    OR
    Update a log sink using New Relic
    curl
    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":{"accountId":"b1dd3feb585asd1a3e9","licenseKey":"b1dd3feb585asd1a3e9","region":"eu"}}' \
  https://api.northflank.com/v1/integrations/log-sinks/{logSinkId}/settings

    Example response

    200 OK

    The operation was performed successfully.

    JSON

    {
  "data": {}
}

    © 2025 Northflank Ltd. All rights reserved.

    northflank.comTermsPrivacyfeedback@northflank.com