Compreender a visão geral da API de endpoints seguros

Problema

Este documento descreve o uso da API do Cisco Secure Endpoints (SE).

Resolução

Para usar a API SE, crie uma credencial de API no console SE.

Os exemplos neste artigo usam um endpoint do Windows 7.

1. Faça login no console e navegue até Contas > Credenciais de API.

1. Clique em Nova Credencial de API para criar um novo conjunto de chaves.

2. Informe um nome de Aplicação. Selecione o Escopo de Somente leitura ou Leitura e gravação.

Note: Uma credencial de API com escopo de leitura e gravação pode fazer alterações na configuração do Cisco SE que podem causar problemas significativos com seus endpoints.  Algumas das proteções de entrada incorporadas no Cisco SE Console não se aplicam à API.

3. Clique no botão Criar. A página Detalhes da Chave de API é exibida. Salve essas informações porque algumas delas não estarão disponíveis depois que você sair da tela.

Note: As credenciais de API (API Client ID & API Key) permitem que outros programas recuperem e modifiquem seus dados do Cisco SE. É funcionalmente equivalente a um nome de usuário e senha, e deve ser tratado como tal.

Caution: Suas credenciais de API são exibidas apenas uma vez. Se você perder as credenciais, precisará gerar novas.

Exclua as credenciais de API para um aplicativo se você suspeitar que elas foram comprometidas e crie uma nova.  Quando você exclui uma credencial de API, ela bloqueia o cliente que usa as antigas, atualizando-as com as novas credenciais.

Ambiente

• Ponto de extremidade testado: Ponto de extremidade do Windows 7.
• Produto: Cisco SE
• Acesso: Acesso de console com permissão para criar e excluir credenciais de API.
• API: SE API Versão 3, Versão 1 e Versão 0 (exemplos usam a Versão 1).
• Ferramenta de cliente: a curva instalada no sistema usada para executar solicitações de API.

Atualmente, há três versões da API SE: Versão 3 , Versão 1 e Versão 0. A Versão 3 fornece funcionalidade adicional em comparação com a Versão 1 e Versão 0. A documentação da API da Versão 3 está disponível neste link. Use a Versão 3 para recuperar estas informações:

• Logs de auditoria
• Controle de dispositivo
• Dispositivos
• Exclusões
• Firewall do host
• COI
• MSSP
• Organizações
• Políticas
• Computadores
• Vulnerabilidades

Clique no comando relevante no documento para ver exemplos de seu uso. 

Exemplo e Divisão de Comando de API

Cada comando de API contém informações semelhantes e é dividido em um comando curl como este:

curl -o yourfilename.json https://client_id:api_key@api.example.com/v1/whatyouwanttodo

Quando você usa o comando curl com a opção -o, ele permite que você salve a saída em um arquivo. Nesse caso, o nome do arquivo é "yourfilename.json". 

Tip: Mais informações sobre arquivos .json estão disponíveis no site JSON.

A próxima parte do comando curl especifica as credenciais antes do símbolo @. Após gerar as credenciais da API, use a ID do cliente da API e a chave da API nesta parte da URL.

https://client_id:api_key@

Adicione o número da versão e a ação a ser executada. Para este exemplo, execute GET /v1/computers. O comando completo se parece com o seguinte:

curl -o computers.json https://client_id:api_key@api.example.com/v1/computers

Após executar o comando, um arquivo computers.json é exibido no diretório em que o comando foi iniciado.

Note: O Curl está disponível online e compilado para muitas plataformas, incluindo o Windows (geralmente você deseja usar a versão Win32 - Generic).

Quando você abre o arquivo, todos os dados aparecem em uma única linha. Para visualizá-lo em um layout formatado, instale um plug-in de navegador que formata JSON e abra o arquivo em um navegador. Esta saída mostra informações para seus computadores, como:

connector_guid, nome do host, ative, links, connector_version, operating_system, internal_ips, external_ip, group_guid, network_addresses, policy guid e nome da política.

{
version: "v1.0.0",
metadata: {
links: {
self: "https://api.amp.cisco.com/v1/computers"
},
results: {
total: 4,
current_item_count: 4,
index: 0,
items_per_page: 500
}
},
data: [
{
connector_guid: "abcdef-1234-5678-9abc-def123456789",
hostname: "host.example.com",
active: true,
links: {
computer: "https://api.amp.cisco.com/v1/computers/abcdef-1234-5678-9abc-def123456789",
trajectory: "https://api.amp.cisco.com/v1/computers/abcdef-1234-5678-9abc-def123456789/trajectory",
group: "https://api.amp.cisco.com/v1/groups/abcdef-1234-5678-9abc-def123456789"
},
connector_version: "4.4.2.10200",
operating_system: "Windows 7, SP 1.0",
internal_ips: [
"10.1.1.2",
" 192.168.1.2",
" 192.168.2.2",
" 169.254.245.1"
],
external_ip: "192.0.2.10",
group_guid: "abcdef-1234-5678-9abc-def123456789",
network_addresses: [
{
mac: "ab:cd:ef:01:23:45",
ip: "10.1.1.2"
},
{
mac: "bc:de:f0:12:34:56",
ip: "192.168.1.2"
},
{
mac: "cd:ef:01:23:45:67",
ip: "192.168.2.2"
},
{
mac: "de:f0:12:34:56:78",
ip: "169.254.245.1"
}
],
policy: {
guid: "abcdef-1234-5678-9abc-def123456789",
name: "Protect Policy"
}
}
]
}

Este exemplo mostra uma solicitação de API básica. Agora você pode usar outras opções de comando para recuperar e modificar dados em seu ambiente.

Conteúdo relacionado

• Documentação da API do Cisco AMP para endpoints
• Suporte Técnico e Documentação - Cisco Systems

Histórico de revisões

Revisão	Data de publicação	Comentários
2.0	26-Oct-2026	Recertificação
1.0	20-Mar-2017	Versão inicial