Ctrlk
Log in|Playground
For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Examples

Welcome to the API examples section. Here, you’ll find practical demonstrations of how to interact with our API endpoints using cURL commands. Each example is designed to help you quickly understand h

Structure of the Examples

  • cURL-based examples: Every example shows the exact cURL command you can copy and run directly in your terminal.

  • Endpoint-specific demonstrations: We walk through different API endpoints one by one, highlighting the required parameters and common use cases.

  • Request & Response clarity: Each section contains both the request (what you send) and the response (what you get back) to illustrate expected behavior.

The examples cover two families of endpoints:

  • Data query APIs: search and aggregate observability data (logs, traces, Kubernetes events, metrics). Logs, traces, and events are queried with gcQL through the Query Data with gcQL endpoints; metrics are queried with MetricsQL.

  • Management APIs: manage platform resources such as monitors, silences, workflows, ingestion keys, and pipelines.

Base URL

The canonical base URL for the groundcover API is https://api.groundcover.com. Some examples show https://app.groundcover.com, which serves the same API.

Self-hosted (onPrem / airGapped) deployments use their own API URL. Replace https://api.groundcover.com with your environment's endpoint everywhere in these examples, and use an API key generated in that environment's console - API keys are only valid for the environment that issued them.

Prerequisites

Before running any of the examples, make sure you have:

  1. API Key

  2. Backend ID

The Backend ID can be obtained from your groundcover Admin panel.

To locate it:

  • Navigate to Settings → Access

  • Open the API Keys tab

  • The Backend ID appears in the section header

When to Use

The Backend ID is required when your account is associated with multiple backends.

In such cases, include it in your API requests using the appropriate request header to ensure the request is routed to the correct backend.

Last updated