CREATE OR UPDATE Egress Route for Stream

PATCH 
/workspaces/:workspaceId/stream-groups/:streamGroupName/streams/:streamName/egress-routes/:egressRouteName

CREATE OR UPDATE Egress Route for Stream

Request

Path Parameters

workspaceId uuidrequired
streamGroupName stringrequired
streamName stringrequired
egressRouteName stringrequired

Header Parameters

If-None-Match string

To ensure that no existing egress route is updated pass If-None-Match header set to "*".

application/json

Body

properties

object

isEnabled booleannullable

egressSinkName stringnullable

config

object

azureEventHub

object

disablePayloadEmbedding booleannullable

forceExternalizedPayload booleannullabledeprecated

partitionKeyPattern

object

isEnabled booleanrequired

pattern stringnullable

azureServiceBus

object

disablePayloadEmbedding booleannullable

sql

object

egressMapping

otel

object

applyResourceLabels

object

logs

object

deviceId booleannullable

siteId booleannullable

streamGroupName booleannullable

streamName booleannullable

metrics

object

deviceId booleannullable

siteId booleannullable

streamGroupName booleannullable

streamName booleannullable

traces

object

deviceId booleannullable

siteId booleannullable

streamGroupName booleannullable

streamName booleannullable

delta

object

directoryPath stringnullable

schema

object

textLines

object

otel

object

logs

object

isEnabled booleannullable

metrics

object

isEnabled booleannullable

traces

object

isEnabled booleannullable

awsS3

object

targetPath

object

isEnabled booleanrequired

path stringnullable

input int32

Possible values: [Messages, BatchCompletions]

Responses

200

Updated egress route point.

application/json

Schema

Schema

name stringrequired
workspaceId uuidrequired
streamGroupName stringrequired
streamName stringrequired

properties

object

required

isEnabled booleanrequired

egressSinkName stringrequired

config

object

required

azureEventHub

object

disablePayloadEmbedding boolean

partitionKeyPattern

object

required

isEnabled booleanrequired

pattern stringnullable

forceExternalizedPayload booleandeprecated

azureServiceBus

object

disablePayloadEmbedding booleanrequired

sql

object

egressMapping required

grafana

object

otel

object

applyResourceLabels

object

logs

object

deviceId boolean

siteId boolean

streamGroupName boolean

streamName boolean

metrics

object

deviceId boolean

siteId boolean

streamGroupName boolean

streamName boolean

traces

object

deviceId boolean

siteId boolean

streamGroupName boolean

streamName boolean

delta

object

directoryPath stringrequired

schema

object

required

textLines

object

otel

object

logs

object

required

isEnabled booleanrequired

metrics

object

required

isEnabled booleanrequired

traces

object

required

isEnabled booleanrequired

awsS3

object

targetPath

object

required

isEnabled booleanrequired

path stringnullable

input int32required

Possible values: [Messages, BatchCompletions]

Example (from schema)

{
  "name": "string",
  "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "streamGroupName": "string",
  "streamName": "string",
  "properties": {
    "isEnabled": true,
    "egressSinkName": "string",
    "config": {
      "azureEventHub": {
        "disablePayloadEmbedding": true,
        "partitionKeyPattern": {
          "isEnabled": true,
          "pattern": "string"
        }
      },
      "azureServiceBus": {
        "disablePayloadEmbedding": true
      },
      "sql": {
        "egressMapping": {}
      },
      "grafana": {},
      "otel": {
        "applyResourceLabels": {
          "logs": {
            "deviceId": true,
            "siteId": true,
            "streamGroupName": true,
            "streamName": true
          },
          "metrics": {
            "deviceId": true,
            "siteId": true,
            "streamGroupName": true,
            "streamName": true
          },
          "traces": {
            "deviceId": true,
            "siteId": true,
            "streamGroupName": true,
            "streamName": true
          }
        }
      },
      "delta": {
        "directoryPath": "string",
        "schema": {
          "textLines": {},
          "otel": {
            "logs": {
              "isEnabled": true
            },
            "metrics": {
              "isEnabled": true
            },
            "traces": {
              "isEnabled": true
            }
          }
        }
      },
      "awsS3": {
        "targetPath": {
          "isEnabled": true,
          "path": "string"
        }
      }
    },
    "input": "Messages"
  }
}

201

Created egress route .

Response Headers

• Location

  string

  Endpoint URL of the created object.

application/json

Schema

Schema

name stringrequired
workspaceId uuidrequired
streamGroupName stringrequired
streamName stringrequired

properties

object

required

isEnabled booleanrequired

egressSinkName stringrequired

config

object

required

azureEventHub

object

disablePayloadEmbedding boolean

partitionKeyPattern

object

required

isEnabled booleanrequired

pattern stringnullable

forceExternalizedPayload booleandeprecated

azureServiceBus

object

disablePayloadEmbedding booleanrequired

sql

object

egressMapping required

grafana

object

otel

object

applyResourceLabels

object

logs

object

deviceId boolean

siteId boolean

streamGroupName boolean

streamName boolean

metrics

object

deviceId boolean

siteId boolean

streamGroupName boolean

streamName boolean

traces

object

deviceId boolean

siteId boolean

streamGroupName boolean

streamName boolean

delta

object

directoryPath stringrequired

schema

object

required

textLines

object

otel

object

logs

object

required

isEnabled booleanrequired

metrics

object

required

isEnabled booleanrequired

traces

object

required

isEnabled booleanrequired

awsS3

object

targetPath

object

required

isEnabled booleanrequired

path stringnullable

input int32required

Possible values: [Messages, BatchCompletions]

Example (from schema)

{
  "name": "string",
  "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "streamGroupName": "string",
  "streamName": "string",
  "properties": {
    "isEnabled": true,
    "egressSinkName": "string",
    "config": {
      "azureEventHub": {
        "disablePayloadEmbedding": true,
        "partitionKeyPattern": {
          "isEnabled": true,
          "pattern": "string"
        }
      },
      "azureServiceBus": {
        "disablePayloadEmbedding": true
      },
      "sql": {
        "egressMapping": {}
      },
      "grafana": {},
      "otel": {
        "applyResourceLabels": {
          "logs": {
            "deviceId": true,
            "siteId": true,
            "streamGroupName": true,
            "streamName": true
          },
          "metrics": {
            "deviceId": true,
            "siteId": true,
            "streamGroupName": true,
            "streamName": true
          },
          "traces": {
            "deviceId": true,
            "siteId": true,
            "streamGroupName": true,
            "streamName": true
          }
        }
      },
      "delta": {
        "directoryPath": "string",
        "schema": {
          "textLines": {},
          "otel": {
            "logs": {
              "isEnabled": true
            },
            "metrics": {
              "isEnabled": true
            },
            "traces": {
              "isEnabled": true
            }
          }
        }
      },
      "awsS3": {
        "targetPath": {
          "isEnabled": true,
          "path": "string"
        }
      }
    },
    "input": "Messages"
  }
}

404

Stream, stream group, workspace not found.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

423

Workspace is disabled.

application/problem+json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...