Learn About GraphQL API

Choose your learning path based on your role and goals.

Workflow 1

GraphQL Fundamentals

Start with the fundamentals; learn what's essential.

Begin with GraphQL basics, understand the query and mutation structures, learn the fundamental concepts, and build a strong foundation before trying complex API operations.

  • GraphQL Basics
  • Easy to Use Interface
  • Core Concepts (Queries, Mutations)
  • Syntax & Caveats
Start Here Workflow 2

Manage Infrastructure and Users

System Administrators

Automate LogScale infrastructure management, user provisioning, repository configuration, and operational tasks. Perfect for SRE, MSP, ITOps, and NOC teams managing LogScale deployments.

  • GraphQL Basics & API Explorer
  • Repository & Organization Management
  • User & Group Administration
  • Monitoring & Operations
Start Managing

Workflow 1: New to GraphQL

Learn the fundamentals of GraphQL. Understanding these concepts makes working with the GraphQL API easier and more effective.

1

GraphQL Basics

What is GraphQL, why it's used to administer LogScale, and how to navigate the documentation.

GraphQL API Overview

apiintermediate

What GraphQL can do and why use it.

Docs. Sorted

guideintermediate

How GraphQL documentation is sorted and organized.

Page Structure

guideintermediate

Layout of GQL documentation pages, and understanding syntax.
2

Easy Starting Point

Becoming familiar with the API Explorer, and try some simple queries using it.

Access from Browser

tutorialintermediate

Get to know the API Explorer, a built-in user interface for GraphQL.

Query Tutorial

tutorialbeginner

Learn the basics of GQL queries, the query structure.

Mutation Tutorial

tutorialbeginner

Learn nuances of mutations with generic examples.
3

Essential Queries & Mutations

Getting to know the essential queries and mutations.

Current User & Others

tutorialintermediate

Run a few simple queries to get information about user accounts.

Repositories & Views

tutorialintermediate

Get a list of repositories and views. Narrow list and specify only some fields.

Groups & Roles

tutorialintermediate

Go further with users by retrieving a list of groups and roles.

Alerts & Other Actions

tutorialintermediate

Drill down a repository to alerts, scheduled search, external actions (e.g., Slack notification), etc.
4

Command-Line & Scripts

Execute GraphQL operations from curl, scripts, and programming languages.

Accessing GraphQL using curl

tutorialintermediate

Execute GraphQL queries and mutations from the command-line using curl. Includes examples for queries, mutations, and proper JSON formatting.
5

Next Steps

Choose a specialized workflow based on your role and use case

Explore More Queries

referenceintermediate

Browse additional query examples like searchDomains, users, and organization information

Try a Simple Mutation

referenceintermediate

Learn how to create a repository using a GraphQL mutation. Understand mutation structure and required parameters.

Workflow 2: System Administrators

Learn to automate LogScale infrastructure management, user administration, and operational tasks using the GraphQL API. This workflow covers the essential queries and mutations for platform administrators.

1

GraphQL Basics for Administrators

Understanding what is GraphQL and when to use it for administrative tasks.

What is GraphQL?

apibeginner

Learn how LogScale uses GraphQL for management and administration. Understand the difference between queries (read data) and mutations (write/update data).

API Explorer

tutorialintermediate

Access the interactive GraphQL playground built into LogScale. Test queries, explore the schema, and build mutations with autocomplete.

API Authentication

apiintermediate

Understand how to authenticate API requests using API tokens. Learn about token types and permissions.

Using GraphQL with curl

tutorialintermediate

Execute GraphQL queries and mutations from the command line using curl. Includes examples for authentication, query formatting, and error handling.
2

User Administrative

Running basic queries to retrieve LogScale user information.

GraphQL Queries Reference

referenceintermediate

Complete reference of all GraphQL queries. Queries retrieve information without modifying anything.

users Query

guideintermediate

Get information on one user or a list of users, including permissions and other details.

users Query

guideintermediate

Get a list of user groups and user roles, which users belong to each, etc.
3

Organization & Repository Management

Create and configure repositories programmatically

createRepository Mutation

guideintermediate

Review and modify account and organization settings with these queries and mutations.

repositories Query

guideintermediate

Queries related to search domains (i.e., repositories and views) in LogScale.

cluster Query

guideintermediate

Configure and modify ingest feeds for repositories and parsers.

searchDomain Query

guideintermediate

Make use of archiving and other storage, including external storage, for better performance.