OpenAPI specification (OAS)

KMI LMS utilizes Swagger to generate and publish an OpenAPI specification (OAS) for REST API. The OAS definition is produced in JSON and YAML formats. The documentation can be used to build client application that integrate with LMS.

Swagger and OpenAPI provides the following capabilities:

View API method and entities.
Test each method before using it in your application.
Generate client libraries in a preferred language.
Interact with the API in a sandbox environment to understand how to make request, how the API responds, try different parameters and options.

How to access the OpenAPI specification

The OAS definition is published to this locations:

JSON format:

{LMS-URL}/api/v2/openapi.json

YAML format:

{LMS-URL}/api/v2/openapi.yaml

The {LMS-URL} is the base URL of the LMS.

Examples

Below are examples of how to request OAS specification in JSON and YAML formats.

Format	LMS URL	OAS definition URL
JSON	https://lms.example.com	https://lms.example.com/api/v2/openapi.json
YAML	https://lms.example.com	https://lms.example.com/api/v2/openapi.yaml

How to access Swagger

The Swagger tool allows to view and interact with the API. Use the following URL to access the Swagger:

{LMS-URL}/api/v2/

Example

https://lms.example.com/api/v2/

Last modified: 06 January 2025