Initialize data plane

POST 
/api/data-plane/init

Initializes a new data plane with the provided details.

Request

application/json

Body

required

datasetsstring[]
dataplaneTypestringrequired
endpointPrefixstringrequired
callbackAddressstringrequired
managementAddressstringrequired
managementTokenstringrequired
catalogSynchronizationstringrequired
rolestringrequired
identifierstring

Responses

200

application/json

Schema

Schema

datasetsstring[]
dataplaneTypestringrequired
endpointPrefixstringrequired
callbackAddressstringrequired
managementAddressstringrequired
managementTokenstringrequired
catalogSynchronizationstringrequired
rolestringrequired
identifierstringrequired

Example (from schema)

{
  "datasets": [
    "string"
  ],
  "dataplaneType": "string",
  "endpointPrefix": "string",
  "callbackAddress": "string",
  "managementAddress": "string",
  "managementToken": "string",
  "catalogSynchronization": "string",
  "role": "string",
  "identifier": "string"
}

400

Invalid data plane details provided

403

Forbidden

application/json

Schema

Schema

namestringrequired
statusstringrequired
codenumberrequired
messageobject
errorstring

Example (from schema)

{
  "name": "string",
  "status": "string",
  "code": 0,
  "message": {},
  "error": "string"
}