Data Sources

PreviousOther NextTemplates

Last updated 1 month ago

Was this helpful?

Test a data source

post

Test and get information about a data source connection

Authorizations

Body

dataSourceobjectOptional

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

listFilesbooleanOptional

Responses

objectOptional

post

POST /v1/customer/datasource/test HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "dataSource": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "listFiles": true
}

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