Skip to content
This repository was archived by the owner on Jul 28, 2026. It is now read-only.

Update _index.md #1032

Merged
rfratto merged 2 commits into from
Oct 28, 2021
Merged

Update _index.md #1032

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
486def5
Update _index.md
aengusrooneygrafana Oct 26, 2021
ba3d310
Update _index.md
aengusrooneygrafana Oct 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/api/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,17 @@ weight = 400

The API is divided into several parts:

- [Config Management API](#config-management-api)
- [Config Management API](#config-management-api)
- [Agent API](#agent-api)
- [Ready/Healthy API](#ready--health-api)

## Config management API

Grafana Agent exposes a REST API for managing instance configurations when
it is running in [scraping service mode]({{< relref "../scraping-service" >}}). The following
endpoints are exposed:
Grafana Agent exposes a config management REST API for managing instance configurations when it is running in [scraping service mode]({{< relref "../scraping-service" >}}).

(Note that scraping service mode is a requirement for the config management API, however this is not a pre-req for the Agent API or Ready/Healthy API)

The following endpoints are exposed:

- List configs: [`GET /agent/api/v1/configs`](#list-configs)
- Get config: [`GET /agent/api/v1/configs/{name}`](#get-config)
Expand Down