POST
Bearer/database
Cadastra a conexão com um banco externo. O pool de conexões é aberto na hora (timeout de 3 s) e a configuração é salva.
Entrada · corpo JSON
- keystringobrig.: sim
Nome único da conexão. Os steps o usam em command.database.
- driverenumobrig.: sim
oracle, postgres, mysql ou sqlserver.
- hoststringobrig.: sim
Endereço do servidor do banco (IP ou DNS).
- portnumberobrig.: sim
Porta do banco, por exemplo 1521.
- databasestringobrig.: sim
Nome do banco, schema ou service name (Oracle).
- userstringobrig.: sim
Usuário de acesso.
- passwordstringobrig.: sim
Senha. Nunca é devolvida nas respostas.
- pool.maxOpenConnsnumberobrig.: não
Máximo de conexões abertas. 0 = ilimitado.
- pool.maxIdleConnsnumberobrig.: não
Máximo de conexões ociosas.
Campo
Tipo
Obrig.
Descrição
key
string
sim
Nome único da conexão. Os steps o usam em command.database.
driver
enum
sim
oracle, postgres, mysql ou sqlserver.
host
string
sim
Endereço do servidor do banco (IP ou DNS).
port
number
sim
Porta do banco, por exemplo 1521.
database
string
sim
Nome do banco, schema ou service name (Oracle).
user
string
sim
Usuário de acesso.
password
string
sim
Senha. Nunca é devolvida nas respostas.
pool.maxOpenConns
number
não
Máximo de conexões abertas. 0 = ilimitado.
pool.maxIdleConns
number
não
Máximo de conexões ociosas.
{
"key": "MINHA_BASE",
"driver": "oracle",
"host": "db.empresa.com.br",
"port": 1521,
"database": "ORCL",
"user": "usuario",
"password": "••••••",
"pool": {
"maxOpenConns": 10,
"maxIdleConns": 2
}
}{
"key": "MINHA_BASE",
"driver": "oracle",
"host": "db.empresa.com.br",
"port": 1521,
"database": "ORCL",
"user": "usuario",
"pool": {
"maxOpenConns": 10,
"maxIdleConns": 2
}
}Erros: 400 para key duplicada, driver inválido, falha ao conectar ou token ausente/inválido (o N-Agent responde 400, não 401).