Phantombuster
The Phantombuster modules allow you to watch, create, update, list, and retrieve the phantoms in your Phantombuster account.
Getting Started with Phantombuster
Prerequisites
A Phantombuster account
In order to use Phantombuster with Make, it is necessary to have a Phantombuster account. If you do not have one, you can create a Phantombuster account at phantombuster.com/signup.
Note
The module dialog fields that are displayed in bold (in the Make scenario, not in this documentation article) are mandatory!
Connecting Phantombuster to Make
To connect your Phantombuster account to Make you need to obtain the API Key from your Phantombuster account and insert it in the Create a connection dialog in the Make module.
Login to your Phantombuster account.
Click Your Profile Icon > Org Settings > Add a Third Party Key.
Copy the API Key to your clipboard.
Go to Make and open the Phantombuster module's Create a connection dialog.
In the Connection name field, enter a name for the connection.
In the API Key field, enter the API key copied in step 3 and click Continue.
The connection has been established.
Triggers
Triggers when a Phantom finishes with its recent output.
Connection | |
Phantom ID | Select the Phantom ID whose output data you want to watch. |
Actions
Gets metadata of a specified Phantom.
Connection | |
Phantom ID | Select the Phantom ID whose details you want to retrieve. |
Gets the output of the most recent container of a specified Phantom.
Connection | |
Phantom ID | Select the Phantom ID whose output data you want to retrieve. |
Launches a specified phantom.
Connection | |
Phantom ID | Select the Phantom ID which you want to launch. When you select the phantom, the field auto-populates the related fields of the phantom which you need to fill to launch the phantom. |
Save Argument | Select whether you want to save the argument:
|
Manual Launch | Select whether you launch the phantom manually:
|
Downloads a JSON result object associated with a container.
Connection | |
Get a Result of Container | Select the option to get the result of the container:
|
Phantom ID | Select the Phantom ID whose results you want to download. |
Container ID | Select the Container ID to which you want to download the result. |
Searches
Retrieves a list of all Phantoms.
Connection | |
Limit | Set the maximum number of phantoms Make should return during one scenario execution cycle. |
Performs an arbitrary authorized API call.
Connection | |
URL | Enter a path relative to NoteFor the list of available endpoints, refer to the Phantombuster API Documentation. |
Method | Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
Headers | Enter the desired request headers. You don't have to add authorization headers; we already did that for you. |
Query String | Enter the request query string. |
Body | Enter the body content for your API call. |
The following API call returns all the phantoms from your Phantombuster account:
URL:
api/v2/agents/fetch-all
Method:
GET
Matches of the search can be found in the module's Output under Bundle > Body.
In our example, 1 phantom is returned:
