Preview Storage Structure

Use this endpoint to preview the structure/hierarchy of storage to which this credential grants access. For example, you can use this endpoint to see the folder and file structure of a file storage system or the table-column structure of a database. This can be used to inspect the directory hierarchy of file content storage or the database schema of a database/warehouse storage system. Note that this endpoint is only valid for credentials for storage systems wherein a storage structure needs to be reviewed.

post/data_credentials/{credential_id}/probe/tree

Request

Base URL
https://dataops.nexla.io/nexla-api
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nexla/apis/nexla-rest-api/docs/data_credentials/:credential_id/probe/tree/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

credential_idinteger required

The unique ID of the credential being used.

Query parameters

asyncboolean

If set to 'true', request will be executed in a deferred way, and results will be provided later.

request_idinteger

The unique ID of the asynchronous request. In case it's provided, returns info about the deferred request.

Request body

Response

Changes

No recorded changes to this operation across all 1 revision of this API.