Skip to main content
Version: Next

DataPlaneDetailsDto

dataplaneTypestringrequired
Example: exampleType
titlestringrequired
Example: Dataplane Titel
endpointPrefixstringrequired
Example: /api/v1/dataplane
callbackAddressstringrequired
Example: http://localhost/callback
managementAddressstringrequired

Base management/signaling address the control plane sends data plane signaling (dataflows/*) to.

Example: http://localhost/manage
catalogSynchronizationstringrequired

Possible values: [push, pull, none]

Example: push
rolestringrequired

Possible values: [consumer, provider, both]

Example: consumer
profilesstring[]

Transfer profiles this data plane can execute, advertised at registration and used by the control plane to select a data plane for a transfer.

Example: ["tsg:http-PULL"]
idstringrequired
Example: dp-12345
DataPlaneDetailsDto
{
"dataplaneType": "exampleType",
"title": "Dataplane Titel",
"endpointPrefix": "/api/v1/dataplane",
"callbackAddress": "http://localhost/callback",
"managementAddress": "http://localhost/manage",
"catalogSynchronization": "push",
"role": "consumer",
"profiles": [
"tsg:http-PULL"
],
"id": "dp-12345"
}