Product API Examples

These examples start with public server identity, then verify authentication, then inspect a supported read-only resource. Replace the example host and use a short-lived token with the minimum required access.

Check the server version

curl --fail --silent --show-error \
  "https://lyftdata.example.com/api/version" |
  jq

The version route is a product-server check. It does not prove the database, workers, credential transport, or a particular job is healthy.

Verify the authenticated identity

curl --fail --silent --show-error \
  "https://lyftdata.example.com/api/auth/me" \
  -H "Authorization: Bearer ${LYFTDATA_JWT}" \
  -H "Accept: application/json" |
  jq

Review the returned identity before issuing mutations. A script that can reach the server but receives 401 or 403 is not ready to automate the target operation.

List workloads

curl --fail --silent --show-error \
  "https://lyftdata.example.com/api/workloads" \
  -H "Authorization: Bearer ${LYFTDATA_JWT}" \
  -H "Accept: application/json" |
  jq

GET /api/workloads is a stable, all-editions inventory operation in the current classified contract. The returned inventory is control-plane state; it does not prove every listed workload is currently serviceable.

Inspect credentials

Credential Manager is Enterprise-enabled and administrator-scoped:

curl --fail --silent --show-error \
  "https://lyftdata.example.com/api/credential-manager/tenants/default/credentials" \
  -H "Authorization: Bearer ${LYFTDATA_JWT}" \
  -H "Accept: application/json" |
  jq

Responses contain credential metadata, not plaintext token material. A 404 can mean the feature is unavailable for the installation as well as a missing tenant, depending on the operation; use the installed OpenAPI response descriptions and edition metadata.

Use the equivalent CLI inspection

For interactive or shell automation, the native CLI handles server selection, authentication, and response formatting:

lyftdata --url https://lyftdata.example.com/ server health --json
lyftdata --url https://lyftdata.example.com/ workers list --json
lyftdata --url https://lyftdata.example.com/ deployments list --json
lyftdata --url https://lyftdata.example.com/ credentials list --json

Run lyftdata <group> <command> --help on the installed version before putting a command into production automation. See CLI.

Handle errors explicitly

Use curl --fail-with-body when your installed curl supports it so HTTP errors produce a non-zero exit while retaining the response body for bounded diagnostics:

curl --fail-with-body --silent --show-error \
  "https://lyftdata.example.com/api/auth/me" \
  -H "Authorization: Bearer ${LYFTDATA_JWT}" \
  -H "Accept: application/json"

Do not assume all error bodies share one schema. Treat the installed OpenAPI operation as the authority and avoid logging headers or sensitive response fields.