Alternar estado de uma configuração de alerta em um projeto

REMENDO /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}

Habilita ou desabilita a configuração de alerta especificada no projeto indicado. O recurso habilita a configuração de alerta especificada se estiver habilitada no momento. O recurso desativa a configuração de alerta especificada se estiver desativada no momento. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função Proprietário da organização ou Proprietário do projeto.

NOTA: esse ponto de extremidade atualiza apenas o estado habilitado/desabilitado da configuração de alerta. Para atualizar mais do que apenas essa configuração, consulte Atualizar uma configuração de alerta.

Este recurso permanece sob revisão e pode mudar.

Atualizar uma configuração de alerta

parâmetros de caminho

  • groupId string Obrigatório

    Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

    AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

  • alertConfigId string Obrigatório

    String exclusiva de 24 dígitos hexadecimais que identifica a configuração de alerta que acionou esse alerta.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

  • envelope booleano

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

    O valor padrão é false.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint
application/vnd.atlas.2023-01-01+json

corpo, corpo Obrigatório

Habilita ou desabilita a configuração de alerta especificada no projeto indicado.

  • habilitado booleano

    Sinalizador que indica se a configuração de alerta especificada deve ser habilitada ou desabilitada no projeto especificado.

Respostas

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    Um dos seguintes: