--- title: "Cato API - EntityLookup" slug: "cato-api-entitylookup" updated: 2026-07-30T01:43:28Z published: 2026-07-30T01:43:28Z canonical: "knowledge.catonetworks.com/cato-api-entitylookup" --- > ## Documentation Index > Fetch the complete documentation index at: https://knowledge.catonetworks.com/llms.txt > Use this file to discover all available pages before exploring further. # Cato API - EntityLookup Recomendamos fortemente que, antes de começar a usar a Cato API, revise a [Política de Suporte para a Cato API](/v1/docs/support-policy-for-the-cato-api). ## Visão geral do entityLookup A consulta entityLookup trabalha com entidades da Aplicativo de Gerenciamento Cato, como sites e usuários VPN. A consulta pode ajudar a procurar um nome de entidade para devolver o ID específico e, automaticamente, extrair uma lista de entidades na conta. Cada entidade é retornada com informações relevantes adicionais, como a data de criação e a descrição. Para contas de revendedores, você pode criar chaves de API separadas dentro de cada conta de cliente que está se conectando à API Cato. Para mais informações sobre limitação de taxa e a consulta entityLookup API, consulte [Entendendo a Limitação de Taxa da Cato API](/v1/docs/understanding-cato-api-rate-limiting). ## Detalhes dos Campos do entityLookup Estes são os detalhes que os campos auditFeed podem mostrar para a consulta: - itens - o campo de itens contém os dados de cada entidade - total - número total de entidades retornadas para esta consulta ## Itens do entityLookup Os campos EntityInfo mostram os dados de cada entidade, incluindo: - entidade - mostra o **id**, **nome** do Aplicativo de Gerenciamento Cato, e o **tipo** de entidade geralmente site ou vpnUser - descrição - descrição da entidade do Aplicativo de Gerenciamento Cato - helperFields - informações e dados adicionais relevantes sobre a entidade ## Total do entityLookup O campo Total mostra o número total de entidades para sua conta no Aplicativo de Gerenciamento Cato. O valor deste campo não muda durante a paginação do retorno da API, e pode ajudar a compará-lo facilmente ao número total de registros recuperados. ## Argumentos para o entityLookup Estes são os argumentos que você pode passar e definir as entidades que são retornadas pela consulta: - IDs da conta - IDs da conta, para múltiplas contas, insira os IDs como um array (argumento obrigatório) - tipo - retorna entidades que correspondem ao tipo, por exemplo o **site** ou **vpnUser** (argumento obrigatório) - limite - número máximo de entidades retornadas para esta consulta (valor padrão é 50) - de - de acordo com o índice de entradas, inicie a consulta a partir desta entidade específica - de pesquisa - filtra o retorno de acordo com este valor - IDs de entidade - IDs de entidade, para múltiplas entidades, insira os IDs como um array - ordenar - define como as entidades que a consulta retorna são ordenadas ## Argumento accountIDs do entityLookup Insira um ou mais IDs de conta para os dados que a consulta retorna. Este ID de conta é exibido na página Administração > Informações Gerais. O argumento accountIDs é obrigatório para a consulta. ## Argumento tipo do entityLookup O argumento tipo define os dados da entidade que a consulta retorna. Estes são os valores suportados para o argumento tipo: **site**, **vpnUser**, e **admins**. O argumento tipo é obrigatório para a consulta. Consulte o esquema para os itens enum para cada valor. ## Argumento limite do entityLookup O argumento limite define o número máximo de entidades que a consulta retorna. Se você não especificar o argumento limite, a consulta é limitada a 50 entidades. Cada consulta pode retornar no máximo 1000 entidades. ## Argumento de do entityLookup O argumento de define qual entidade iniciar a consulta. Por exemplo, se uma conta tiver 100 usuários VPN, defina para **60** para mostrar apenas os últimos 40 usuários VPN. O primeiro item na consulta é 0. Então, se você quiser mostrar apenas a partir do item 20, defina como 19. ## Argumento de pesquisa do entityLookup O argumento de pesquisa filtra a consulta para retornar apenas nomes de entidades correspondentes. O argumento de pesquisa é um valor de string. ## Argumento de IDs de entidade do entityLookup O argumento IDs da entidade retorna apenas entidades que correspondem aos IDs. ## Argumento de ordenação do entityLookup O argumento de ordenação permite que você ordene os dados de acordo com o id ou nome para as entidades, em ordem ascendente ou descendente. - campo - use **nome** ou **id** como o valor do campo - ordem - ordene os resultados em ordem ascendente (**asc**) ou descendente (**dsc**) Por exemplo, para ordenar os resultados em ordem ascendente (a-z) de acordo com o nome, use este argumento: `sort:{field"name", order:asc}` ## Argumento de pai do entityLookup O argumento pai é usado para consultar entidades com hierarquia, onde você precisa fornecer a entidade e seu pai. Por exemplo, para o tipo `networkInterface`, você precisa inserir o pai com estes valores: **id** , **tipo** site. ## Consultas de Exemplos do entityLookup Esta seção tem exemplos de consultas do entityLookup. ### Consultar Todos os Sites na Conta **Script Exemplo do Postman** ```plaintext query entityLookup ($accountID: ID!, $type: EntityType!, $search: String) {    entityLookup (accountID: $accountID, type: $type, search: $search) {        items {            entity {                id                name            }        }    } } ``` **Variáveis do GraphQL** ```plaintext {    "ID da Conta": "26",    "tipo": "site" } ``` ### Pesquisar por Site Usando o Nome do Site **Script Exemplo do Postman** ```plaintext query entityLookup ($accountID: ID!, $type: EntityType!, $search: String) {    entityLookup (accountID: $accountID, type: $type, search: $search) {        items {            entity {                id                name            }        }    } } ``` **Variáveis do GraphQL** ```plaintext {    "ID da Conta": "26",    "tipo": "site",    "search": "MeuSite" } ``` ### Pesquisar por networkInterface Incluindo Argumento de pai **Script Exemplo do Postman** ```plaintext query entityLookup ($accountID: ID!, $type: EntityType!, $parent: EntityInput!) {    entityLookup (accountID: $accountID, type: $type, parent: $parent) {        items {            entity {                id                name                type            }            description            helperFields            }        }    }} ``` **Variáveis do GraphQL** ```plaintext {    "ID da Conta": "26",    "tipo": "networkInterface",    "pai": {        "id": 52180,        "tipo": "site"    } } ```