How to access On-Premises Monitor OData API

IMPORTANT: This section is NOT applicable for cloud customers.

The Monitor OData API is also available for on-premises use. However, you will need to adjust the URL and authentication method accordingly.

In this section, we will demonstrate how to access the On-Premises Monitor OData API using Postman as an example.

Use the collection and environment in the Postman

Download the collection and environment from Github, then import them into the Postman.

Import collection and environment into Postman

Another way it to fork the collection and environment from the Postman workspace.

Fork the collection

Click the Create a fork.

Config the fork

Config the fork.

  • Fork Label: Name your fork.
  • Workspace: Choose your own workspace.
  • Environments to fork: Select Demo_OnPrem.

Config the environment

Config the env

  1. Swith the environment to Demo_OnPrem.
  2. Click the Environments -> Demo_OnPrem.
  3. Config the Current value

    • baseurl: URL with the IP or FQDN of the DDC.
    • username: In the format doamin\username.
    • password: The password for the username.

Try the API

Try the API

Select an API from the Collections, and then click Send.

Resources
Citrix Monitor Service API OpenAPI Specification
Copy Download
How to access On-Premises Monitor OData API