API

The SDL API is rooted at https://localhost/api.

Scalar is also available from the main nav bar in the SDL UI, and documents all the available APIs.

The REST API is divided into three main categories.

  • Fabric Services (/api/v1/*) are platform services hosted/provided by SDL.

  • Proxied Services (/api/proxy/*) are proxies to external services (see Proxy).

  • Adaptive API (/api/adaptive/*) provides on-the-fly API extensibility via ConfigMaps (see Adaptive API).

See Endpoints for full listing.

OpenAPI

To retrieve the OpenAPI specification for a particular service, you can either download it from the Scalar API reference or you can curl for it at the base of the service API.

For example, to download the spec for the /api/v2/catalog API:

curl https://localhost/api/v2/catalog

This will return you the YAML representation of the spec.

Authentication

All SDL REST endpoints support the following authentication mechanisms:

  • Basic (username/password)

    curl -H "Authorization: Basic $(echo -n 'user:password' | base64)"

  • Bearer tokens (JSON Web Tokens)

    curl -H "Authorization: Bearer $TOKEN"

  • OAuth2 single-sign on authorization flows (Scalar only)

In all cases, your credentials must authenticate with the SDL Keycloak (which can federate with other Keycloak instances).

The SDL API also provides test endpoints for testing your connection and credentials.