Skip to main content
GET
Services Overview

Services Overview

GET /v1/services/overview returns counts and one page of service summaries. The endpoint sorts the page by name across the requested service entity types. Use it for service inventory screens that would otherwise call each service list endpoint separately. The response never includes a service connection configuration.
Note: When you retrieve or list a service through the per-type service endpoints, the connection details depend on the caller. Ingestion bots receive the full connection. Users who hold EditAll on the service, including administrators, receive the connection with sensitive values masked. All other users receive the service without its connection details. The JWT token in an OpenMetadata server connection is masked for callers that are not bots.

Query Parameters

Repeat a selector to request a union of its values:

Response

Health uses the worst terminal state among a service’s latest ingestion-pipeline runs: failed outranks partialSuccess, which outranks success. Services without a terminal run are notRun.

Health Limit

If any requested service type has more than 10,000 services, healthCounts is empty rather than approximate. Returned rows can still contain exact health values, but filtering by health is rejected for that request.

Authorization

The endpoint removes service entity types on which the caller lacks ViewBasic before calculating counts or results. It returns an authorization error when none of the requested types are viewable.