Accessing the UCP Advisor REST APIs

Unified Compute Platform (UCP) Advisor Administration Guide

Version
4.5.x
Audience
anonymous
Part Number
MK-92UCP119-13
ft:lastEdition
2024-03-11

To access the UCP Advisor REST APIs, from the UCP Advisor login, go to the User icon and then click API Documentation. A new browser tab will be opened.

Important: Refresh your browser before accessing the API documentation.

Alternatively, if the UCP service is running and you know the IP address for the UCP Master Node VM, you can access the UCP Advisor REST APIs in Swagger at: https://<master-node-vm-ip-address>/porcelain/v2/swagger-ui/index.html.

  1. Click the User icon, and then click API Documentation.

    Image of Settings icon and User icon

  2. Click a collection name to expand the list of operations for that collection.
    Click a collection name