Get a table's SQL definition

GET

/api/workspaces/{workspaceId}/databases/{id}/table-definition

const url = 'http://localhost:8080/api/workspaces/example/databases/example/table-definition';
const options = {method: 'GET', headers: {cookie: 'auth_session=<auth_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/workspaces/example/databases/example/table-definition \
  --cookie auth_session=<auth_session>

Authorizations

cookieAuth
bearerAuth

Parameters

Path Parameters

workspaceId

required

string

required

string

Query Parameters

table

string

schema

string

database

string

Responses

2XX

Successful response

application/json

object

success

Whether the request succeeded.

boolean

data

Endpoint-specific response payload.

message

string

error

string

Example

{
  "message": "Operation completed",
  "error": "Error message"
}

4XX

Invalid request

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}