Reference

7 min

This page is a hub for the Data Gateway reference material: how to authenticate, where to find the live API documentation, and a quick tour of the most-used endpoint families.

Quick links

🚀 Getting Started

Usage GuideUsage Guide

📐Infrastructure

Understand how Data Gateway is composed and how the core services interact within SHI Cloud.

InfrastructureInfrastructure >

⚙️API Reference (Swagger)

Browse the live OpenAPI reference and try requests in your browser.

specs.shilab.com >

Authentication

Data Gateway uses Entra ID (Microsoft identity platform) for authentication. All requests must include a valid JSON Web Token (Bearer/Access Token) in the Authorization header.

Steps

Include the token in each API request:

curl -sS https://api.shilab.com/datagateway/status \ -H "Authorization: Bearer <token>" \ -H "Accept: application/json"

Notes

Tokens are validated by the API; users do not access SQL or Storage directly.

Tokens expire; refresh them using your chosen auth flow (authorization code, client credentials, etc.).

LicenseGPT prompts and responses are not persisted - the API returns results to the UI for the current session.

Endpoint Families

Family	Purpose	Typical methods	Common paths*
Health & metadata	Service liveness and basic info	GET	/Api/Core/Health
Tenants	Read and maintain tenant metadata (display name, parent association)	GET, PATCH	/Api/Tenant, /Api/Tenant/{tenantId}
LicenseGPT	AI-assisted licensing & compliance analysis	POST	/Api/Chat/LicenseGpt
Updates (channels & rings)	Resolve version and retrieve update package	GET (and streaming)	See Swagger (“Updates”)

* For the complete, authoritative list (parameters, schemas, and responses), use the live reference at specs.shilab.com.

Request & Response Basics

Protocol: HTTPS only

Content type: application/json; charset=utf-8 (unless explicitly streaming binaries)

Date/time: ISO 8601 in UTC unless stated otherwise

Pagination/filters: When applicable, filter and paging parameters are documented per endpoint in Swagger

Error handling

The API uses standard HTTP status codes with JSON error payloads. Please see MDN - Status Codes for more details on specific codes and how they should be interpreted.

ℹ️ Note

The response body typically includes an explanatory message; consult Swagger for exact schemas.