Skip to main content
API docs by Redocly

Retool Developer API (0.0.1)

Download OpenAPI specification:Download

This version of the Retool API is deprecated. Please use Retool API v2.

Resources

Get Resources

Returns a paginated list of resources.

Authorizations:
BearerAuth
query Parameters
next_token
string

An optional pagination token. You can get the token from the response of this endpoint.

resource_type
string
Enum: "airflow" "alloydb" "asana" "athena" "basecamp" "bigid" "bigquery" "cassandra" "circleci" "closeio" "cosmosdb" "couchdb" "databricks" "datadog" "datastore" "denodo" "dynamodb" "elasticsearch" "firebase" "front" "gcs" "github" "googleAnalytics" "googleMaps" "googleSearchConsole" "googlesheets" "graphql" "grpc" "hubspot" "jdbc" "jira" "lambda" "launchdarkly" "microsoftTeams" "mongodb" "mssql" "mysql" "notion" "onesignal" "openAI" "openapi" "oracledb" "postgresql" "presto" "redis" "redshift" "restapi" "rethinkdb" "rockset" "s3" "salesforce" "saphana" "sendgrid" "shell" "slack" "slackopenapi" "smtp" "snowflake" "stripe" "twilio" "vertica"

Only resources of the type specified by this parameter are returned.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "next": "string"
}

Create a Resource

Creates a new resource, along with a resource configuration for the default environment.

Authorizations:
BearerAuth
Request Body schema: application/json
type
required
string
Enum: "mysql" "postgresql" "redshift" "restapi" "snowflake"

The type of resource.

display_name
required
string non-empty
required
Postgres Options (object) or MySQL Options (object) or Redshift Options (object) or Snowflake Options (object) or Rest API Options (object)

Responses

Request samples

Content type
application/json
{
  • "type": "mysql",
  • "display_name": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "airflow",
  • "display_name": "string",
  • "created_at": "2019-02-08T11:45:48.899Z",
  • "updated_at": "2019-02-24T18:28:18.790Z"
}

Get a Resource By Id

Returns the resource configuration with the given id.

Authorizations:
BearerAuth
path Parameters
resource_id
required
string

A UUID that uniquely identifies a resource.

This is also referenced within the Retool app. For example, when you edit a resource, the ID can be found in the url.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "airflow",
  • "display_name": "string",
  • "created_at": "2019-02-08T11:45:48.899Z",
  • "updated_at": "2019-02-24T18:28:18.790Z"
}

Update a Resource

Updates the resource with the given resource id.

Authorizations:
BearerAuth
path Parameters
resource_id
required
string

A UUID that uniquely identifies a resource.

This is also referenced within the Retool app. For example, when you edit a resource, the ID can be found in the url.

Request Body schema: application/json
display_name
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "display_name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "airflow",
  • "display_name": "string",
  • "created_at": "2019-02-08T11:45:48.899Z",
  • "updated_at": "2019-02-24T18:28:18.790Z"
}

Delete a Resource

Deletes the resource with the given resource id, along with all of its configurations.

Authorizations:
BearerAuth
path Parameters
resource_id
required
string

A UUID that uniquely identifies a resource.

This is also referenced within the Retool app. For example, when you edit a resource, the ID can be found in the url.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "airflow",
  • "display_name": "string",
  • "created_at": "2019-02-08T11:45:48.899Z",
  • "updated_at": "2019-02-24T18:28:18.790Z"
}

Get Resource Configurations

Returns a paginated list of resource configurations.

Authorizations:
BearerAuth
query Parameters
next_token
string

An optional pagination token. You can get the token from the response of this endpoint.

resource_type
string
Enum: "airflow" "alloydb" "asana" "athena" "basecamp" "bigid" "bigquery" "cassandra" "circleci" "closeio" "cosmosdb" "couchdb" "databricks" "datadog" "datastore" "denodo" "dynamodb" "elasticsearch" "firebase" "front" "gcs" "github" "googleAnalytics" "googleMaps" "googleSearchConsole" "googlesheets" "graphql" "grpc" "hubspot" "jdbc" "jira" "lambda" "launchdarkly" "microsoftTeams" "mongodb" "mssql" "mysql" "notion" "onesignal" "openAI" "openapi" "oracledb" "postgresql" "presto" "redis" "redshift" "restapi" "rethinkdb" "rockset" "s3" "salesforce" "saphana" "sendgrid" "shell" "slack" "slackopenapi" "smtp" "snowflake" "stripe" "twilio" "vertica"

Only resources of the type specified by this parameter are returned.

resource_id
string

A UUID that uniquely identifies a resource.

This is also referenced within the Retool app. For example, when you edit a resource, the ID can be found in the url.

environment_id
string <uuid>

A UUID that uniquely identifies an environment.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "next": "string"
}

Create a Resource Configuration

Creates a new resource configuration for a non-default environment.

Authorizations:
BearerAuth
Request Body schema: application/json
resource_id
required
string

A UUID that uniquely identifies a resource.

This is also referenced within the Retool app. For example, when you edit a resource, the ID can be found in the url.

environment_id
required
string <uuid>

A UUID that uniquely identifies an environment.

required
Postgres Options (object) or MySQL Options (object) or Redshift Options (object) or Snowflake Options (object) or Rest API Options (object)

Responses

Request samples

Content type
application/json
{
  • "resource_id": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "resource": {
    },
  • "environment": {
    },
  • "options": {
    },
  • "created_at": "2019-02-08T11:45:48.899Z",
  • "updated_at": "2019-02-24T18:28:18.790Z"
}

Get a Resource Configuration By Id

Returns the resource configuration with the given resource configuration id.

Authorizations:
BearerAuth
path Parameters
resource_configuration_id
required
string

A UUID that uniquely identifies a resource configuration.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "airflow",
  • "display_name": "string",
  • "created_at": "2019-02-08T11:45:48.899Z",
  • "updated_at": "2019-02-24T18:28:18.790Z"
}

Update a Resource Configuration

Updates the resource configuration with the given resource configuration id.

Authorizations:
BearerAuth
path Parameters
resource_configuration_id
required
string

A UUID that uniquely identifies a resource configuration.

Request Body schema: application/json
required
Postgres Options (object) or MySQL Options (object) or Redshift Options (object) or Snowflake Options (object) or Rest API Options (object)

Note that the entire options object will be replaced. You must include any old options that you would like to keep.

Any of
required
object or object
Any of
host
required
string
port
required
string
name
string
username
string
password
string
object
object
disable_converting_queries_to_prepared_statements
boolean

This allows you to use Javascript to dynamically generate SQL but also turns off SQL injection protection.

show_write_gui_only
boolean

This allows you to enable writing via only the restrictive GUI query editor.

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "resource": {
    },
  • "environment": {
    },
  • "options": {
    },
  • "created_at": "2019-02-08T11:45:48.899Z",
  • "updated_at": "2019-02-24T18:28:18.790Z"
}

Delete a Resource Configuration

Deletes the resource configuration with the given resource configuration id. You cannot delete resource configurations in the default environment.

Authorizations:
BearerAuth
path Parameters
resource_configuration_id
required
string

A UUID that uniquely identifies a resource configuration.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "resource": {
    },
  • "environment": {
    },
  • "options": {
    },
  • "created_at": "2019-02-08T11:45:48.899Z",
  • "updated_at": "2019-02-24T18:28:18.790Z"
}

Environments

Get Environments

Returns a list of environments.

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get the Default Environment

Returns the default environment.

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "color": "string",
  • "default": true,
  • "created_at": "string",
  • "updated_at": "string"
}

Get an Environment by Id

Returns the environment with the given id.

Authorizations:
BearerAuth
path Parameters
environment_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "color": "string",
  • "default": true,
  • "created_at": "string",
  • "updated_at": "string"
}