User Guide

Synapse-Apollo User Guide

Synapse-Apollo adds new Storm commands to allow you to query the Apollo.io API using your existing API key.

Getting Started

Check with your Admin to enable permissions and find out if you need a personal API key.

Examples

Setting your personal API key

To set-up a personal use API key:

> apollo.setup.apikey --self myapikey
Setting Synapse-Apollo API key for the current user.

Generate and enrich an org node by FQDN

You can use the apollo.genorg command to create and enrich an ou:org node by inet:fqdn:

> inet:fqdn=vertex.link | apollo.genorg --yield
ou:org=df89089b840fa14f40e6e6c27c6519ee
        .created = 2024/12/20 17:51:16.747
        :dns:mx = ['vertex.link']
        :name = the vertex project
        :url = http://www.vertex.link

Use of meta:source nodes

Synapse-Apollo uses a meta:source node and -(seen)> light weight edges to track nodes observed from the Apollo API.

> meta:source=1b842d8ef74094ff0fc4925f18dbbff6
meta:source=1b842d8ef74094ff0fc4925f18dbbff6
        .created = 2024/12/20 17:51:16.773
        :name = apollo api

Storm can be used to filter nodes to include/exclude nodes which have been observed by Synapse-Apollo. The following example shows how to filter the results of a query to include only results observed by Synapse-Apollo:

> #cool.tag.lift +{ <(seen)- meta:source=1b842d8ef74094ff0fc4925f18dbbff6 }