POST /teams/{teamId}/flowcharts/import-db-schema

Introspeciona schema de DB e devolve FlowDocument.

Access: Team member
Service: https://api-flow.axuz.net

Accepted authentication

sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

Suporta MySQL + Postgres. Guardas SSRF em IPs privados. 501 quando o build não tem dialect drivers linkados.

Parameters

Name	In	Type	Required	Description
`teamId`	path	`string`	yes

Request body

application/json · Required

Name	Type	Required	Description
`dialect`	`string`	yes	enum: `"mysql", "postgres"`
`host`	`string`	yes
`port`	`integer`	no
`db`	`string`	yes
`user`	`string`	yes
`password`	`string<password>`	no

{
  "dialect": "mysql",
  "host": "string",
  "port": 1,
  "db": "string",
  "user": "string",
  "password": "string"
}

Responses

200
Schema convertido em FlowDocument.

Name	Type	Required
`nodes`	`array<FlowNode>`	yes
`nodes[].id`	`string`	yes
`nodes[].type`	`string`	yes
`nodes[].position`	`FlowXY`	yes
`nodes[].position.x`	`number`	yes
`nodes[].position.y`	`number`	yes
`nodes[].width`	`integer \| null`	no
`nodes[].height`	`integer \| null`	no
`nodes[].parentNode`	`string`	no
`nodes[].extent`	`string`	no
`nodes[].data`	`object`	yes
`nodes[].style`	`object`	no
`edges`	`array<FlowEdge>`	yes
`edges[].id`	`string`	yes
`edges[].source`	`string`	yes
`edges[].target`	`string`	yes
`edges[].type`	`string`	no
`edges[].data`	`object`	no

400
Payload inválido.

Name	Type	Required	Description
`error`	`string`	yes

401
JWT ausente/expirado.

Name	Type	Required	Description
`error`	`string`	yes

403
Host resolve pra IP privado (SSRF guard).

Name	Type	Required	Description
`error`	`string`	yes

429
Limite de requisições excedido.

Name	Type	Required	Description
`error`	`string`	yes

500
Erro interno. Tente de novo com backoff; reporte o `X-Request-Id`.

Name	Type	Required	Description
`error`	`string`	yes

501
Dialect drivers não linkados no build.

Name	Type	Required	Description
`error`	`string`	yes

502
Falha ao conectar / introspectar DB alvo.

Name	Type	Required	Description
`error`	`string`	yes

Examples

"Try it" is turned off in this reference. Use the examples with your test credential.

curl

curl -sS -X POST 'https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/import-db-schema' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"dialect":"mysql","host":"string","port":1,"db":"string","user":"string","password":"string"}'

Node.js

const res = await fetch("https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/import-db-schema", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "dialect": "mysql",
    "host": "string",
    "port": 1,
    "db": "string",
    "user": "string",
    "password": "string"
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "POST",
    "https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/import-db-schema",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "dialect": "mysql",
        "host": "string",
        "port": 1,
        "db": "string",
        "user": "string",
        "password": "string",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())

POST /teams/{teamId}/flowcharts/import-db-schema

Accepted authentication

Parameters

Request body

Responses

200 Schema convertido em FlowDocument.

400 Payload inválido.

401 JWT ausente/expirado.

403 Host resolve pra IP privado (SSRF guard).

429 Limite de requisições excedido.

500 Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

501 Dialect drivers não linkados no build.

502 Falha ao conectar / introspectar DB alvo.