APIs

Introduction

Welcome to the groundcover API documentation.

groundcover provides a powerful set of APIs that allow you to interact programmatically with your observability data, automate monitor management, and integrate groundcover with your existing tools and workflows.

These APIs are organized around REST and return JSON-encoded responses.

All endpoints are accessed via https://api.groundcover.com/

Authentication

All groundcover APIs require authentication using an API key. These keys are scoped to your organization and represent a service account. Permissions are enforced based on the policies assigned to that account.

Getting Your API Key

API keys authenticate your requests and determine what actions you’re allowed to perform based on the associated service account’s permissions. Full details on API Keys in groundcover can be found here.

Only Admins can create API Keys

To generate an API key:

Open the groundcover app
Go to Settings > Access > API Keys
Click Create API Key
Select a Service Account, see which policies will be assigned to the new API Key.
Copy the generated key, it will only be shown once!

📘 For detailed steps, see: : How to generate and use an API key

Getting Your Backend ID

Backend ID represents your backend name instance, since you can have multiple groundcover backends in a single tenant, an API Key is bound to a specific backend. In most cases you will have a single backend instance.

To get your backend id:

Open the groundcover app
Go to Settings > Access > API Keys
Above the API Keys list you'll see your backend id name.

Make an Authenticated API Request

Include your API key and Backend ID in the headers of each request:

curl 'https://api.groundcover.com/api/k8s/v3/clusters/list' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer <YOUR_API_KEY>' \
  -H 'X-Backend-Id: <YOUR_BACKEND_ID>'

The Authorization header must contain the key as a Bearer token
The X-Backend-Id header must be set to your backend ID

Last updated 23 days ago