CDN and DNS (v2.1)

Create LogForwarder

Creates a new LogForwarder object in the specified workspace with the provided configuration.

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

Path parameters

workspaceUUIDstring required

UUID of the workspace

Request body

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

Version identifier of the API schema

kind'LogForwarder' required

The string value 'LogForwarder' that identifies the schema

Example request

{
  "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"
  }
}

Response

The logForwarder was successfully created and is being provisioned. The response contains the complete logForwarder details including the assigned unique identifier.

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

Version identifier of the API schema

kind'LogForwarder' required

The string value 'LogForwarder' that identifies the schema

Example response

{
  "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"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.