Skip to main content
Version: Next

DataPlaneDetailsDto

dataplaneIdstringrequired

Signaling identity of the data plane

endpointstringrequired

Base URL the control plane signals to

profilesstring[]required

Transfer profile URLs this data plane serves

authorizationobject

Private OAuth client credentials for signaling. Omit to use the control plane OAuth client. Never returned by management APIs.

labelsstring[]

Free-form labels used to select a data plane for a dataset

titlestring

Display name

healthEndpointstring

Optional health endpoint. Omit for data planes without health polling.

idstringrequired
sourcestringrequired

Possible values: [api, config]

DataPlaneDetailsDto
{
"dataplaneId": "string",
"endpoint": "string",
"profiles": [
"string"
],
"authorization": {},
"labels": [
"string"
],
"title": "string",
"healthEndpoint": "string",
"id": "string",
"source": "api"
}