Skip to content

HaloAPI - A PowerShell module for Halo Service Solutions software

Azure DevOps Pipeline Status Azure DevOps Code Coverage PowerShell Gallery License GitHub Sponsors Stable Release Preview Release


This module is published to the PowerShell Gallery and can be installed from within PowerShell with Install-Module

Install-Module HaloAPI

Getting Started

The first and probably most important requirement for this module is getting it connected to your Halo instance.

Creating an API application in Halo

  1. In your Halo instance head to Configuration > Integrations > Halo PSA API
    This might be Halo Service Desk API or Halo ITSM API.

  2. Click on View Applications
    All going well you should be at config/integrations/api/applications.

  3. Click on New to add a new API application.

  4. Enter the Application Name.
    For example HaloAPI PS Module.

  5. Make sure Active is checked.

  6. Set the Authentication Method to Client ID and Secret (Services).

  7. Store the Client ID and Client Secret securely.

  8. Set the Login Type and Agent to login as appropriately.
    This setting will determine who appears to be responsible for these API calls. You may want to create a dedicated agent user for this purpose.

  9. Select the Permissions tab.

  10. Grant the application the permissions required for your purposes.
    Generally speaking you want to limit the API to only the permissions it needs to do the job you're scripting for.