---
title: "List sinks"
method: GET
path: "/api/v1/namespaces/{namespace}/sinks/{name}"
tags: ["Get"]
---

# List sinks

`GET /api/v1/namespaces/{namespace}/sinks/{name}`

## Path parameters

- `namespace` string, required
- `name` string, required

## Response `200`

OK

- V1Sink[]
  - `description` string
  - `logExportRules` V1LogExportRule[]
    - `basicBucket` V1BasicBucket
      - `destination` string — Address to export logs
      - `pathTemplate` string — Path constructed from log metadata for exporting logs
      - `rootPath` string — Deprecated; Root directory to store logs within external storage
      - `shouldEncodeFileName` boolean — Provide an option to convert '+' to '%2B' to address issues in certain web environments where '+' is misinterpreted
      - `timeLayoutOfSubDirectory` string — Deprecated; An option(default `2006-01`) that sets the name of the sub-directory following `{Root path}` to a time-based layout
    - `description` string — Description of this rule
    - `enableLogEntryFormat` boolean — Enable structured messages to include chunk metadata
    - `filter` V1Filter
      - `clusters` string[] — Filter logs only for specific Clusters
      - `containers` string[] — Filter logs only for specific Containers
      - `exclude` string — Filter only logs that do not match the re2 expression(https://github.com/google/re2/wiki/Syntax)
      - `include` string — Filter only logs that match the re2 expression(https://github.com/google/re2/wiki/Syntax)
      - `labels` object[] — Filter logs only for specific Pod labels
      - `namespace` string — Filter logs only for specific Namespace
      - `pods` string[] — Filter logs only for specific Pods
      - `setNames` string[] — Filter logs only for specific ReplicaSets/StatefulSets
      - `sources` V1Source[] — Filter logs only for specific Sources
        - `path` string
        - `type` string
    - `interval` string — Interval to export logs
    - `kafka` V1Kafka
      - `brokers` string[] — Target kafka broker servers to send logs
      - `clientId` string — An identifier to distinguish request; default `lobster`
      - `compression` string — Compression codec specifying the compression type
      - `idempotent` boolean — The producer will ensure that exactly one
      - `key` string — Target key to which logs will be exported (optional)
      - `partition` integer — Target partition to which logs will be exported (optional)
      - `retryBackoff` string — How long to wait for the cluster to settle between retries
      - `retryMax` integer — The total number of times to retry sending a message
      - `sasl` V1SASL
        - `accessToken` string — Deprecated; OAuth access token
        - `clientId` string — Application's ID
        - `clientSecret` string — Application's secret
        - `enable` boolean — Whether or not to use SASL authentication
        - `handshake` boolean — Kafka SASL handshake
        - `mechanism` string — Enabled SASL mechanism
        - `oAuthType` string — Type for reflecting authentication server's specific requirements
        - `password` string — Password for SASL/PLAIN authentication
        - `scopes` string[] — Scopes used to specify permission
        - `tokenUrl` string — TokenURL server endpoint to obtain the access token
        - `user` string — SASL/PLAIN or SASL/SCRAM authentication
        - `version` integer — SASL Protocol Version
      - `tls` V1TLS
        - `caCertificate` string — CA certificate for TLS
        - `enable` boolean — Whether or not to use TLS
        - `insecureSkipVerify` boolean — Whether or not to skip verification of CA certificate in client
      - `topic` string — Target topic to which logs will be exported (required)
    - `name` string — Rule name
    - `s3Bucket` V1S3Bucket
      - `accessKey` string — S3 bucket access key
      - `bucketName` string — S3 bucket name
      - `destination` string — S3 Address to export logs
      - `pathTemplate` string — Path constructed from log metadata for exporting logs
      - `region` string — S3 region
      - `rootPath` string — Deprecated; Root directory to store logs within external storage
      - `secretKey` string — S3 bucket secret key
      - `shouldEncodeFileName` boolean — Provide an option to convert '+' to '%2B' to address issues in certain web environments where '+' is misinterpreted
      - `tags` V1Tags
      - `timeLayoutOfSubDirectory` string — Deprecated; An option(default `2006-01`) that sets the name of the sub-directory following `{Root path}` to a time-based layout
  - `logMetricRules` V1LogMetricRule[]
    - `description` string — Description of this rule
    - `filter` V1Filter
      - `clusters` string[] — Filter logs only for specific Clusters
      - `containers` string[] — Filter logs only for specific Containers
      - `exclude` string — Filter only logs that do not match the re2 expression(https://github.com/google/re2/wiki/Syntax)
      - `include` string — Filter only logs that match the re2 expression(https://github.com/google/re2/wiki/Syntax)
      - `labels` object[] — Filter logs only for specific Pod labels
      - `namespace` string — Filter logs only for specific Namespace
      - `pods` string[] — Filter logs only for specific Pods
      - `setNames` string[] — Filter logs only for specific ReplicaSets/StatefulSets
      - `sources` V1Source[] — Filter logs only for specific Sources
        - `path` string
        - `type` string
    - `name` string — Rule name
  - `name` string
  - `namespace` string
  - `type` string

## Other responses

- `400` — Invalid parameters
- `405` — Method not allowed
- `500` — Failed to get sink

## Changes

- **2024-11-21** `1eabd0624e0d` — 1 breaking, 1 warning
  - the `path` request parameter `name` became required
  - deleted the `query` request parameter `type`
- **2024-10-07** `2f68e28eb589` — 2 info
  - added the new optional `query` request parameter `type`
  - the `path` request parameter `name` became optional

[Change history](https://skmtc.dev/naver/apis/lobster-operator-apis-document/changes/api/v1/namespaces/:namespace/sinks/:name/get.md)

---

[API](https://skmtc.dev/naver/apis/lobster-operator-apis-document.md) · [All operations](https://skmtc.dev/naver/apis/lobster-operator-apis-document/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/naver/lobster-operator-apis-document/revisions/db3acd93389c/schema)