CREATE OR UPDATE Egress Sink

PATCH 
/workspaces/:workspaceId/egress-sinks/:egressSinkName

Creates new egress sink or updates existing one.

Request

Path Parameters

workspaceId uuidrequired

Name of the workspace.

egressSinkName stringrequired

Name of the egress sink.

Header Parameters

If-None-Match string

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

application/json

Body

properties

object

isEnabled booleannullable

config

object

azureEventHub

object

connectionString stringrequired

azureServiceBus

object

connectionString stringrequired

sql

object

postgreSql

object

required

connectionString stringrequired

grafana

object

otel

object

endpoint urinullable

basicAuth

object

username stringnullable

password stringnullable

delta

object

azureBlobStorage

object

required

connectionString stringnullable

containerName stringnullable

awsS3

object

bucketName stringnullable

region stringnullable

iamUserAccessKey

object

accessKey stringrequired

secretAccessKey stringrequired

Responses

200

Updated egress sink or update is not needed.

application/json

Schema

Schema

name stringrequired
workspaceId 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)

{
  "name": "string",
  "workspaceId": "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"
  }
}

example-1

{
  "name": "example-sink-01",
  "workspaceId": "00000000-0000-0000-0000-000000000001",
  "properties": {
    "config": {
      "azureEventHub": {
        "eventHubName": "example-event-hub",
        "endpoint": "sb://example-event-hub-namespace.servicebus.windows.net",
        "sharedAccessKeyName": "example-key-name"
      }
    },
    "isEnabled": true,
    "protocolVersion": "V2"
  }
}

201

Egress sink was created.

application/json

Schema

Schema

name stringrequired
workspaceId 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)

{
  "name": "string",
  "workspaceId": "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"
  }
}

example-1

{
  "name": "example-sink-01",
  "workspaceId": "00000000-0000-0000-0000-000000000001",
  "properties": {
    "config": {
      "azureEventHub": {
        "eventHubName": "example-event-hub",
        "endpoint": "sb://example-event-hub-namespace.servicebus.windows.net",
        "sharedAccessKeyName": "example-key-name"
      }
    },
    "isEnabled": true,
    "protocolVersion": "V2"
  }
}

404

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...