GET Egress Route
GEThttps://api.eu1.spotflow.io/workspaces/:workspaceId/stream-groups/:streamGroupName/streams/:streamName/egress-routes/:egressRouteName
GET Egress Route
Request
Path Parameters
workspaceId uuidrequired
streamGroupName stringrequired
streamName stringrequired
egressRouteName stringrequired
Responses
- 200
- 404
- 423
Egress route.
- application/json
- Schema
- Example (auto)
Schema
namestringrequired
workspaceIduuidrequired
streamGroupNamestringrequired
streamNamestringrequired
properties objectrequired
{
"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": {
"binary": {
"contentType": "string"
},
"textLines": {},
"otel": {
"logs": {
"isEnabled": true
},
"metrics": {
"isEnabled": true
},
"traces": {
"isEnabled": true
}
}
}
},
"awsS3": {
"targetPath": {
"isEnabled": true,
"path": "string"
}
}
},
"input": "Messages",
"filter": {
"isEnabled": true,
"condition": "string"
}
}
}
Egress route, stream, stream group or workspace not found.
- application/problem+json
- Schema
- Example (auto)
Schema
typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Workspace is disabled.
- application/problem+json
- Schema
- Example (auto)
Schema
typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
- curl
- python
- nodejs
- csharp
- powershell
- CURL
curl -L 'https://api.eu1.spotflow.io/workspaces/:workspaceId/stream-groups/:streamGroupName/streams/:streamName/egress-routes/:egressRouteName' \
-H 'Accept: application/json'