rest-api

Forklift Inventory REST API

The forklift-api process runs an inventory REST API over TLS on port 8444. It exposes provider inventory data (VMs, networks, storage, hosts, etc.) collected by the inventory controller. The frontend plugin queries these endpoints for provider details, VM selection in plans, and mapping configuration.

Source: pkg/controller/provider/web/ and pkg/forklift-api/services/ in the forklift repo.

---

Server Setup

pkg/forklift-api/api.go  →  ForkliftApi.Execute()
  ├── goroutine: serveServices()   → :8444 (REST services + inventory)
  └── serveWebhooks()              → :8443 (webhooks, see webhooks.mdc)

• Port: 8444
• TLS: Certificates from env vars SERVICES_TLS_CERTIFICATE and SERVICES_TLS_KEY
• Framework: gin-gonic/gin for inventory routes; plain net/http.ServeMux for service endpoints
• Router: Inventory handlers register via AddRoutes(*gin.Engine)

---

Service Endpoints (port 8444, ServeMux)

Path	Method	Handler	Purpose
/tls-certificate	GET	serveTlsCertificate	Fetches TLS certificate from a remote URL

TLS Certificate Service: Accepts a ?URL=<url> query parameter, connects to the URL with insecureSkipVerify, retrieves the server's TLS certificate, and returns it as PEM-encoded text/plain. Used by the UI to auto-discover CA certificates during provider creation.

---

Inventory REST Endpoints (port 8444, gin)

Inventory read endpoints are GET-only. The base path is /providers. Provider utility/operation endpoints (e.g., VDDK image upload) may use other HTTP verbs.

Cross-Provider Endpoints

Route	Description
GET /providers	Lists all providers across all types, grouped by provider type
GET /providers/	Same as above

The aggregated /providers endpoint queries each provider-type handler and returns:

{
  "openshift": [...],
  "vsphere": [...],
  "ovirt": [...],
  "openstack": [...],
  "ova": [...],
  "hyperv": [...],
  "ec2": [...]
}