Use the Web API

The Ivanti Automation Management Portal offers the availability of a Public Web API using the Swagger UI framework. This allows system developers to explore the Swagger defined API.

To view the Web API of the Ivanti Automation Management Portal:

  1. Go to Setup > Environment.
  2. Enable the Public API.
  3. Optional: enter an API key to secure the communication with the Public API.
  4. Click Explore.

The Ivanti Automation Web API is opened in a new browser. From here, you can perform several actions using the Web API.

A complete overview of Endpoints, Parameters and Methods of the Ivanti Automation WebAPI is available via Swagger. Methods are grouped by API controller where the method is implemented.

Agents

  • Get a list of Agents

Authentication

  • Use login account to access Ivanti Automation

Building Blocks

  • Create a Building Block
  • Upload the Building Block file
  • Upload the Building Block Resource file
  • Perform the import of a Building Block

Jobs

  • Get a list of active Jobs
  • Get a list of completed Jobs
  • Get a list of scheduled Jobs
  • Get the Job details
  • Export the Job results to XML

Modules

  • Get a list of Modules

Projects

  • Get a list of Projects

Run Books

  • Get a list of Run Books

Schedule

  • Get all relevant data to create a Job schedule
  • Refresh the relevant data to create a Job schedule
  • Perform the Job schedule

Teams

  • Get a list of Teams

Get a list of Agents

Location (URI)

https://[host name]/API/Agents/Search

Method

GET

Parameter(s)
  • criteria.pageNumber: specifies the requested page number (starts at 1)
  • criteria.pageSize: specifies the maximum number of items per page
  • etc.

Returns

A list of Agents including a summary per Agent