Edge API Overview
The Edge API is the standard method for interacting with Kelvin Edge computers or VM's. It conforms to the RESTful API design principles.
The Edge API is versioned and the current version is v4. The version is part of the URL path and the current URL is http://<edge-computer-ip-address>:30000/api/v4/.
The default port to access Edge API is 30000.
OpenAPI Specification
The OpenAPI specification for the Edge API is available in the following location:
Online API Client
Each Edge computer/VM also comes with a built-in Swagger client that allows you to test any Edge API request in the browser.
You can access it by typing into your favorite browser;
http://<edge-computer-ip-address>:30000/swagger
To use this Online API Client will need to login first. You can do this by logging in through the standard Kelvin UI login screen at https://<url.kelvin.ai>/.
And to test any API request in the browser, simply find the request you want to send, click on the Try It Out button, fill in the parameters and body and click on the Execute button.
Authentication
The Edge API authentication is based on the OpenID Connect (OIDC), which is an open authentication protocol that works on top of the OAuth 3.0 framework.
You can learn how to authenticate with the Edge API in the Edge API Authentication page.
Pagination
The Edge API uses pagination to limit the number of results returned in a response.
You can learn how to use pagination in the Edge API Pagination page.