All pages
Powered by GitBook
1 of 1

Loading...

Data Sources


Test a data source

post

Test and get information about a data source connection

Authorizations
AuthorizationstringRequired

Your ByteNite access token

Body
listFilesbooleanOptional
post
/datasource/test
Responses
200

A successful response.

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

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

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

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