> For the complete documentation index, see [llms.txt](https://docs.groundcover.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.groundcover.com/reference.md). # Reference - [Requirements](https://docs.groundcover.com/reference/requirements.md) - [Kubernetes requirements](https://docs.groundcover.com/reference/requirements/kubernetes-requirements.md) - [Kernel requirements for eBPF sensor](https://docs.groundcover.com/reference/requirements/kernel-requirements-for-ebpf-sensor.md) - [CPU architectures](https://docs.groundcover.com/reference/requirements/cpu-architectures.md) - [Remote Access & APIs](https://docs.groundcover.com/reference/remote-access-and-apis.md): groundcover has various authentication key types for remotely interacting with our platform, whether to ingest observability data or to automate actions via our APIs: - [Datasource API Keys (Legacy)](https://docs.groundcover.com/reference/remote-access-and-apis/querying-you-data-using-an-api.md) - [Grafana Service Account Token](https://docs.groundcover.com/reference/remote-access-and-apis/build-alerts-and-dashboards-with-grafana-terraform-provider.md) - [Metrics and Logs API](https://docs.groundcover.com/reference/remote-access-and-apis/raw-prometheus-and-clickhouse.md): This page describes the available API endpoints for querying logs, traces, Kubernetes events, and metrics in groundcover, including how to authenticate and structure requests for general data retrieva - [API Examples](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples.md): 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 - [List Workloads](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/list-workloads.md): Retrieve a list of Kubernetes workloads with their performance metrics, resource usage, and metadata. - [List Namespaces](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/list-namespaces.md): Retrieve a list of Kubernetes namespaces within a specified time range. - [List Clusters](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/list-clusters.md): Retrieve a list of Kubernetes clusters with their resource usage metrics, metadata, and health information. - [List Deployments](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/list-deployments.md): Get a list of Kubernetes deployments with status information, replica counts, and operational conditions for a specified time range. - [List Monitors](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/list-monitors.md): Get a list of all configured monitors in the system with their identifiers, titles, and types. - [Get Monitor](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/get-monitor.md): Retrieve detailed configuration for a specific monitor by its UUID, including queries, thresholds, display settings, and evaluation parameters. - [Create Silence](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/create-silence.md): Create a new one-time silence rule to suppress monitor notifications for a specified time period, using label matchers to target specific monitors or issues. - [Delete Silence](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/delete-silence.md): Delete an existing silence rule using its silence ID. - [Recurring Silences API](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/recurring-silences-api.md): Create, list, update, and delete recurring silence rules that automatically suppress monitor notifications on a repeating schedule. - [List Workflows](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/list-workflows.md): Get a list of all configured alert workflows with their complete definitions, provider integrations, execution status, and YAML configurations. - [Create Workflow](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/create-workflow.md): Creates a new workflow for alert handling and notifications. Workflows define how alerts are processed and routed to various integrations like Slack, PagerDuty, webhooks, etc. - [Delete Workflow](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/delete-workflow.md): Delete an existing workflow using workflow id - [List Nodes with Resource Information](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/list-nodes-with-resource-information.md) - [Get Logs Pipeline Configuration](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/get-logs-pipeline-configuration.md): Retrieve the current logs pipeline configuration. - [Update Logs Pipeline Configuration](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/update-logs-pipeline-configuration.md): Update the logs pipeline configuration. - [List Ingestion Keys](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/list-ingestion-keys.md): Get a list of ingestion keys with optional filtering by name, type, and remote configuration status. - [Create Ingestion Key](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/create-ingestion-key.md): Create a new ingestion key. - [Delete Ingestion Key](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/delete-ingestion-key.md): Delete an existing ingestion key. This operation permanently removes the key and cannot be undone. - [Query Monitors Summary](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/query-monitors-summary.md): Get a comprehensive list of monitor configurations with detailed execution status, alert states, performance metrics, and complete query definitions. This endpoint provides real-time monitoring data f - [Query Data with gcQL](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/query-data-gcql.md): Query logs, traces, and Kubernetes events over HTTP using gcQL, groundcover's pipe-based query language. All signals share the same request structure and response format. - [Query Logs](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/query-data-gcql/query-logs.md): Search and aggregate log data over HTTP using gcQL queries - filter by any field, run full-text searches, and compute aggregations in a single request. - [Query Traces](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/query-data-gcql/query-traces.md): Search and aggregate trace spans over HTTP using gcQL queries - find failing requests, compute latency percentiles, and calculate error rates per endpoint. - [Query Kubernetes Events](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/query-data-gcql/query-events.md): Search and aggregate Kubernetes events over HTTP using gcQL queries - surface warnings, group events by reason, and track cluster activity. - [Query Metrics](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/query-metrics.md): Execute MetricsQL queries against groundcover metrics data. Two endpoints are available: instant queries for point-in-time values and range queries for time-series data over specific periods. - [Query APM Measurements](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/query-apm-measurements.md): Query groundcover's APM measurements (requests, errors, latency) with gcQL. Two endpoints are available: search for tabular results and search-time-series for charted results over time. - [List Seats Usage](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/list-seats-usage.md) - [Remove Member](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/remove-member.md) - [groundcover Terraform Provider](https://docs.groundcover.com/reference/groundcover-terraform-provider.md) - [Embedded Grafana](https://docs.groundcover.com/reference/embedded-grafana.md) - [Dashboards](https://docs.groundcover.com/reference/embedded-grafana/embedded-grafana-dashboards.md) - [Create a Grafana dashboard](https://docs.groundcover.com/reference/embedded-grafana/embedded-grafana-dashboards/create-a-dashboard.md) - [Build alerts & dashboards with Grafana Terraform provider](https://docs.groundcover.com/reference/embedded-grafana/embedded-grafana-dashboards/build-alerts-and-dashboards-with-grafana-terraform-provider.md) - [Alerts](https://docs.groundcover.com/reference/embedded-grafana/embedded-grafana-alerts.md) - [Create a Grafana alert](https://docs.groundcover.com/reference/embedded-grafana/embedded-grafana-alerts/create-an-alert.md) - [TCO Calculator](https://docs.groundcover.com/reference/tco-calculator.md) - [FAQ](https://docs.groundcover.com/reference/faq.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.groundcover.com/reference.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.