Sign in
External Services - Query

Check if a service supports query explorer functionality

get/external-services/{service_id}/query/explorer-support

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/external-services/{service_id}/query/explorer-support
  • Auth: HTTP bearer

Path parameters

service_idinteger required

Response

Explorer support information

capabilitiesstring[] required

Capabilities supported by this service

filter_schemaunknown
reasonstring nullable

Reason why explorer is not supported (if applicable)

service_typestring required

Service type

supportedboolean required

Whether the service supports query explorer functionality

Example response

{
  "capabilities": [
    "sql"
  ],
  "hierarchy": [
    {
      "can_list_containers": true,
      "container_type": "database",
      "name": "root"
    }
  ],
  "service_type": "postgres",
  "supported": true
}

Changes

No recorded changes to this operation across all 50 revisions of this API.