Admin API (EE) schema

service.admin.ee.graphqls

This API is available in Enterprise and AWS editions only.

To authenticate API requests, you’ll need an API token. Learn how to generate an access token.

See usage examples in the cloudbeaver-graphql-examples repository.

You can try queries in the built-in GraphQL console, available on your server at https://your-server-address/api/gql/console. This tool lets you test requests directly from your browser.

For a live example, see the demo GraphQL console.

API Endpoints
https://your-server-address/api/gql

Queries

adminApiCallLog

Description

Returns paginated list of API call log entries matching provided filter.

Response

Returns an ApiCallFilterResponse!

Arguments
Name Description
filter - ApiCallLogFilterInput!

Example

Query
query adminApiCallLog($filter: ApiCallLogFilterInput!) {
  adminApiCallLog(filter: $filter) {
    hasMore
    objects {
      ...ApiCallLogEventFragment
    }
  }
}
Variables
{"filter": ApiCallLogFilterInput}
Response
{
  "data": {
    "adminApiCallLog": {
      "hasMore": "<boolean>",
      "objects": [ApiCallLogEvent]
    }
  }
}

Types

ApiCallFilterResponse

Description

Response wrapper returned by apiCallLog query.

Fields
Field Name Description
hasMore - Boolean! True if there are more records after the current page.
objects - [ApiCallLogEvent!]! List of log events for the requested page.
Example
{"hasMore": "<boolean>", "objects": [ApiCallLogEvent]}
Types

ApiCallLogEvent

Description

API call logging schema for admin EE service. Describes how API call log events can be queried and sorted via GraphQL.

Fields
Field Name Description
id - ID! Unique identifier of the log entry.
endpoint - String! Called HTTP endpoint path.
qmSessionId - String Optional QM session identifier associated with this call.
httpMethod - String! HTTP method used for the request (e.g. GET, POST).
errorMessage - String Optional error message if the call failed.
userName - String Name of the authenticated user who executed the call (if available).
requestTime - String! Time when the API call was executed, as ISO‑8601 string (LocalDateTime).
apiProtocol - String Protocol used to access the API (e.g. REST, GRAPHQL).
parameters - String Request parameters serialized as a string.
serviceType - String Type of backend service that handled the request (e.g. cb).
ipAddress - String Client IP address from which the request was made.
Example
{
  "id": "<id>",
  "endpoint": "<string>",
  "qmSessionId": "<string>",
  "httpMethod": "<string>",
  "errorMessage": "<string>",
  "userName": "<string>",
  "requestTime": "<string>",
  "apiProtocol": "<string>",
  "parameters": "<string>",
  "serviceType": "<string>",
  "ipAddress": "<string>"
}
Types

ApiCallLogFilterInput

Description

Filter and pagination options for apiCallLog query.

Fields
Input Field Description
page - Int Zero-based page index. Default = 0
pageSize - Int Number of records per page. Default = 50
dateFrom - String Inclusive start of the time range filter (ISO‑8601 string).
dateTo - String Inclusive end of the time range filter (ISO‑8601 string).
sorts - [ApiCallLogSortInput!] List of sort fields and directions. Order of items defines precedence (first has highest priority). Default = []
ipAddress - [String] Optional filter by client IP address.
userName - [String] Optional filter by authenticated user name.
endpoint - [String] Optional filter by called endpoint (substring match).
httpMethod - [String] Optional filter by HTTP method.
errorOnly - Boolean If true, only return log entries that contain an error. Default = false
apiProtocol - [String] Optional filter by API protocol.
Example
{
  "page": "<int>",
  "pageSize": "<int>",
  "dateFrom": "<string>",
  "dateTo": "<string>",
  "sorts": [ApiCallLogSortInput],
  "ipAddress": ["<string>"],
  "userName": ["<string>"],
  "endpoint": ["<string>"],
  "httpMethod": ["<string>"],
  "errorOnly": "<boolean>",
  "apiProtocol": ["<string>"]
}
Types

ApiCallLogSortInput

Description

Input type that describes a single sort key and direction. This is used to provide a stable, multi-field ordering: the list order defines priority (first = highest priority).

Fields
Input Field Description
field - ApiCallLogSortType! Field to sort by.
desc - Boolean True = descending, false = ascending (default true). Default = true
Example
{"field": "USERNAME", "desc": "<boolean>"}
Types

ApiCallLogSortType

Description

Supported sort fields for the API call log listing.

Values
Enum Value Description

USERNAME

 Sort by userName field.

REQUEST_TIME

 Sort by requestTime field.

IP_ADDRESS

 Sort by ip_address field.

ENDPOINT

 Sort by endpoint field.
Example
"USERNAME"
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
"<boolean>"
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"<id>"
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
"<int>"
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"<string>"
Documentation by Anvil SpectaQL