Using the Cluster API Inspector

This procedure will walk you through setting up and using the API inspector.
  1. To use the API client, the Cluster schema needs to have an Action and an Event added. To edit the schema, click the Edit Schema button in the Cluster configuration.
    Figure 1.
  2. Add the following Action: 
    "send-api": {
    "description": "Send an API request to the cluster.",
    "input": {
        "properties": {
            "correlationId": {
                "type": "string"
            },
            "href": {
                "type": "string"
            },
            "requestBody": {
                "type": "string"
            },
            "requestMethod": {
                "type": "string"
            }
        },
        "type": "object"
    },
    "title": "Send API"
},
  3. Add the following Event: 
    "send-api": {
    "data": {
        "type": "object"
    },
    "description": "Final response of API request",
    "title": "API request is done"
},
  4. Click Save and they will be created.
  5. The Cluster’s Overview pane will show details of the Deployments and Pods. Click on the arrow in front of the name to expand the item to show more details.
  6. To make the API calls click the API client button displayed on the Cluster’s Overview pane.
    Figure 2.
    This will open the API Client pane where REST API calls to the Edge Compute Platform running on the Asset can be made:


    Figure 3.

    See Edge Compute Platform API for details on the available API endpoints.