> 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/remote-access-and-apis/api-examples/get-logs-pipeline-configuration.md).

# Get Logs Pipeline Configuration

Retrieve the current logs pipeline configuration.

### Authentication and permissions

Use an [API key](https://docs.groundcover.com/administer/api-keys.md) in `Authorization: Bearer <YOUR_API_KEY>` and select the backend with `X-Backend-Id: <YOUR_BACKEND_ID>`. Use your own API base URL for a self-hosted deployment.

Reading the configuration requires backend access but does not require Admin permissions.

### Endpoint

**GET** `/api/pipelines/logs/config`

### Example

```bash
curl --request GET 'https://api.groundcover.com/api/pipelines/logs/config' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'X-Backend-Id: <YOUR_BACKEND_ID>'
```

### Response

HTTP 200 returns a JSON object with the following fields:

| Field               | Type   | Description                                            |
| ------------------- | ------ | ------------------------------------------------------ |
| `uuid`              | string | Configuration fingerprint.                             |
| `created_by`        | string | Identity that saved the configuration.                 |
| `created_timestamp` | string | Creation time in RFC3339 format.                       |
| `value`             | string | The saved pipeline configuration as YAML or JSON text. |

The HTTP response is JSON, but `value` contains the configuration as a string. Newlines and quotes inside that string are escaped in the raw JSON response. Decode the field to display or save the original configuration. The following command requires `jq`:

```bash
curl --fail-with-body --silent --show-error \
  'https://api.groundcover.com/api/pipelines/logs/config' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'X-Backend-Id: <YOUR_BACKEND_ID>' | jq -r '.value'
```

For a saved YAML configuration that adds an environment attribute, the output is:

```yaml
ottlRules:
  - ruleName: add_environment_tag
    statements:
      - set(attributes["environment"], "production")
```

The parser accepts YAML and JSON configuration text, and GET returns the text in the format that was saved. HTTP 204 means no saved configuration is available.

See [Update Logs Pipeline Configuration](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/update-logs-pipeline-configuration.md) to replace the rules, and [Log Pipelines API](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/log-pipelines-api.md) for simulation, statistics and deletion.


---

# 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/remote-access-and-apis/api-examples/get-logs-pipeline-configuration.md?ask=<question>&goal=<user_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.
