Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Introduction

AIP Console has API documentation provided by Swagger. This documentation is interactive and you can test requests directly. The API documentation is accessible via the URL (change the URL to suit your own environment):

http://<aip_console>:8081/swagger-ui.html

Click to enlarge

Multiple APIs

The AIP Console API interface contains API commands for both the AIP Console and AIP Node, therefore there is no longer any need to switch between each interface as was the case in previous releases.

Authorization

Before you can interactively use the graphical API, you must be authorized. Authorization requires a user API key, which you can generated in your user profile settings:

Using the API interactively

Show the request type you want to test:

Expand the specific request using the blue section in the top left:

and click Try it out:

Click to enlarge

Real life implementation of the API

CAST has used the AIP Console API to build various tools that can be used to improve the analysis process (Jenkins plugin and automation). You can find out more about these tools here: https://github.com/CAST-Extend/com.castsoftware.uc.aip.console.tools - explore tools to see how the API can be used in a real life context.

Note:

  • If you are a member of the CAST-Extend GitHub organization, you can push merge requests from another branch (master branch is read-only) or you can fork the project and change it to suit your own requirements
  • These tools are not supported by CAST
  • No labels