Skip to main content
POST
/
api
/
v1
/
table
/
{table_name}
/
upload
/
excel
Upload Table From Excel
curl --request POST \
  --url https://your-engine-url/api/v1/table/{table_name}/upload/excel \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'body={
  "table": {
    "columns": [
      {
        "default": "<string>",
        "is_nullable": true,
        "type": "<string>",
        "name": "<string>"
      }
    ],
    "constraints": {
      "unique": [
        {
          "name": "",
          "columns": []
        }
      ],
      "primary_key": {
        "name": "",
        "columns": []
      },
      "foreign_keys": [
        {
          "name": "<string>",
          "reference_schema": "public",
          "reference_column": "<string>",
          "reference_table": "<string>",
          "column": "<string>"
        }
      ]
    }
  }
}' \
  --form file=@example-file
{
  "table": {
    "name": "<string>",
    "schema": "<string>",
    "columns": [
      {
        "id": 123,
        "default": "<string>",
        "is_nullable": true,
        "type": "<string>",
        "name": "<string>"
      }
    ],
    "constraints": {
      "unique": [
        {
          "name": "",
          "columns": []
        }
      ],
      "primary_key": {
        "name": "",
        "columns": []
      },
      "foreign_keys": [
        {
          "name": "<string>",
          "reference_schema": "public",
          "reference_column": "<string>",
          "reference_table": "<string>",
          "column": "<string>"
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Enter: 'Bearer <JWT>', where JWT is the access token. Example: Bearer access_token_comes_here

Path Parameters

​
table_name
string
required

Query Parameters

​
schema
string
default:public
​
if_exists
string
default:fail

Body

multipart/form-data
​
file
file
required
​
body
object

Response

Successful Response

​
table
object
required