GetVfsSchema

POST

https://api.cbf.tcn.com/api/v1alpha1/insights/insights/getvfsschema

GetVfsSchema gets schema for a vfs

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "alias_name": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/insights/insights/getvfsschema' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "alias_name": "string"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "fields": [
        {
            "column_name": "string",
            "column_type": "INSIGHT_VFS_SCHEMA_TYPE_STRING",
            "column_description": "string"
        }
    ],
    "vfs_description": "string",
    "alias_name": "string"
}

🟢200Success

Modified at 2025-09-26 15:44:58

DeleteCommonsInsight

ListVfses