Skip to content

Alterar um Tenant​

PUT
/tenants

Altera um Tenant do Cliente, identificado por id. Só os campos enviados mudam, mas ativo é obrigatório em toda chamada. Mudança em development_variables fica no histórico do Tenant.

ativo: false tranca o login de todos os usuários e pode ser revertido. O efeito na cobrança está em Recursos e cobrança.

Variáveis globais

development_variables aceita objeto {"NOME": "valor"} ou lista, e substitui a lista inteira: variável que não vier é removida do tenant.

Uma variável que continua guarda o que você não mandou dela: descrição, proteção e valores por agente. Trocar o valor de uma protegida mantém a proteção.

Na lista, cada item aceita key, value, description, is_secret e agent_overrides. Variável protegida mandada sem value mantém o valor gravado.

[
  {"key": "DB_HOST", "value": "10.0.0.5",
   "agent_overrides": [{"tokenId": 852, "value": "10.9.0.7"}]},
  {"key": "DB_PWD", "is_secret": true}
]

agent_overrides dá um valor próprio a um Agente ETL: o agente 852 recebe 10.9.0.7, e os outros recebem 10.0.0.5. tokenId é o id do agente, o mesmo de agent.id na resposta da criação, e o agente precisa estar ligado ao tenant. Item sem agent_overrides mantém os valores por agente gravados; lista vazia remove todos.

Campos

Campo Descrição
nome Nome do tenant
ativo false tranca o login; true libera
dominio Domínio de acesso
development_variables Variáveis globais do ETL
config Configurações do tenant

Mensagens de erro

Mensagem Causa
Tenant not found ID não existe ou não pertence ao cliente
Invalid development_variables format... Variável sem key ou com value nulo
Invalid development_variables agent_overrides... agent_overrides fora do formato [{tokenId, value}]
Agente ETL ... não está ligado a este tenant. tokenId de agente que não atende o tenant

Autorizações​

clientBearerAuth

Token de acesso do cliente

TipoHTTP (bearer)

Corpo da Requisição​

application/json
JSON

Respostas​

Tenant alterado

application/json
JSON

Playground​

Autorização
Corpo

Exemplos​

Desenvolvido por VitePress OpenAPI