GraphQL Groupings of Queries & Mutations

Summary

The GraphQL API has hundreds of queries and mutations. You can see a list of all of the queries on the GraphQL Queries page, and all of the mutations on the GraphQL Mutations page. They're listed alphabetically. Finding the one you need may be difficult. This section provides sub-pages that group the queries and mutations based on common usage.

  • User Administration: This page lists commonly used queries and mutations related to the administration of user accounts.

  • Roles & Groups: Related to users, these are queries and mutations having to do with user roles and user groups.

  • Account & Organization: The queries and mutations listed on this page relate to the LogScale account (i.e., the license and instance), as well as many more related to the administering of an organization.

  • Search Domains: There are many queries and mutations that involve search domains (i.e., repositories and views). These, however, are specific to search domains (e.g., creating them) and not incidental.

  • Dashboards: Although GraphQL can't be used for accessing dashboards, there are several administrative tasks related to dashboards that it can do.

  • Ingest & Parsers: These queries and mutations relate to the analyzing, managing, and other administering of queries.

  • Ingest & Parsers: This page lists several mutations related to ingest feeds, parsers, and related items — and some queries.

  • Storage & Retention: For administration of storage and retention, and external storage tasks, there are several GraphQL queries and mutations for them.

  • Actions & Schedules: These are queries and mutations related to actions (e.g., aggregate alerts) and scheduled items (e.g., scheduled reports).