Mensagens REST da Qualys

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 3 min. de leitura

    • As mensagens REST da Qualys são usadas para fazer chamadas para a APIda Qualys para buscar os dados de conformidade.

    As seguintes mensagens REST são enviadas com o sistema de base.

    Mensagem REST de políticas de PC da Qualys

    A mensagem REST de políticas de PC da Qualys recupera dados de política da Qualys. As mudanças no registro do método de mensagem REST afetam a solicitação feita à Qualys para recuperar informações de política.

    Tabela 1. Parâmetros de mensagem REST de políticas de PC da Qualys
    Nome do Parâmetro Valor Descrição
    ação lista Indica o tipo de operação solicitada.

    Parâmetro obrigatório.
    detalhes Todos

    Indica o nível de detalhe mostrado para as políticas recuperadas.

    É seguro modificar de acordo com seus requisitos.

    Mensagem REST de controles de PC da Qualys

    A mensagem REST de Controles de PC da Qualys recupera informações de controles de conformidade para diferentes IDs de controle da Qualys.

    Tabela 2. Parâmetros de mensagem REST de controles de PC da Qualys
    Nome do Parâmetro Valor Descrição
    ação lista Indica o tipo de operação solicitada.

    Parâmetro obrigatório.
    detalhes Todos

    Indica o nível de detalhe mostrado para os controles recuperados.

    É seguro modificar de acordo com seus requisitos.

    Mensagem REST de detalhe das políticas de PC da Qualys

    A mensagem REST de detalhes das políticas de PC da Qualys recupera os detalhes completos da política, como tecnologias e seções.

    Tabela 3. Parâmetros de mensagem REST de detalhe de políticas de PC da Qualys
    Parâmetro Valor Descrição
    ação lista Indica o tipo de operação que está sendo solicitada.

    Parâmetro obrigatório.
    mostrar_usuário_controles Booliano
    • Defina como 1 para incluir controles definidos pelo usuário (UDCs) na saída XML.

    • Quando não especificado, os UDCs não são incluídos.

    Este é um parâmetro opcional. É seguro modificar de acordo com seus requisitos.
    mostrar_apêndice Booliano

    (Opcional) Defina como 1 para mostrar a seção do apêndice na saída XML. Quando não especificado.

    Mensagem REST de resultados de PC da Qualys

    A mensagem de descanso Resultados de PC da Qualys recupera registros de postura de conformidade da Qualys.

    Tabela 4. Parâmetros de mensagem REST de resultados de PC da Qualys
    Campo de origem Valor Descrição
    ação lista Indica o tipo de operação solicitada.

    Parâmetro obrigatório. Mudanças não são recomendadas.
    mostrar_extended_evidence Booliano
    • Defina como 1 para mostrar as informações de evidência estendida na saída.
    • Definido como 0 ou quando não especificado, as informações de evidência estendida não são mostradas na saída.
    Nota:
    • Você não pode especificar show_extended_evidence=1 na mesma solicitação que hide_evidence=1. Isso resulta em um erro. A evidência estendida faz parte dos dados de evidência e é mostrada somente quando os dados de evidência são mostrados.
    • Este parâmetro não é enviado com o sistema de base.
    causa_de_falha Booliano

    Se você aprovar "1", a Qualys retornará a causa da falha.

    Se você passar '0', a Qualys não retornará esses atributos.

    Nota:
    Este parâmetro não é enviado com o sistema de base.
    policy_id Mostra registros de informações de postura de conformidade para uma política especificada. É necessário um ID de política válido.
    detalhes Todos

    Indica o nível de detalhe mostrado para posturas recuperadas.

    É seguro modificar de acordo com seus requisitos.
    mostrar_remediação_info (Opcional) Defina como 1 para mostrar informações de correção na saída XML ou CSV. Por padrão, a saída não inclui as informações de correção. Quando não especificado, as informações de correção não são incluídas na saída.

    Mensagem de REST de integração de host de política de PCRS da Qualys

    A integração de host da política PCRS da Qualys recupera dados de host da Qualys e os processa em sua instância.

    Tabela 5. Parâmetros de mensagem REST de integração de host de política de PCRS da Qualys
    Nome do Parâmetro Valor Descrição
    policyId ${lastRunDatetime}

    IDs de política para avaliação de conformidade.

    Integração de resultados de testes de PCRS da Qualys

    A tabela mostra os parâmetros de solicitação que são enviados.

    Tabela 6. Parâmetros de mensagem REST de integração de resultados de testes de PCRS da Qualys
    Nome do Parâmetro Valor Descrição
    evidência necessária ${lastRunDatetime}
    • O valor padrão é 0, o que indica que os dados de evidência não serão recuperados para a postura do host.
    • Defina o valor como 1 para recuperar os dados de evidência.
      Nota:
      Alterar o valor para 1 aumenta o tempo necessário para buscar dados de postura.
    compactaçãonecessária
    • O valor padrão é 1, o que indica que a saída será compactada.
    • Defina o valor como 0 se você não quiser que os dados sejam compactados.
      Nota:
      Não compactar os dados aumenta o tempo necessário para buscar dados de postura.