SOsotoon
CDN and DNS (v2.1)

List LogForwarders

Retrieves a paginated list of all LogForwarder objects in the specified workspace. The response includes details about each LogForwarder such as its configuration, status, and metadata. Results can be filtered using query parameters.

get/delivery/v2.1/global/workspaces/{workspaceUUID}/logforwarders

Request

  • Base URL
    https://api.sotoon.ir (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

workspaceUUIDstring required

UUID of the workspace

Response

Successfully retrieved the list of LogForwarder objects. The response includes basic LogForwarder information like name, creation time, and status.

apiVersion'delivery/v2' | 'delivery/v2.1' required

Version identifier of the API schema

kind'LogForwarderList' required

The string value 'LogForwarderList' that identifies the schema

Example response

{
  "apiVersion": "delivery/v2",
  "items": [
    {
      "apiVersion": "delivery/v2",
      "kind": "LogForwarder",
      "metadata": {
        "uid": "00000000-0000-0000-0000-000000000000"
      },
      "spec": {
        "encryption": {
          "key": "your-strong-secret-key",
          "mode": "AES-128-CFB"
        },
        "sink": {
          "amqp": {
            "address": "amqp://username:password@hostname:5672",
            "exchange": "exchange-name",
            "host": "hostname",
            "name": "queue-name",
            "password": "password",
            "scheme": "amqp",
            "username": "username"
          },
          "elastic": {
            "index": "index-name",
            "password": "password",
            "username": "username"
          },
          "kafka": {
            "topic": "topic-name"
          },
          "kind": "Kafka",
          "loki": {
            "compression": "none",
            "endpoint": "http://localhost:3100",
            "password": "password",
            "path": "/loki/api/v1/push",
            "tenant_id": "fake",
            "username": "username"
          },
          "websocket": {
            "address": "wss://hostname:port/uri&token=secret",
            "headers": [
              {
                "name": "Origin",
                "value": "domain.ir"
              }
            ]
          }
        }
      },
      "status": {
        "buffer": "100"
      }
    }
  ],
  "kind": "LogForwarderList"
}

Changes

No recorded changes to this operation across all 6 revisions of this API.