Data Sources

---

Test a data source

post

Test and get information about a data source connection

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Your ByteNite access token

Body

application/jsonapplication/x-protobuf

listFilesbooleanOptional

Responses

200

A successful response.

application/jsonapplication/x-protobuf

400

Returned when the users sends a malformed request.

application/jsonapplication/x-protobuf

401

Returned when the user is not authenticated.

application/jsonapplication/x-protobuf

403

Returned when the user does not have permission to access the resource.

application/jsonapplication/x-protobuf

404

Returned when the resource does not exist.

application/jsonapplication/x-protobuf

500

Returned when an error on the server occurred.

application/jsonapplication/x-protobuf

503

Returned when the resource is temporarily unavailable.

application/jsonapplication/x-protobuf

default

An unexpected error response.

application/jsonapplication/x-protobuf

post

/datasource/test

HTTPcURLJavaScriptPython

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
}

application/jsonapplication/x-protobuf

{
  "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"
      }
    ]
  }
}