Patch audit log sink

Partially updates an audit log sink. Fields not included in the payload retain their existing values.

Required permission

Account > Admin > AuditLogSinks > Update

Path parameters

sinkId
string required
ID of the audit log sink

Request body

{object}
Patch an audit log sink

description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
sinkData
{object}
AWS S3 sinkData (PATCH variant — all fields optional).

endpoint
string
region
string
bucket
string
pathPrefix
string
compression
string
one of
gzip, none
auth
{object}

accessKeyId
string
secretAccessKey
string

includeSpec
boolean

Response body

{object}
Response object.

data
{object} required
Result data.

id
string required
Identifier for the audit log sink.
name
string required
Name of the audit log sink.
description
string
Description of the audit log sink.
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
sinkType
string required
The type of the audit log sink.
one of
aws_s3
includeSpec
boolean required
Whether exported events include the enriched `before`/`after` spec or only headers.
status
string required
Current status of the audit log sink.
one of
paused, running, failing, creating
createdAt
string required
Timestamp of when the audit log sink was created.
updatedAt
string required
Timestamp of when the audit log sink was last updated.
sinkData
{object} required
Configuration of the destination. Secrets are omitted.

endpoint
string required
region
string required
bucket
string required
pathPrefix
string
compression
string required
one of
gzip, none
auth
{object} required
Authentication object (secret omitted).

accessKeyId
string required

API

CLI

JS Client

PATCH /v1/integrations/audit-log-sinks/{sinkId}

PATCH /v1/teams/{teamId}/integrations/audit-log-sinks/{sinkId}

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request PATCH \
  --data '{}' \
  https://api.northflank.com/v1/integrations/audit-log-sinks/{sinkId}

Example response

200 OK

Details about the updated sink.

JSON

{
  "data": {
    "id": "compliance-bucket",
    "name": "compliance-bucket",
    "description": "Forwards audit logs to the compliance S3 bucket.",
    "sinkType": "aws_s3",
    "includeSpec": false,
    "createdAt": "2026-05-11T12:00:00.000Z",
    "updatedAt": "2026-05-11T12:00:00.000Z"
  }
}