Sign in

01a1cf91cfd6

latestOpenAPI 3.1.02026-08-1384336455.2 KB
Dataframes

Add Dataframe

Authorization scope: dataframe:write

Creates a new dataframe entity.

Please note that the Dataframe's name has to be unique

post/v1/accounts/{account_id}/environments/{environment_id}/dataframes

Path parameters

account_idstring required
environment_idstring required

Request body

namestring required

The name of the dataframe - must be unique

Example request

{
  "connection_settings": {
    "connection": "62e7f4352c13160013dc39be",
    "datasource_id": "aws",
    "default_bucket": "some_s3_bucket",
    "storage_type": "s3"
  },
  "name": "unique_name"
}

Response

Successful Response

account_idstring required

The account id of the user

environment_idstring required

The environment id of the user

connection_settingsobject

The connection settings of the dataframe

namestring required

The name of the dataframe - must be unique

Example response

{
  "account_id": "62e7f4352c13160013dc39be",
  "environment_id": "82e7f4122c13169813dc395g",
  "name": "unique_name"
}