Documentation for the IPS Admin API

These REST-based APIs allow external applications and integration tools to:

  • Perform administrative functions for your IPS Server deployment
  • Automate processes.

There are three APIs:

  • IPS Manager ('/admin')
  • IPS License Server ('/licenseserver')
  • IPS Server Monitor ('/monitor')

See Making an API request to learn how to make API requests.

See the API Reference (IPS version: 16.5 Update 34 (16.5.34)) section for reference information about the individual APIs.

The IPS Server Monitor API is also accessible at a tenant-level endpoint, and can be used by any tenant user. See 'IPS Server Monitor Tenant API' in the Planning Space Web API Guide.

For version 16.5 Update 13 and later: The Server Monitor API (and also the tenant-level endpoint) can be disabled using the IPS service setting 'Enable Server Monitor'. When disabled, all back-end data collection and API endpoints are stopped; and the Server Monitor user interfaces in IPS Manager and Planning Space are removed.

Many of the functions provided by the IPS Manager API can be accessed as cmdlets in the IPS PowerShell module. For information see the Planning Space Deployment Guide.

Important: For correct API reference information, you should ensure that the version of this document matches with the version of your PalantirIPS server. See the value of 'Software version' in the page footer below.