Skip to main content
PATCH
/
api
/
v1
/
tables
/
{id}
cURL
curl --request PATCH \
  --url https://api.nekt.ai/api/v1/tables/{id}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "database_id": "<string>",
  "s3_path": "<string>",
  "is_scd_type_2": true,
  "primary_keys": [
    "<string>"
  ],
  "number_of_rows": 123,
  "size_in_bytes": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "folder": "<string>",
  "layer": "<string>",
  "description": "<string>",
  "type": "GENERAL",
  "hidden": true,
  "delta_log_retention_duration": -1,
  "delta_partitions": [
    "<string>"
  ],
  "delta_z_order_columns": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.nekt.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Path Parameters

id
string<uuid>
required

A UUID string identifying this Table.

Body

description
string | null

Response

200 - application/json
id
string<uuid>
required
read-only
name
string
required
read-only
slug
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
database_id
string
required
read-only
s3_path
string
required
read-only
is_scd_type_2
boolean
required
read-only
primary_keys
string[]
required
read-only
Maximum string length: 256
number_of_rows
integer | null
required
read-only
size_in_bytes
integer | null
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
folder
string
required
read-only

Folder of the table (Expandable)

layer
string
required
read-only

Layer of the table (Expandable)

description
string | null
type
enum<string>
  • GENERAL - General
  • DIMENSION - Dimension
  • FACT - Fact
Available options:
GENERAL,
DIMENSION,
FACT
hidden
boolean
delta_log_retention_duration
integer | null
Required range: -2147483648 <= x <= 2147483647
delta_partitions
string[] | null
Maximum string length: 1024
delta_z_order_columns
string[] | null
Maximum string length: 1024