GraphQL API

LogScale uses a GraphQL API for management and administration tasks, such as adding users and assigning permission, controling cluster, etc. GraphQL allows you to specify precisely the data you require and supports single endpoints and references to identify the information and operations required on a case by case basis.

LogScale uses REST APIs for interfaces not supported by GraphQL, such as HTTP streaming results to the user and custom applications. For more on using REST APIs with LogScale, see Search API.

Updates and changes to the GraphQL API are backwards compatible with previous versions. Changes shouldn't cause existing scripts using the API to fail after an upgrade.

The GraphQL API is organized into three primary groups, listed below, that are described in separate manuals.

  • GraphQL Queries

    GraphQL queries access and return configurations, settings and other administrative data in LogScale.

  • GraphQL Mutations

    Mutations modify configurations, and create or update information within LogScale. Some will return requested data, besides confirmation of execution.

  • GraphQL Datatypes

    Datatypes provide the necessary structures used to define elements when using the GraphQL API.

For an explanation and introduction to this organization, see Docs Sorting.

For testing and execution of GraphQL queries and mutations, you may use the API Explorer from a web browser within LogScale (see API Explorer). You can also use API scripts with a few programming languages (e.g., Node, Perl, Python) using a suitable HTTP or GraphQL querying tool. Or you can use command-line tools like curl (see Scripts & curl).