Update Diagram

curl -X POST https://api.chartdb.io/api/update_diagram/123456789 \
  -H "Authorization: Bearer ch_123456789" \
  -H "Content-Type: application/json" \
  -d '{
    "diagram_name": "Updated E-commerce Diagram",
    "json_metadata": {
      "fk_info": [],
      "pk_info": [],
      "columns": [],
      "indexes": [],
      "tables": [],
      "views": [],
      "database_name": "postgres",
      "version": ""
    }
  }'

{
  "status": "success",
  "message": "Diagram updated successfully"
}

POST

api

update_diagram

{diagram_id}

curl -X POST https://api.chartdb.io/api/update_diagram/123456789 \
  -H "Authorization: Bearer ch_123456789" \
  -H "Content-Type: application/json" \
  -d '{
    "diagram_name": "Updated E-commerce Diagram",
    "json_metadata": {
      "fk_info": [],
      "pk_info": [],
      "columns": [],
      "indexes": [],
      "tables": [],
      "views": [],
      "database_name": "postgres",
      "version": ""
    }
  }'

{
  "status": "success",
  "message": "Diagram updated successfully"
}

The Update Diagram endpoint allows you to modify an existing database diagram’s properties.

Authorizations

string

required

Bearer authentication header of the form Bearer <api_key>, where <api_key> is your auth token from ChartDB starts with ch_. Tokens are per diagram: generate one from the diagram’s Connect panel. A token only works for the diagram it was created for.

Path Parameters

string

required

The unique identifier of the diagram.

Request Body

string

New name for the diagram.

object

Updated diagram settings in JSON format. (See Examples for more information)

curl -X POST https://api.chartdb.io/api/update_diagram/123456789 \
  -H "Authorization: Bearer ch_123456789" \
  -H "Content-Type: application/json" \
  -d '{
    "diagram_name": "Updated E-commerce Diagram",
    "json_metadata": {
      "fk_info": [],
      "pk_info": [],
      "columns": [],
      "indexes": [],
      "tables": [],
      "views": [],
      "database_name": "postgres",
      "version": ""
    }
  }'

{
  "status": "success",
  "message": "Diagram updated successfully"
}

Getting Started

Diagrams

Authorizations

Path Parameters

Request Body

​Authorizations

​Path Parameters

​Request Body

Authorizations

Path Parameters

Request Body