GET Egress Sink Secret

GET 
/workspaces/:workspaceId/egress-sinks/:egressSinkName/secrets

Get secrets for existing egress sink.

Request

Path Parameters

workspaceId uuidrequired

Name of the workspace.

egressSinkName stringrequired

Name of the egress sink.

Responses

200

Egress sink secret.

application/json

Schema

Schema

azureEventHub

object

connectionString stringrequired

azureServiceBus

object

connectionString stringrequired

sql

object

postgreSql

object

required

connectionString stringrequired

otel

object

basicAuth

object

required

password stringrequired

delta

object

azureBlobStorage

object

required

connectionString stringrequired

awsS3

object

iamUserAccessKey

object

required

secretAccessKey stringrequired

Example (from schema)

{
  "azureEventHub": {
    "connectionString": "string"
  },
  "azureServiceBus": {
    "connectionString": "string"
  },
  "sql": {
    "postgreSql": {
      "connectionString": "string"
    }
  },
  "otel": {
    "basicAuth": {
      "password": "string"
    }
  },
  "delta": {
    "azureBlobStorage": {
      "connectionString": "string"
    }
  },
  "awsS3": {
    "iamUserAccessKey": {
      "secretAccessKey": "string"
    }
  }
}

example-1

{
  "azureEventHub": {
    "connectionString": "Endpoint=sb://example-event-hub-namespace.servicebus.windows.net/;SharedAccessKeyName=example-key-name;SharedAccessKey={key};EntityPath=example-event-hub"
  }
}

404

Egress sink or 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...