Data Sources

---

Test a data source

Test and get information about a data source connection

post

/datasource/test

Authorizations

Body

application/jsonapplication/x-protobuf

dataSourceobject

The data source object specifying configurations for inputs and outputs. Please refer to the dedicated guide for detailed instructions.

listFilesboolean

Responses

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

application/jsonapplication/x-protobuf

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.bytenite.com/v1/customer/datasource/test' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "dataSource": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "listFiles": true
  }'

200

400

401

403

404

500

503

default

200

application/json

application/x-protobuf

application/json

{
  "filename": "text",
  "path": "text",
  "size": "text",
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "tempUrl": "text",
  "files": {
    "name": "text",
    "path": "text",
    "directories": [
      "[Circular Reference]"
    ],
    "files": [
      {
        "id": "text",
        "name": "text",
        "path": "text",
        "size": "text"
      }
    ]
  }
}

A successful response.