Star
API docs by Redocly

NocoDB

Download OpenAPI specification:Download

NocoDB API Documentation

Auth

List Base Users

List all users in the given base.

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

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

Create Base User

Create a user and add it to the given base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
email
required
string <email>

Base User Email

roles
required
string
Enum: "no-access" "commenter" "editor" "guest" "owner" "viewer" "creator"

Base User Role

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "roles": "owner"
}

Response samples

Content type
application/json
Example
{
  • "msg": "The user has been invited successfully"
}

Update Base User

Update a given user in a given base. Exclusive for Super Admin. Access with API Tokens will be blocked.

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

userId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique User ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
email
required
string <email>

Base User Email

roles
required
string
Enum: "no-access" "commenter" "editor" "guest" "owner" "viewer" "creator"

Base User Role

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "roles": "owner"
}

Response samples

Content type
application/json
{
  • "msg": "The user has been updated successfully"
}

Delete Base User

Delete a given user in a given base. Exclusive for Super Admin. Access with API Tokens will be blocked.

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

userId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique User ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "msg": "The user has been updated successfully"
}

Resend User Invitation

Resend Invitation to a specific user

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

userId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique User ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "msg": "The invitation has been sent to the user"
}

Storage

Attachment Upload

Upload attachment

query Parameters
path
required
string
Example: path=download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg

Target File Path

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: multipart/form-data
mimetype
string

The mimetype of the attachment

path
string

The file path of the attachment

size
number

The size of the attachment

title
string

The title of the attachment used in UI

url
string

Attachment URL to be uploaded via upload-by-url

Request samples

Content type
multipart/form-data
{
  "mimetype": "image/jpeg",
  "path": "download/noco/jango_fett/Table1/attachment/uVbjPVQxC_SSfs8Ctx.jpg",
  "size": 13052,
  "title": "22bc-kavypmq4869759 (1).jpg"
}

Source

Get Source

Get the source details of a given base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

sourceId
required
stringds_j04jmxh5xg10lu

Unique Source ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "alias": null,
  • "config": "<ENCRYPTED>",
  • "enabled": 1,
  • "id": "ds_krsappzu9f8vmo",
  • "inflection_column": "camelize",
  • "inflection_table": "camelize",
  • "is_meta": 1,
  • "meta": null,
  • "order": 1,
  • "base_id": "p_01clqvzik3izk6",
  • "type": "mysql2"
}

Delete Source

Delete the source details of a given base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

sourceId
required
stringds_j04jmxh5xg10lu

Unique Source ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true

Update Source

Update the source details of a given base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

sourceId
required
stringds_j04jmxh5xg10lu

Unique Source ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "alias": "sakila",
  • "type": "mysql2",
  • "config": {
    },
  • "inflection_column": "camelize",
  • "inflection_table": "camelize"
}

Response samples

Content type
application/json
{
  • "id": "ds_rrplkgy0pq1f3c",
  • "base_id": "p_63b4q0qengen1x",
  • "alias": "sakila",
  • "meta": null,
  • "is_meta": null,
  • "type": "mysql2",
  • "inflection_column": "camelize",
  • "inflection_table": "camelize",
  • "created_at": "2023-03-11T10:31:15.341Z",
  • "updated_at": "2023-03-11T10:32:25.763Z",
  • "enabled": true,
  • "order": 2
}

Create sql view

path Parameters
baseId
required
string
sourceId
required
string
Request Body schema: application/json
view_name
string
view_definition
string

Responses

Request samples

Content type
application/json
{
  • "view_name": "string",
  • "view_definition": "string"
}

Response samples

Content type
application/json
{ }

List Sources

Get base source list

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

Create Source

Create a new source on a given base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
config
any

Source Configuration

Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
id
string

Unique Source ID

inflection_column
string

Inflection for columns

inflection_table
string

Inflection for tables

Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
order
number

The order of the list of sources

base_id
string

The base ID that this source belongs to

type
string
Enum: "mssql" "mysql" "mysql2" "oracledb" "pg" "snowflake" "sqlite3"

DB Type

external
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "alias": null,
  • "config": "<ENCRYPTED>",
  • "enabled": 1,
  • "id": "ds_krsappzu9f8vmo",
  • "inflection_column": "camelize",
  • "inflection_table": "camelize",
  • "is_meta": 1,
  • "meta": null,
  • "order": 1,
  • "base_id": "p_01clqvzik3izk6",
  • "type": "mysql2",
  • "external": false
}

Response samples

Content type
application/json
{
  • "alias": null,
  • "config": "<ENCRYPTED>",
  • "enabled": 1,
  • "id": "ds_krsappzu9f8vmo",
  • "inflection_column": "camelize",
  • "inflection_table": "camelize",
  • "is_meta": 1,
  • "meta": null,
  • "order": 1,
  • "base_id": "p_01clqvzik3izk6",
  • "type": "mysql2"
}

share ERD view

path Parameters
baseId
required
string
sourceId
required
string

Responses

Response samples

Content type
application/json
{
  • "alias": null,
  • "config": "<ENCRYPTED>",
  • "enabled": 1,
  • "id": "ds_krsappzu9f8vmo",
  • "inflection_column": "camelize",
  • "inflection_table": "camelize",
  • "is_meta": 1,
  • "meta": null,
  • "order": 1,
  • "base_id": "p_01clqvzik3izk6",
  • "type": "mysql2"
}

source-disable-share-erd

path Parameters
baseId
required
string
sourceId
required
string

Responses

List Tables

List all tables in a given Base and Source

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

sourceId
required
stringds_j04jmxh5xg10lu

Unique Source ID

query Parameters
page
number
pageSize
number
sort
string
includeM2M
boolean
header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

Create Table

Create a new table in a given Base and Source

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

sourceId
required
stringds_j04jmxh5xg10lu

Unique Source ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
required
Array of objects (Normal Column Request Model)

The column models in this table

Meta Model (null) or Meta Model (object) or Meta Model (string) (Meta)
order
number

The order of table list

table_name
required
string [ 1 .. 255 ] characters

Table name

title
string [ 0 .. 255 ] characters

Table title

Responses

Request samples

Content type
application/json
{
  • "columns": [
    ],
  • "table_name": "Sheet-1",
  • "title": "Sheet-1"
}

Response samples

Content type
application/json
{
  • "source_id": "ds_g4ccx6e77h1dmi",
  • "columns": [
    ],
  • "columnsById": {
    },
  • "created_at": "2023-03-02 17:04:06",
  • "deleted": null,
  • "enabled": 1,
  • "id": "md_rsu68aqjsbyqtl",
  • "meta": null,
  • "mm": 0,
  • "order": 1,
  • "pinned": null,
  • "base_id": "p_xm3thidrblw4n7",
  • "schema": null,
  • "table_name": "nc_vm5q___Table1",
  • "tags": null,
  • "title": "Table1",
  • "type": "table",
  • "updated_at": "2023-03-02 17:04:08",
  • "views": [
    ]
}

Synchronise Source Meta

Synchronise the meta data difference between NC_DB and external data sources in a given Source

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

sourceId
required
stringds_j04jmxh5xg10lu

Unique Source ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "msg": "The source meta has been synchronized successfully"
}

Source Meta Diff

Get the meta data difference between NC_DB and external data sources in a given Source

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

sourceId
required
stringds_j04jmxh5xg10lu

Unique Source ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DB Table

Create Table

Create a new table in a given base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
required
Array of objects (Normal Column Request Model)

The column models in this table

Meta Model (null) or Meta Model (object) or Meta Model (string) (Meta)
order
number

The order of table list

table_name
required
string [ 1 .. 255 ] characters

Table name

title
string [ 0 .. 255 ] characters

Table title

Responses

Request samples

Content type
application/json
{
  • "columns": [
    ],
  • "table_name": "Sheet-1",
  • "title": "Sheet-1"
}

Response samples

Content type
application/json
{
  • "source_id": "ds_g4ccx6e77h1dmi",
  • "columns": [
    ],
  • "columnsById": {
    },
  • "created_at": "2023-03-02 17:04:06",
  • "deleted": null,
  • "enabled": 1,
  • "id": "md_rsu68aqjsbyqtl",
  • "meta": null,
  • "mm": 0,
  • "order": 1,
  • "pinned": null,
  • "base_id": "p_xm3thidrblw4n7",
  • "schema": null,
  • "table_name": "nc_vm5q___Table1",
  • "tags": null,
  • "title": "Table1",
  • "type": "table",
  • "updated_at": "2023-03-02 17:04:08",
  • "views": [
    ]
}

List Tables

List all tables in a given base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

query Parameters
page
number
pageSize
number
sort
string
includeM2M
boolean
header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

Read Table

Read the table meta data by the given table ID

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "id": "md_rsu68aqjsbyqtl",
  • "source_id": "ds_g4ccx6e77h1dmi",
  • "base_id": "p_xm3thidrblw4n7",
  • "table_name": "nc_vm5q___Table1",
  • "title": "Table1",
  • "type": "table",
  • "meta": null,
  • "schema": null,
  • "enabled": 1,
  • "mm": 0,
  • "tags": null,
  • "pinned": null,
  • "deleted": null,
  • "order": 1,
  • "created_at": "2023-03-02 17:04:06",
  • "updated_at": "2023-03-02 17:04:08",
  • "columns": [
    ],
  • "views": [
    ],
  • "columnsById": {
    }
}

Update Table

Update the table meta data by the given table ID

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
table_name
string

Table name

title
string

Table title

base_id
string

Base ID

Meta Model (null) or Meta Model (object) or Meta Model (string) (Meta)

Responses

Request samples

Content type
application/json
{
  • "table_name": "users",
  • "title": "Users",
  • "base_id": "p_124hhlkbeasewh",
  • "meta": null
}

Response samples

Content type
application/json
{
  • "msg": "The table has been updated successfully"
}

Delete Table

Delete the table meta data by the given table ID

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true

Duplicate Table

Duplicate a table

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "excludeData": true,
  • "excludeViews": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string"
}

Reorder Table

Update the order of the given Table

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
order
number

Responses

Request samples

Content type
application/json
{
  • "order": 0
}

Response samples

Content type
application/json
true

DB Table Column

Create Column

Create a new column in a given Table

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
Any of
formula
string

Formula with column ID replaced

formula_raw
string

Original Formula inputted in UI

title
required
string [ 1 .. 255 ] characters

Formula Title

uidt
string
Value: "Formula"

UI Data Type

column_name
string
object

Column order in a specific view

Responses

Request samples

Content type
application/json
{
  • "ai": 0,
  • "au": 0,
  • "source_id": "ds_krsappzu9f8vmo",
  • "cc": "",
  • "cdf": null,
  • "clen": "45",
  • "column_name": "title",
  • "cop": "2",
  • "csn": "utf8mb4",
  • "ct": "varchar(45)",
  • "deleted": null,
  • "dt": "varchar",
  • "dtx": "specificType",
  • "dtxp": "45",
  • "dtxs": null,
  • "fk_model_id": "md_yvwvbt2i78rgcm",
  • "id": "cl_0j9gv0oi8vjy46",
  • "meta": null,
  • "np": null,
  • "ns": null,
  • "order": 2,
  • "pk": 0,
  • "base_id": "p_01clqvzik3izk6",
  • "pv": 1,
  • "rqd": 0,
  • "system": 0,
  • "title": "Title",
  • "uidt": "SingleLineText",
  • "un": 0,
  • "unique": 0,
  • "validate": null,
  • "virtual": null
}

Response samples

Content type
application/json
{
  • "msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

Update Column

Update the existing column by the given column ID

path Parameters
columnId
required
string
header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
Any of
formula
string

Formula with column ID replaced

formula_raw
string

Original Formula inputted in UI

title
required
string [ 1 .. 255 ] characters

Formula Title

uidt
string
Value: "Formula"

UI Data Type

column_name
string
object

Column order in a specific view

Responses

Request samples

Content type
application/json
Example
{
  • "formula": "CONCAT(\"FOO\", {{cl_c5knoi4xs4sfpt}})",
  • "formula_raw": "CONCAT(\"FOO\", {Title})",
  • "title": "Formula",
  • "uidt": "Formula"
}

Response samples

Content type
application/json
{
  • "ai": 0,
  • "au": 0,
  • "source_id": "ds_krsappzu9f8vmo",
  • "cc": "",
  • "cdf": null,
  • "clen": "45",
  • "column_name": "title",
  • "cop": "2",
  • "created_at": "2023-03-02 13:14:16",
  • "csn": "utf8mb4",
  • "ct": "varchar(45)",
  • "deleted": null,
  • "dt": "varchar",
  • "dtx": "specificType",
  • "dtxp": "45",
  • "dtxs": null,
  • "fk_model_id": "md_yvwvbt2i78rgcm",
  • "id": "cl_0j9gv0oi8vjy46",
  • "meta": null,
  • "np": null,
  • "ns": null,
  • "order": 2,
  • "pk": 0,
  • "base_id": "p_01clqvzik3izk6",
  • "pv": 1,
  • "rqd": 0,
  • "system": 0,
  • "title": "Title",
  • "uidt": "SingleLineText",
  • "un": 0,
  • "unique": 0,
  • "updated_at": "2023-03-02 13:14:16",
  • "validate": null,
  • "virtual": null
}

Delete Column

Delete the existing column by the given column ID

path Parameters
columnId
required
string
header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

Get Column

Get the existing column by the given column ID

path Parameters
columnId
required
string
header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "msg": "BadRequest [Error]: <ERROR MESSAGE>"
}

Create Primary Value

Set a primary value on a given column

path Parameters
columnId
required
string
header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true

Get columns hash for table

Get columns hash for table

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

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

Bulk create-update-delete columns

Bulk create-update-delete columns

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
hash
string

Columns hash

ops
Array of any

Responses

Request samples

Content type
application/json
{
  • "hash": "string",
  • "ops": [
    ]
}

Response samples

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

DB Table Filter

Get View Filter

Get the filter data in a given View

path Parameters
viewId
required
string
Example: vw_wtdg2meyig5l4q

Unique View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

Create View Filter

Update the filter data in a given View

path Parameters
viewId
required
string
Example: vw_wtdg2meyig5l4q

Unique View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
string or null

Comparison Operator

string or null

Comparison Sub-Operator

StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
logical_op
string
Enum: "and" "not" "or"

Logical Operator

value
any

The filter value. Can be NULL for some operators.

Responses

Request samples

Content type
application/json
{
  • "comparison_op": "eq",
  • "comparison_sub_op": null,
  • "fk_column_id": "cl_d7ah9n2qfupgys",
  • "is_group": false,
  • "logical_op": "and",
  • "value": "foo"
}

Response samples

Content type
application/json
{
  • "source_id": "ds_g4ccx6e77h1dmi",
  • "comparison_op": "eq",
  • "comparison_sub_op": null,
  • "created_at": "2023-03-02 18:18:05",
  • "fk_column_id": "cl_d7ah9n2qfupgys",
  • "fk_hook_id": null,
  • "fk_parent_id": null,
  • "fk_view_id": "vw_b739e29vqmrxnf",
  • "id": "fi_xn647tpmdq8fu8",
  • "is_group": null,
  • "logical_op": "and",
  • "order": 1,
  • "base_id": "p_xm3thidrblw4n7",
  • "updated_at": "2023-03-02 18:18:05",
  • "value": "foo"
}

Get Filter

Get the filter data with a given Filter ID

path Parameters
filterId
required
string (Id) [ 0 .. 20 ] characters fi_pgfuo11uhn2xeo
Examples: string

Unique Filter ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "source_id": "ds_g4ccx6e77h1dmi",
  • "comparison_op": "eq",
  • "comparison_sub_op": null,
  • "created_at": "2023-03-02 18:18:05",
  • "fk_column_id": "cl_d7ah9n2qfupgys",
  • "fk_hook_id": null,
  • "fk_parent_id": null,
  • "fk_view_id": "vw_b739e29vqmrxnf",
  • "id": "fi_xn647tpmdq8fu8",
  • "is_group": null,
  • "logical_op": "and",
  • "order": 1,
  • "base_id": "p_xm3thidrblw4n7",
  • "updated_at": "2023-03-02 18:18:05",
  • "value": "foo"
}

Update Filter

Update the filter data with a given Filter ID

path Parameters
filterId
required
string (Id) [ 0 .. 20 ] characters fi_pgfuo11uhn2xeo
Examples: string

Unique Filter ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
string or null

Comparison Operator

string or null

Comparison Sub-Operator

StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
logical_op
string
Enum: "and" "not" "or"

Logical Operator

value
any

The filter value. Can be NULL for some operators.

Responses

Request samples

Content type
application/json
{
  • "comparison_op": "eq",
  • "comparison_sub_op": null,
  • "fk_column_id": "cl_d7ah9n2qfupgys",
  • "is_group": false,
  • "logical_op": "and",
  • "value": "foo"
}

Response samples

Content type
application/json
1

Delete Filter

Delete the filter data with a given Filter ID

path Parameters
filterId
required
string (Id) [ 0 .. 20 ] characters fi_pgfuo11uhn2xeo
Examples: string

Unique Filter ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true

Get Filter Group Children

Get Filter Group Children of a given group ID

path Parameters
filterGroupId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Filter Group ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

DB Table Sort

List View Sorts

List all the sort data in a given View

path Parameters
viewId
required
string
Example: vw_wtdg2meyig5l4q

Unique View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

Update View Sort

Update the sort data in a given View

path Parameters
viewId
required
string
Example: vw_wtdg2meyig5l4q

Unique View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
non-empty
fk_column_id
string (Id) [ 0 .. 20 ] characters

Foreign Key to Column

direction
string
Enum: "asc" "desc"

Sort direction

push_to_top
boolean

Push the sort to the top of the list

Responses

Request samples

Content type
application/json
{
  • "direction": "asc",
  • "fk_column_id": "cl_l11b769pe2j1ce",
  • "push_to_top": true
}

Response samples

Content type
application/json
1

Get Sort

Get the sort data by Sort ID

path Parameters
sortId
required
string
Example: so_xd4t51uv60ghzl

Unique Sort ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "id": "so_xd4t51uv60ghzl",
  • "fk_column_id": "cl_l11b769pe2j1ce",
  • "fk_model_id": "md_ehn5izr99m7d45",
  • "source_id": "ds_3l9qx8xqksenrl",
  • "direction": "desc",
  • "order": 1,
  • "base_id": "p_9sx43moxhqtjm3"
}

Update Sort

Update the sort data by Sort ID

path Parameters
sortId
required
string
Example: so_xd4t51uv60ghzl

Unique Sort ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
non-empty
fk_column_id
string (Id) [ 0 .. 20 ] characters

Foreign Key to Column

direction
string
Enum: "asc" "desc"

Sort direction

Responses

Request samples

Content type
application/json
{
  • "direction": "asc",
  • "fk_column_id": "cl_l11b769pe2j1ce"
}

Response samples

Content type
application/json
1

Delete Sort

Delete the sort data by Sort ID

path Parameters
sortId
required
string
Example: so_xd4t51uv60ghzl

Unique Sort ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true

DB Table Webhook

List Table Hooks

List all hook records in the given Table

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

Create Table Hook

Create a hook in the given table

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

Request Body schema: application/json
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
env
string

Environment for the hook

event
required
string
Enum: "after" "before"

Event Type for the operation

fk_model_id
string

Foreign Key to Model

id
string (Id) [ 0 .. 20 ] characters

Unique ID

notification
required
object or string

Hook Notification including info such as type, payload, method, body, and etc

operation
required
string
Enum: "insert" "update" "delete" "bulkInsert" "bulkUpdate" "bulkDelete"

Hook Operation

retries
number

Retry Count

retry_interval
number

Retry Interval

timeout
number

Timeout

title
required
string

Hook Title

type
string or null

Hook Type

Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)

Responses

Request samples

Content type
application/json
{
  • "active": 0,
  • "async": 0,
  • "description": "This is my hook description",
  • "env": "all",
  • "event": "after",
  • "fk_model_id": "md_rsu68aqjsbyqtl",
  • "id": "string",
  • "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}",
  • "null": null,
  • "operation": "insert",
  • "retries": 10,
  • "retry_interval": 60000,
  • "timeout": 60000,
  • "title": "My Webhook",
  • "condition": false
}

Response samples

Content type
application/json
{
  • "active": 0,
  • "async": 0,
  • "description": "This is my hook description",
  • "env": "all",
  • "event": "after",
  • "fk_model_id": "md_rsu68aqjsbyqtl",
  • "id": "string",
  • "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}",
  • "null": null,
  • "operation": "insert",
  • "retries": 10,
  • "retry_interval": 60000,
  • "timeout": 60000,
  • "title": "My Webhook"
}

Test Hook

Test the hook in the given Table

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
required
object (HookReq)

Model for Hook

payload
required
any

Payload to be sent

Responses

Request samples

Content type
application/json
{
  • "hook": {
    },
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "msg": "The hook has been tested successfully"
}

Get Sample Hook Payload

Get the sample hook payload

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

operation
required
string
Enum: "insert" "update" "delete" "bulkInsert" "bulkUpdate" "bulkDelete"

Hook Operation

version
required
string
Enum: "v1" "v2"

Hook Version

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

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

Update Hook

Update the exsiting hook by its ID

path Parameters
hookId
required
string
Example: hk_0063k4o1frnxbr

Unique Hook ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
description
string

Hook Description

env
string

Environment for the hook

event
string
Enum: "after" "before"

Event Type for the operation

fk_model_id
string

Foreign Key to Model

id
string (Id) [ 0 .. 20 ] characters

Unique ID

notification
object or string

Hook Notification including info such as type, payload, method, body, and etc

operation
string
Enum: "insert" "update" "delete" "bulkInsert" "bulkUpdate" "bulkDelete"

Hook Operation

retries
number

Retry Count

retry_interval
number

Retry Interval

timeout
number

Timeout

title
string

Hook Title

type
string

Hook Type

version
string
Enum: "v1" "v2"

Hook Version

Responses

Request samples

Content type
application/json
{
  • "active": 0,
  • "async": 0,
  • "description": "This is my hook description",
  • "env": "all",
  • "event": "after",
  • "fk_model_id": "md_rsu68aqjsbyqtl",
  • "id": "string",
  • "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}",
  • "null": null,
  • "operation": "insert",
  • "retries": 10,
  • "retry_interval": 60000,
  • "timeout": 60000,
  • "title": "My Webhook"
}

Response samples

Content type
application/json
{
  • "active": 0,
  • "async": 0,
  • "description": "This is my hook description",
  • "env": "all",
  • "event": "after",
  • "fk_model_id": "md_rsu68aqjsbyqtl",
  • "id": "string",
  • "notification": "{\"type\":\"URL\",\"payload\":{\"method\":\"POST\",\"body\":\"{{ json data }}\",\"headers\":[{}],\"parameters\":[{}],\"auth\":\"\",\"path\":\"http://example.com\"}}",
  • "null": null,
  • "operation": "insert",
  • "retries": 10,
  • "retry_interval": 60000,
  • "timeout": 60000,
  • "title": "My Webhook"
}

Delete Hook

Delete the exsiting hook by its ID

path Parameters
hookId
required
string
Example: hk_0063k4o1frnxbr

Unique Hook ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true

DB Table Webhook Filter

Get Hook Filter

Get the filter data in a given Hook

path Parameters
hookId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Hook ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

Create Hook Filter

Create filter(s) in a given Hook

path Parameters
hookId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Hook ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
string or null

Comparison Operator

string or null

Comparison Sub-Operator

StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
logical_op
string
Enum: "and" "not" "or"

Logical Operator

value
any

The filter value. Can be NULL for some operators.

Responses

Request samples

Content type
application/json
{
  • "comparison_op": "eq",
  • "comparison_sub_op": null,
  • "fk_column_id": "cl_d7ah9n2qfupgys",
  • "is_group": false,
  • "logical_op": "and",
  • "value": "foo"
}

Response samples

Content type
application/json
{
  • "source_id": "ds_g4ccx6e77h1dmi",
  • "comparison_op": "eq",
  • "comparison_sub_op": null,
  • "created_at": "2023-03-02 18:18:05",
  • "fk_column_id": "cl_d7ah9n2qfupgys",
  • "fk_hook_id": null,
  • "fk_parent_id": null,
  • "fk_view_id": "vw_b739e29vqmrxnf",
  • "id": "fi_xn647tpmdq8fu8",
  • "is_group": null,
  • "logical_op": "and",
  • "order": 1,
  • "base_id": "p_xm3thidrblw4n7",
  • "updated_at": "2023-03-02 18:18:05",
  • "value": "foo"
}

DB View

List Views

List all views in a given Table.

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

Update View

Update the view with the given view Id.

path Parameters
viewId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
title
string <= 255 characters

View Title

uuid
string <= 255 characters

View UUID. Used in Shared View.

password
string <= 255 characters

View Password. Used in Shared View.

lock_type
string
Enum: "collaborative" "locked" "personal"

Lock type of View.

Meta Model (null) or Meta Model (object) or Meta Model (string) (Meta)
order
number >= 0

The order of the list of views.

Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)

Responses

Request samples

Content type
application/json
{
  • "title": "Grid View 1",
  • "uuid": "e2457bbf-e29c-4fec-866e-fe3b01dba57f",
  • "password": "password123",
  • "lock_type": "collaborative",
  • "meta": "{\"allowCSVDownload\":true}",
  • "order": 1,
  • "show_system_fields": 0
}

Response samples

Content type
application/json
{
  • "source_id": "ds_g4ccx6e77h1dmi",
  • "created_at": "2023-03-02 17:46:31",
  • "fk_model_id": "md_mhs9z4r2ak98x0",
  • "id": "vw_lg052cnc1c26kf",
  • "is_default": 1,
  • "lock_type": "collaborative",
  • "meta": "{\"allowCSVDownload\":true}",
  • "order": 1,
  • "password": "password123",
  • "base_id": "p_xm3thidrblw4n7",
  • "show": 1,
  • "show_system_fields": null,
  • "title": "Grid View 1",
  • "type": 3,
  • "updated_at": "2023-03-02 17:46:31",
  • "uuid": null
}

Delete View

Delete the view with the given view Id.

path Parameters
viewId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true

Show All Columns In View

Show All Columns in a given View

path Parameters
viewId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique View ID

query Parameters
ignoreIds
Array of arrays
header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true

Hide All Columns In View

Hide All Columns in a given View

path Parameters
viewId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique View ID

query Parameters
ignoreIds
Array of arrays
header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true

Create Grid View

Create a new grid view in a given Table

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
title
required
string

View Title

type
number

View Type

StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)

Responses

Request samples

Content type
application/json
{
  • "title": "My Grid View",
  • "type": 3,
  • "copy_from_id": null,
  • "fk_grp_col_id": null,
  • "fk_geo_data_col_id": null
}

Response samples

Content type
application/json
{
  • "id": "vw_o50jiw9v2txktv",
  • "source_id": "ds_a95vextjl510z7",
  • "base_id": "p_slkm6i3v31q4bc",
  • "fk_model_id": "md_8hr3xndx8umuce",
  • "title": "Grid-1",
  • "type": 3,
  • "is_default": null,
  • "show_system_fields": null,
  • "lock_type": "collaborative",
  • "uuid": null,
  • "password": null,
  • "show": true,
  • "order": 2,
  • "created_at": "2023-03-13T07:29:16.610Z",
  • "updated_at": "2023-03-13T07:29:16.610Z",
  • "meta": { }
}

Create Form View

Create a new form view in a given Table

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
title
required
string

View Title

type
number

View Type

StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)

Responses

Request samples

Content type
application/json
{
  • "title": "My Form View",
  • "type": 1,
  • "copy_from_id": null,
  • "fk_grp_col_id": null,
  • "fk_geo_data_col_id": null
}

Response samples

Content type
application/json
{
  • "id": "vw_a830n4bmwk8wlp",
  • "source_id": "ds_a95vextjl510z7",
  • "base_id": "p_slkm6i3v31q4bc",
  • "fk_model_id": "md_8hr3xndx8umuce",
  • "title": "Form-1",
  • "type": 1,
  • "is_default": null,
  • "show_system_fields": null,
  • "lock_type": "collaborative",
  • "uuid": null,
  • "password": null,
  • "show": true,
  • "order": 4,
  • "created_at": "2023-03-13T07:29:19.957Z",
  • "updated_at": "2023-03-13T07:29:19.957Z",
  • "meta": { }
}

Update Form View

Update the form data by Form ID

path Parameters
formViewId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Form View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
heading
string <= 255 characters

The heading of the form

StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
Meta Model (null) or Meta Model (object) or Meta Model (string) (Meta)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)

Responses

Request samples

Content type
application/json
{
  • "banner_image_url": null,
  • "email": "user@example.com",
  • "heading": "My Form",
  • "lock_type": "collaborative",
  • "logo_url": null,
  • "meta": null,
  • "redirect_after_secs": null,
  • "redirect_url": null,
  • "show_blank_form": 0,
  • "subheading": "My Form Subheading",
  • "submit_another_form": 0,
  • "success_msg": "Thank you for the submission.",
  • "title": "Form View 1"
}

Response samples

Content type
application/json
1

Get Form

Get the form data by Form ID

path Parameters
formViewId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Form View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "source_id": "ds_g4ccx6e77h1dmi",
  • "banner_image_url": null,
  • "columns": [
    ],
  • "email": "user@example.com",
  • "fk_model_id": "md_rsu68aqjsbyqtl",
  • "heading": "My Form",
  • "lock_type": "collaborative",
  • "logo_url": null,
  • "meta": null,
  • "redirect_after_secs": null,
  • "redirect_url": null,
  • "show_blank_form": 0,
  • "subheading": "My Form Subheading",
  • "submit_another_form": 0,
  • "success_msg": "Thank you for the submission.",
  • "title": "Form View 1"
}

Update Form Column

Update the form column(s) by Form View Column ID

path Parameters
formViewColumnId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Form View Column ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
Meta Model (null) or Meta Model (object) or Meta Model (string) (Meta)
order
number

The order among all the columns in the form

Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)

Responses

Request samples

Content type
application/json
{
  • "description": null,
  • "help": "This is a help text",
  • "label": "Form Label",
  • "meta": null,
  • "order": 1,
  • "required": 0,
  • "show": 0
}

Response samples

Content type
application/json
{
  • "description": null,
  • "help": "This is a help text",
  • "label": "Form Label",
  • "meta": null,
  • "order": 1,
  • "required": 0,
  • "show": 0
}

Update Grid View

Update Grid View

path Parameters
viewId
required
string
Example: vw_wtdg2meyig5l4q

Unique View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
row_height
number

Row Height

Meta Model (null) or Meta Model (object) or Meta Model (string) (Meta)

Responses

Request samples

Content type
application/json
{
  • "row_height": 1,
  • "meta": null
}

Response samples

Content type
application/json
1

List Grid Columns

List all columns in the given Grid

path Parameters
gridId
required
string
Example: vw_q6k13mmygdi3yz

Grid View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Grid Column

Update grid column(s) in the given Grid

path Parameters
columnId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Column ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
fk_column_id
string (Id) [ 0 .. 20 ] characters

Foreign Key to Column

help
string <= 255 characters
label
string <= 255 characters

The label of the column

width
string <= 255 characters ^[0-9]+(px|%)$

The width of the column

Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
group_by_order
number

Group By Order

StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)

Responses

Request samples

Content type
application/json
{
  • "fk_column_id": "cl_c5knoi4xs4sfpt",
  • "label": "My Column",
  • "width": "200px"
}

Response samples

Content type
application/json
1

Create Kanban View

Create a new Kanban View

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
title
required
string

View Title

type
number

View Type

StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)

Responses

Request samples

Content type
application/json
{
  • "title": "My Kanban View",
  • "type": 4,
  • "copy_from_id": null,
  • "fk_grp_col_id": "cl_g0a89q9xdry3lu",
  • "fk_geo_data_col_id": null
}

Response samples

Content type
application/json
{
  • "id": "vw_569sqsrp2vuff4",
  • "source_id": "ds_a95vextjl510z7",
  • "base_id": "p_slkm6i3v31q4bc",
  • "fk_model_id": "md_8hr3xndx8umuce",
  • "title": "Kanban-1",
  • "type": 4,
  • "is_default": null,
  • "show_system_fields": null,
  • "lock_type": "collaborative",
  • "uuid": null,
  • "password": null,
  • "show": true,
  • "order": 5,
  • "created_at": "2023-03-13T07:29:21.387Z",
  • "updated_at": "2023-03-13T07:29:21.387Z",
  • "meta": { }
}

Update Kanban View

Update the Kanban View data with Kanban ID

path Parameters
kanbanViewId
required
string
Example: vw_1eq2wk2xe3a9j5

Unique Kanban View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
Meta Model (null) or Meta Model (object) or Meta Model (string) (Meta)

Responses

Request samples

Content type
application/json
{
  • "fk_grp_col_id": "cl_g0a89q9xdry3lu",
  • "fk_cover_image_col_id": "cl_ib8l4j1kiu1efx",
  • "meta": {
    }
}

Response samples

Content type
application/json
1

Get Kanban View

Get the Kanban View data by Kanban ID

path Parameters
kanbanViewId
required
string
Example: vw_1eq2wk2xe3a9j5

Unique Kanban View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "id": "vw_wqs4zheuo5lgdy",
  • "fk_grp_col_id": "cl_3704cxcbqt7sj7",
  • "fk_view_id": "vw_wqs4zheuo5lgdy",
  • "fk_cover_image_col_id": null,
  • "columns": [
    ],
  • "meta": null,
  • "title": "My Kanban"
}

Create Map View

Create a new Map View

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
title
required
string

View Title

type
number

View Type

StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)

Responses

Request samples

Content type
application/json
{
  • "title": "My Map View",
  • "type": 5,
  • "copy_from_id": null,
  • "fk_grp_col_id": null,
  • "fk_geo_data_col_id": "cl_uu1meolj00tlrq"
}

Response samples

Content type
application/json
{
  • "source_id": "ds_g4ccx6e77h1dmi",
  • "created_at": "2023-03-02 17:46:31",
  • "fk_model_id": "md_mhs9z4r2ak98x0",
  • "id": "vw_lg052cnc1c26kf",
  • "is_default": 1,
  • "lock_type": "collaborative",
  • "meta": { },
  • "order": 1,
  • "password": null,
  • "base_id": "p_xm3thidrblw4n7",
  • "show": 1,
  • "show_system_fields": null,
  • "title": "Sheet-1",
  • "type": 3,
  • "updated_at": "2023-03-02 17:46:31",
  • "uuid": null
}

Update Map View

Update the Map View data by Map ID

path Parameters
mapViewId
required
string
Example: vw_1eq2wk2xe3a9j5

Unique Map View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
fk_geo_data_col_id
string

Foreign Key to GeoData Column

Meta Model (null) or Meta Model (object) or Meta Model (string) (Meta)

Responses

Request samples

Content type
application/json
{
  • "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna",
  • "meta": null
}

Response samples

Content type
application/json
1

Get Map View

Get the Map View data by Map ID

path Parameters
mapViewId
required
string
Example: vw_1eq2wk2xe3a9j5

Unique Map View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "source_id": "ds_g4ccx6e77h1dmi",
  • "columns": [
    ],
  • "fk_geo_data_col_id": "cl_8iw2o4ejzvdyna",
  • "fk_view_id": "vw_qjt7klod1p9kyv",
  • "meta": { },
  • "order": 0,
  • "base_id": "p_xm3thidrblw4n7",
  • "show": true,
  • "title": "My Map"
}

DB View Column

List Columns In View

List all columns by ViewID

path Parameters
viewId
required
string
Example: vw_wtdg2meyig5l4q

Unique View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

Create Column in View

Create a new column in a given View

path Parameters
viewId
required
string
Example: vw_wtdg2meyig5l4q

Unique View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
fk_column_id
string (Id) [ 0 .. 20 ] characters

Foreign Key to Column

Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
order
number >= 0

The order of the list of views.

Responses

Request samples

Content type
application/json
{
  • "fk_column_id": "cl_m4wkaqgqqjzoeh",
  • "show": 0,
  • "order": 1
}

Response samples

Content type
application/json
{
  • "ai": 0,
  • "au": 0,
  • "source_id": "ds_krsappzu9f8vmo",
  • "cc": "",
  • "cdf": null,
  • "clen": "45",
  • "column_name": "title",
  • "cop": "2",
  • "created_at": "2023-03-02 13:14:16",
  • "csn": "utf8mb4",
  • "ct": "varchar(45)",
  • "deleted": null,
  • "dt": "varchar",
  • "dtx": "specificType",
  • "dtxp": "45",
  • "dtxs": null,
  • "fk_model_id": "md_yvwvbt2i78rgcm",
  • "id": "cl_0j9gv0oi8vjy46",
  • "meta": null,
  • "np": null,
  • "ns": null,
  • "order": 2,
  • "pk": 0,
  • "base_id": "p_01clqvzik3izk6",
  • "pv": 1,
  • "rqd": 0,
  • "system": 0,
  • "title": "Title",
  • "uidt": "SingleLineText",
  • "un": 0,
  • "unique": 0,
  • "updated_at": "2023-03-02 13:14:16",
  • "validate": null,
  • "virtual": null
}

Update View Column

Update a column in a View

path Parameters
viewId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Model for ID

columnId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Column ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
order
number >= 0

The order of the list of views.

Responses

Request samples

Content type
application/json
{
  • "show": 0,
  • "order": 1
}

Response samples

Content type
application/json
1

DB View Share

List Shared Views

List all shared views in a given Table

path Parameters
tableId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Table ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

Create Shared View

Create a shared view in a given View..

path Parameters
viewId
required
string
Example: vw_wtdg2meyig5l4q

Unique View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "meta": { },
  • "password": "123456789"
}

Update Shared View

Update a shared view in a given View..

path Parameters
viewId
required
string
Example: vw_wtdg2meyig5l4q

Unique View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
Meta Model (null) or Meta Model (object) or Meta Model (string) (Meta)
StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)

Responses

Request samples

Content type
application/json
{
  • "meta": { },
  • "password": "123456789"
}

Response samples

Content type
application/json
{
  • "source_id": "ds_g4ccx6e77h1dmi",
  • "created_at": "2023-03-02 17:46:31",
  • "fk_model_id": "md_mhs9z4r2ak98x0",
  • "id": "vw_lg052cnc1c26kf",
  • "is_default": 1,
  • "lock_type": "collaborative",
  • "meta": { },
  • "order": 1,
  • "password": null,
  • "base_id": "p_xm3thidrblw4n7",
  • "show": 1,
  • "show_system_fields": null,
  • "title": "Sheet-1",
  • "type": 3,
  • "updated_at": "2023-03-02 17:46:31",
  • "uuid": null,
  • "view": {
    }
}

Delete Shared View

Delete a shared view in a given View.

path Parameters
viewId
required
string
Example: vw_wtdg2meyig5l4q

Unique View ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true

Base

Get Base info

Get info such as node version, arch, platform, is docker, rootdb and package version of a given base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "Node": "v12.16.1",
  • "Arch": "x64",
  • "Platform": "linux",
  • "Docker": false,
  • "Database": "postgres",
  • "ProjectOnRootDB": false,
  • "RootDB": "postgres",
  • "PackageVersion": "1.0.0"
}

Get UI ACL

Hide / show views based on user role

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

query Parameters
includeM2M
boolean
header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create UI ACL

Hide / show views based on user role

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
Array
string or null
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "msg": "UI ACL has been created successfully"
}

List Bases

List all base meta data

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

Create Base

Create a new base

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
Array of objects (Source Request)

Array of Bases

color
string <= 50 characters

Primary Theme Color

description
string

Base Description

title
required
string [ 1 .. 128 ] characters

Base Title

StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
type
string
Enum: "database" "documentation" "dashboard"
linked_db_project_ids
Array of strings

List of Linked Database Base IDs (only used for Dashboard Projects so far)

external
boolean
Default: false

If true, the base will us an external database else it will use the root database

Responses

Request samples

Content type
application/json
{
  • "sources": [
    ],
  • "color": "#24716E",
  • "created_at": "2023-03-01 14:27:36",
  • "deleted": true,
  • "description": "This is my base description",
  • "id": "p_124hhlkbeasewh",
  • "is_meta": true,
  • "meta": { },
  • "order": 0,
  • "prefix": "nc_vm5q__",
  • "status": "string",
  • "title": "my-base",
  • "external": false
}

Response samples

Content type
application/json
{
  • "sources": [
    ],
  • "color": "#24716E",
  • "created_at": "2023-03-01 14:27:36",
  • "deleted": true,
  • "description": "This is my base description",
  • "id": "p_124hhlkbeasewh",
  • "is_meta": true,
  • "meta": { },
  • "order": 0,
  • "prefix": "nc_vm5q__",
  • "status": "string",
  • "title": "my-base"
}

Duplicate Base Source

Duplicate a base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

sourceId
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Source ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
object
base
object

Responses

Request samples

Content type
application/json
{
  • "excludeData": true,
  • "excludeViews": true,
  • "excludeHooks": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "base_id": "string"
}

Duplicate Base

Duplicate a base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
object
base
object

Responses

Request samples

Content type
application/json
{
  • "excludeData": true,
  • "excludeViews": true,
  • "excludeHooks": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string"
}

Get Base

Get the info of a given base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "sources": [
    ],
  • "color": "#24716E",
  • "created_at": "2023-03-01 14:27:36",
  • "deleted": true,
  • "description": "This is my base description",
  • "id": "p_124hhlkbeasewh",
  • "is_meta": true,
  • "meta": { },
  • "order": 0,
  • "prefix": "nc_vm5q__",
  • "status": "string",
  • "title": "my-base"
}

Delete Base

Delete the given base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true

Update Base

Update the given base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
color
string <= 50 characters

Primary Theme Color

Meta Model (null) or Meta Model (object) or Meta Model (string) (Meta)
title
string [ 1 .. 128 ] characters

Base Title

StringOrNull Model (string) or StringOrNull Model (null) (StringOrNull)
linked_db_project_ids
Array of strings

List of Linked Database Base IDs (only used for Dashboard Projects so far)

Responses

Request samples

Content type
application/json
{
  • "color": "#24716E",
  • "meta": null,
  • "title": "My Base"
}

Response samples

Content type
application/json
1

Base user meta update

path Parameters
baseId
required
string
Request Body schema: application/json
Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)
order
number

The order among the bases

Bool Model (integer) or Bool Model (boolean) or Bool Model (null) (Bool)

Responses

Request samples

Content type
application/json
{
  • "starred": true,
  • "order": 1,
  • "hidden": true
}

Get Base Shared Base

Get Base Shared Base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  • "url": "http://example.com",
  • "roles": "viewer"
}

Delete Base Shared Base

Delete Base Shared Base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true

Create Base Shared Base

Create Base Shared Base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
password
string >= 8 characters

Password to protect the base

roles
string
Enum: "commenter" "editor" "viewer"

The role given the target user

Responses

Request samples

Content type
application/json
{
  • "roles": "editor",
  • "password": "password123"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "roles": "string"
}

Update Base Shared Base

Update Base Shared Base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
password
string >= 8 characters

Password to protect the base

roles
string
Enum: "commenter" "editor" "viewer"

The role given the target user

Responses

Request samples

Content type
application/json
{
  • "password": "password123",
  • "roles": "editor"
}

Response samples

Content type
application/json
{
  • "uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  • "url": "http://example.com",
  • "roles": "viewer"
}

Base Cost

Calculate the Base Cost

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{ }

Sync Meta

Synchronise the meta data difference between NC_DB and external data sources

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "msg": "The meta has been synchronized successfully"
}

Meta Diff

Get the meta data difference between NC_DB and external data sources

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Empty & Null Filter

Check if a base contains empty and null filters. Used in Show NULL and EMPTY in Filter in Base Setting.

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
null

List Audits in Base

List all audit data in the given base

path Parameters
baseId
required
string (Id) [ 0 .. 20 ] characters
Examples: string

Unique Base ID

query Parameters
offset
integer >= 0
limit
integer <= 1
sourceId
string
header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pageInfo": {
    }
}

Utils

List Comments in Audit

List all comments

query Parameters
row_id
required
string
Example: row_id=10

Row ID

fk_model_id
required
string (Id) [ 0 .. 20 ] characters
Examples: fk_model_id=string

Foreign Key to Model

comments_only
boolean
Example: comments_only=true

Is showing comments only?

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

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

Comment Rows

Create a new comment in a row. Logged in Audit.

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
description
string

Description for the target row

fk_model_id
required
string

Foreign Key to Model

row_id
required
string

Row ID

Responses

Request samples

Content type
application/json
{
  • "description": "This is the comment for the row",
  • "fk_model_id": "md_ehn5izr99m7d45",
  • "row_id": "3"
}

Response samples

Content type
application/json
{
  • "user": "w@nocodb.com",
  • "row_id": "1",
  • "fk_model_id": "md_5mipbdg6ketmv8",
  • "op_type": "COMMENT",
  • "description": "qq",
  • "base_id": "p_63b4q0qengen1x",
  • "id": "adt_vx58jpp0loo8qy"
}

Update Comment in Audit

Update comment in Audit

path Parameters
auditId
required
string
Example: adt_zlskd6rlf3liay

Audit ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
description
string

Description for the target row

Responses

Request samples

Content type
application/json
{
  • "description": "This is the comment for the row"
}

Response samples

Content type
application/json
1

Count Comments

Return the number of comments in the given query.

query Parameters
ids
required
any

Comment IDs

fk_model_id
required
string (ID Model) [ 0 .. 20 ] characters
Examples: fk_model_id=string

Foreign Key to Model

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Audit Row

Update Audit Row

path Parameters
rowId
required
any
Example: 1

Unique Row ID

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
column_name
string

Column Name

fk_model_id
string

Foreign Key to Model

row_id
string

Row ID

prev_value
any

The previous value before the action

value
any

The current value after the action

Responses

Request samples

Content type
application/json
{
  • "column_name": "baz",
  • "fk_model_id": "md_ehn5izr99m7d45",
  • "row_id": "1",
  • "prev_value": "foo",
  • "value": "bar"
}

Response samples

Content type
application/json
{
  • "user": "w@nocodb.com",
  • "row_id": "1",
  • "fk_model_id": "md_5mipbdg6ketmv8",
  • "op_type": "COMMENT",
  • "description": "Table Sheet-1 : field Column A got changed from foo to bar",
  • "base_id": "p_63b4q0qengen1x",
  • "id": "adt_vx58jpp0loo8qy"
}

Test DB Connection

Test the DB Connection

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
client
string
Enum: "mssql" "mysql" "mysql2" "oracledb" "pg" "snowflake" "sqlite3"

DB Type

object

Responses

Request samples

Content type
application/json
{
  • "client": "mysql2",
  • "connection": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "",
  • "data": { }
}

utils-select-query

Request Body schema: application/json
Schema not provided

Responses

Response samples

Content type
application/json
null

Get App Info

Get the application info such as authType, defaultLimit, version and etc.

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
{
  • "authType": "jwt",
  • "baseHasAdmin": true,
  • "firstUser": false,
  • "type": "rest",
  • "googleAuthEnabled": false,
  • "githubAuthEnabled": false,
  • "oneClick": false,
  • "connectToExternalDB": true,
  • "version": "0.105.3",
  • "defaultLimit": 25,
  • "ncMin": false,
  • "teleEnabled": false,
  • "auditEnabled": true,
  • "ncSiteUrl": "http://localhost:8080",
  • "ee": false,
  • "ncAttachmentFieldSize": 20971520,
  • "ncMaxAttachmentsAllowed": 10,
  • "isCloud": false,
  • "automationLogLevel": "OFF"
}

Axios Request

Generic Axios Call

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Get Cache

Get All K/V pairs in NocoCache

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Delete Cache

Delete All K/V pairs in NocoCache

header Parameters
xc-auth
string

Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN.

Responses

Response samples

Content type
application/json
true