Skip to content
Library Guidance Release Notes Integrations Query Examples Training API GraphQL Search Archives Contact Support
🔖 🔔 ੆ Help Button

GraphQL & API Reference

Programmatic access to LogScale through GraphQL and REST APIs. Query, ingest, manage, and automate LogScale operations.

🔀 GraphQL API
Full-featured GraphQL interface for queries, mutations, and schema exploration
▼

GraphQL Overview

Complete reference for LogScale's GraphQL API. Learn how to construct queries, execute mutations, and interact with LogScale programmatically using GraphQL.

GraphQL Explorer

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

cURL Examples

Command-line examples for executing GraphQL queries and mutations using cURL. Perfect for scripts and automation.

GraphQL Data Types

Complete reference of all GraphQL types, inputs, enums, interfaces, and unions available in the API.

API Overview

High-level overview of both REST and GraphQL APIs, authentication, versioning, and getting started.

🔌 REST API
HTTP endpoints for search, ingest, cluster management, and operations
▼

Search API

Execute queries programmatically via REST API. Stream results, poll for completion, and retrieve aggregated data.

Ingest API

Send data to LogScale via HTTP. Structured JSON, unstructured logs, bulk ingest, and raw data endpoints.

Cluster Management API

Administrative endpoints for managing nodes, storage, Kafka, segments, and cluster health.

Packages API

Install, update, and manage packages programmatically. List available packages and their content.

Health Check API

Monitor system health and readiness. Liveness and readiness probes for orchestration systems.

Lookup Files API

Upload and manage lookup files for data enrichment. CSV files for field lookups in queries.

🔑 Authentication
API tokens, authentication methods, and security for programmatic access
▼

API Authentication

Learn how to authenticate API requests using tokens and personal access tokens. Generate, manage, and rotate API credentials securely.

🗄️ Data Types & Schema
GraphQL types, inputs, enums, interfaces, and schema documentation
▼

Object Types

All GraphQL object types representing repositories, users, queries, dashboards, and more.

Input Types

Input objects for GraphQL mutations. Structured data formats for creating and updating resources.

Enumerations

All enum values for action types, permissions, alert types, and configuration options.

Interfaces

GraphQL interfaces defining common fields across related types.

Union Types

Union types that can represent one of several possible object types in responses.

📋 Common Use Cases
API operations organized by common tasks and workflows
▼

Structured Data Ingest

Send JSON events with predefined schemas. Bulk ingest structured logs from applications.

Unstructured Data Ingest

Send raw log lines for parsing by LogScale. Text logs, syslog, and unformatted data.

Multi-Repository Ingest

Send data to multiple repositories in a single request. Efficient bulk operations.

Event Redaction

Remove or redact sensitive data from ingested events using the API.

Repository Management

Create, configure, and manage repositories programmatically via API.

Segment Management

Monitor and manage data segments, compaction, and storage distribution.

🛠️ Tools & Resources
SDKs, examples, and tools for working with LogScale APIs
▼

GraphQL Playground

Interactive GraphQL IDE with autocomplete, documentation browser, and query builder.

cURL Examples

Ready-to-use cURL commands for common GraphQL operations. Copy, paste, and customize.

Getting Started Guide

Step-by-step guide to making your first API call. Authentication, headers, and responses.

🔔 New Pages
▼
🔔 Recently Updated Pages
▼
Support

© 2026 CrowdStrike All other marks contained herein are the property of their respective owners.