GET Latest Workspace Snapshot

GET 
/workspaces/:workspaceId/data-flows-snapshots/latest

GET Latest Workspace Snapshot

Request

Path Parameters

workspaceId uuidrequired

Responses

200

Snapshot of the workspace.

application/json

Schema

Schema

workspaceId uuidrequired
version int64required

properties

object

storage

object

required

blobServiceUri urirequired

storageAccountName stringrequired

defaultStreamGroup

object

required

isEnabled booleanrequired

streamGroupName stringnullable

streamGroups

object[]

required

Array [

name stringrequired

id uuidrequired

properties

object

required

storage

object

required

isWorkspaceStorage booleanrequired

custom

object

blobServiceUri urirequired

storageAccountName stringrequired

defaultStream

object

required

isEnabled booleanrequired

streamName stringnullable

streams

object[]

required

Array [

name stringrequired

id uuidrequired

properties

object

required

concatenationMode int32required

Possible values: [None, WithNewLines, WithoutNewLines]

batchCompletionTimeout

object

required

isEnabled booleanrequired

timeout [d.]hh:mm:ss[.fffffff]nullable

batchIdAutoFillPattern

object

required

isEnabled booleanrequired

pattern stringnullable

messageIdAutoFillPattern

object

required

isEnabled booleanrequired

pattern stringnullable

egressRoutes

object[]

required

Array [

name stringrequired

id uuidrequired

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]

]

]

]

egressSinks

object[]

required

Array [

name stringrequired

id uuidrequired

properties

object

required

isEnabled booleanrequired

config

object

required

azureEventHub

object

endpoint stringrequired

eventHubName stringrequired

sharedAccessKeyName stringrequired

azureServiceBus

object

endpoint stringrequired

entityName stringrequired

sharedAccessKeyName stringrequired

sql

object

postgreSql

object

required

host stringrequired

port stringrequired

database stringrequired

username stringrequired

grafana

object

otel

object

endpoint urirequired

basicAuth

object

required

username stringrequired

delta

object

azureBlobStorage

object

required

blobServiceUri urirequired

storageAccountName stringrequired

containerName stringrequired

awsS3

object

bucketName stringrequired

region stringrequired

iamUserAccessKey

object

required

accessKey stringrequired

protocolVersion int32required

Possible values: [V1, V2, Mixed]

]

Example (from schema)

{
  "workspaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "version": 0,
  "properties": {
    "storage": {
      "blobServiceUri": "string",
      "storageAccountName": "string"
    },
    "defaultStreamGroup": {
      "isEnabled": true,
      "streamGroupName": "string"
    }
  },
  "streamGroups": [
    {
      "name": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "properties": {
        "storage": {
          "isWorkspaceStorage": true,
          "custom": {
            "blobServiceUri": "string",
            "storageAccountName": "string"
          }
        },
        "defaultStream": {
          "isEnabled": true,
          "streamName": "string"
        }
      },
      "streams": [
        {
          "name": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "properties": {
            "concatenationMode": "None",
            "batchCompletionTimeout": {
              "isEnabled": true,
              "timeout": "1.12:34:00"
            },
            "batchIdAutoFillPattern": {
              "isEnabled": true,
              "pattern": "string"
            },
            "messageIdAutoFillPattern": {
              "isEnabled": true,
              "pattern": "string"
            }
          },
          "egressRoutes": [
            {
              "name": "string",
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "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"
              }
            }
          ]
        }
      ]
    }
  ],
  "egressSinks": [
    {
      "name": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "properties": {
        "isEnabled": true,
        "config": {
          "azureEventHub": {
            "endpoint": "string",
            "eventHubName": "string",
            "sharedAccessKeyName": "string"
          },
          "azureServiceBus": {
            "endpoint": "string",
            "entityName": "string",
            "sharedAccessKeyName": "string"
          },
          "sql": {
            "postgreSql": {
              "host": "string",
              "port": "string",
              "database": "string",
              "username": "string"
            }
          },
          "grafana": {},
          "otel": {
            "endpoint": "string",
            "basicAuth": {
              "username": "string"
            }
          },
          "delta": {
            "azureBlobStorage": {
              "blobServiceUri": "string",
              "storageAccountName": "string",
              "containerName": "string"
            }
          },
          "awsS3": {
            "bucketName": "string",
            "region": "string",
            "iamUserAccessKey": {
              "accessKey": "string"
            }
          }
        },
        "protocolVersion": "V1"
      }
    }
  ]
}

Loading...