Start a transfer process

POST 
/api/management/transfers/:processId/start

Start a transfer process

Request

Path Parameters

processId stringrequired

Process ID

application/json

Body

endpointstringrequired
Example: http://data-plane-endpoint
properties object[]required
Array [
namestringrequired
Example: propertyName
valuestringrequired
Example: propertyValue
]

Responses

200

Transfer started successfully

application/json

Schema

Schema

statusstring

Example (auto)

{
  "status": "success"
}

Authorization: oauth2

name: oauth2type: oauth2scopes: controlplane_admin,controlplane_dataplaneflows: {
  "password": {
    "scopes": {
      "controlplane_admin": "controlplane_admin",
      "controlplane_dataplane": "controlplane_dataplane"
    }
  }
}

• curl
• http

• CURL

curl -L 'https://tsg.dataspac.es/api/management/transfers/:processId/start' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "endpoint": "http://data-plane-endpoint",
  "properties": [
    {
      "name": "propertyName",
      "value": "propertyValue"
    }
  ]
}'

Request Collapse all

Auth

Bearer Token

Parameters

processId — pathrequired

Body

{
  "endpoint": "http://data-plane-endpoint",
  "properties": [
    {
      "name": "propertyName",
      "value": "propertyValue"
    }
  ]
}