Lieutenant API

Welcome to the documentation of the Lieutenant API - a Project Syn tool.

projectsyn

The Lieutenant API provides the central inventory of all tenants and clusters managed by Project Syn.

It’s a REST API based on OpenAPI 3 and is designed to be a wrapper around the various CRDs managed by the Lieutenant Operator.

The /docs endpoint of the API hosts an interactive Swagger UI.