/connections/{id}

Atualizar uma conexao

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Atualização de uma Conexão

Utilize esta rota para atualizar algumas configurações de uma conexão

Como utilizar

Identificador único da sua conexão

Para encontrar o id de sua conexão você pode utilizar a listagem de conexões ou a página de detalhes de uma conexão, como na Figura 1.

Figura 1 - Captura de tela mostrando a página de detalhes de uma conexão na plataforma da Dadosfera

Figura 1 - Captura de tela mostrando a página de detalhes de uma conexão na plataforma da Dadosfera

Parâmetros

Utilize o id da sua conexão no caminho da requisição.

O corpo da requisição aceita as seguintes propriedades:

  • name: novo nome para a conexão. Omitir se não for alterar
  • description: nova descrição da conexão. Omitir se não for alterar
  • network_config_id: id da VPN a ser utilizada nesta conexão. Omitir se não for alterar
  • properties: Objeto contendo todas as propriedades que serão alteradas

Payload example

{
  "name": "Updated Connection Name",
  "description": "Updated description",
  "network_config_id": "vpn-config-123",
  "properties": {
    "credentials_type": "basic_auth",
    "plugin": "postgresql",
    "host": "new-db.example.com",
    "port": "5432",
    "username": "admin",
    "password": "new-password",
    "database": "production_db"
  }
}

Error scenarios

CodeErrorDescription
401UnauthenticatedInvalid or missing access-token header
403ForbiddenUser does not have the required permissions
404Not FoundThe connection with the specified ID was not found
500Internal Server ErrorUnknown server error
Path Params
string
required
Body Params
string
required
string
required
string
properties
object
required
Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json