Skip to main content

Pulseway

Visualize Pulseway Account, Group, Host, HostAgent, Policy changes through queries and alerts.

Installation Guide

Overview​

Pulseway can be deployed either on-premise or in the cloud. If hosting your own server, you need to provide the Pulseway host name.

Prerequisites​

Ensure the following items are available before configuring the integration:

  • A Pulseway Token ID and Pulseway Token Secret generated from an API token (see below).
  • For a self-hosted Enterprise Server, your Pulseway Host URL. Hosted cloud accounts use https://api.pulseway.com.

The account used to create the API token must be able to generate tokens in Pulseway. Non-administrator users may first need API access enabled on their role before they can create a token.

Configuring Pulseway​

Generating a Pulseway API Token and Secret​

Authentication Method: BASIC Authentication​

To authorize Pulseway APIs, this integration requires the API Token and Secret.

Steps to Generate an API Token and Secret​

  1. Log in to the Pulseway web application.
  2. Navigate to Configuration in side pane under the Administration.
  3. Click on API Access.
  4. Under the Third-Party Access tab, click Create Token.
  5. Provide the following details:
    • Name: Assign a name to the token.
    • Description: Add a description for reference.
    • Expiration: Set the token's expiry date.
    • Access: Enable access to all organizations.
  6. Click Edit Permissions and select the following permissions:
    • Device: Get All Devices, Get Device Applied Policies.
    • Asset: Get All Devices and Asset Information.
    • Group: Get All Groups.
    • Environment Information: Get Environment Information.
  7. Confirm the selected permissions.
  8. Click Create.
  9. Copy the Token ID and Token Secret and save them securely.
  10. Confirm by selecting I confirm that I saved my Token Secret code.
  11. Close the Window.

Get Pulseway Host Name​

Admin > Server Admin > Overview > Server Information > Name

Configuring in JupiterOne​

  1. In the J1 Search homepage, navigate to the Integrations section from the top navigation bar.

  2. Search for Pulseway and select it.

  3. Click the Add Instance button and configure the following:

    • Pulseway Host: Enter your Pulseway Server Host URL (for example, https://test.pulseway.com). For the hosted Pulseway cloud, use https://api.pulseway.com.
    • Pulseway Token ID: Enter the API Token ID generated in Pulseway.
    • Pulseway Token Secret: Enter the API Token Secret generated in Pulseway.

  4. Click Create Configuration to save the settings.

Next Steps​

Your integration instance will now run based on the configured polling interval, populating data within JupiterOne. Refer to our Instance Management Guide to learn more about managing and editing integration instances.