> 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/list-ingestion-keys.md).

# List Ingestion Keys

Get a list of ingestion keys with optional filtering by name, type, and remote configuration status.

### Endpoint

**POST** `/api/rbac/ingestion-keys/list`

### Authentication

This endpoint requires an API key with Admin permissions and an explicit `X-Backend-Id`. It is available only for inCloud backends. Ingestion keys themselves cannot authenticate these management operations.

### Headers

```
Authorization: Bearer <YOUR_API_KEY>
X-Backend-Id: <YOUR_BACKEND_ID>
Content-Type: application/json
```

### Request Body

Optional filters for ingestion keys:

```json
{
  "name": "string",
  "type": "sensor|thirdParty|rum",
  "remoteConfig": true
}
```

| Parameter      | Type    | Required | Description                                              |
| -------------- | ------- | -------- | -------------------------------------------------------- |
| `name`         | string  | No       | Filter by exact key name                                 |
| `type`         | string  | No       | Filter by key type (`"sensor"`, `"thirdParty"`, `"rum"`) |
| `remoteConfig` | boolean | No       | Filter by remote configuration status                    |

### Examples

#### Get All Ingestion Keys

```bash
curl -L \
  --request POST \
  --url 'https://api.groundcover.com/api/rbac/ingestion-keys/list' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'X-Backend-Id: <YOUR_BACKEND_ID>' \
  --header 'Content-Type: application/json' \
  --data '{}'
```

#### Filter by Type

Get only sensor keys:

```bash
curl -L \
  --request POST \
  --url 'https://api.groundcover.com/api/rbac/ingestion-keys/list' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'X-Backend-Id: <YOUR_BACKEND_ID>' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "sensor"
  }'
```

#### Filter by Name and Remote Config

```bash
curl -L \
  --request POST \
  --url 'https://api.groundcover.com/api/rbac/ingestion-keys/list' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'X-Backend-Id: <YOUR_BACKEND_ID>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "my-sensor-key",
    "remoteConfig": true
  }'
```

The response includes secret `key` values. Handle the output as credentials. Send `{}` to list all keys; a JSON request body is required.

#### Response Example

```json
[
  {
    "id": "12345678-1234-1234-1234-123456789abc",
    "name": "production-sensor-key",
    "createdBy": "user@example.com",
    "key": "gcik_AEBAAAD4_XXXXXXXXX_XXXXXXXXX_XXXXXXXX",
    "type": "sensor",
    "remoteConfig": true,
    "tags": []
  },
  {
    "id": "87654321-4321-4321-4321-987654321def",
    "name": "my-sensor-key",
    "createdBy": "admin@example.com",
    "key": "gcik_AEBAAAC7_XXXXXXXXX_XXXXXXXXX_XXXXXXXX",
    "type": "sensor",
    "remoteConfig": true,
    "tags": []
  },
  {
    "id": "abcdefab-cdef-abcd-efab-cdefabcdefab",
    "name": "third-party-integration",
    "createdBy": "developer@example.com",
    "key": "gcik_AEBAAAHP_XXXXXXXXX_XXXXXXXXX_XXXXXXXX",
    "type": "thirdParty",
    "remoteConfig": false,
    "tags": []
  }
]
```

### Response Schema

| Field          | Type    | Description                                    |
| -------------- | ------- | ---------------------------------------------- |
| `id`           | string  | Unique identifier for the ingestion key (UUID) |
| `name`         | string  | Human-readable name for the key                |
| `createdBy`    | string  | Email of the user who created the key          |
| `key`          | string  | The actual ingestion key (starts with `gcik_`) |
| `type`         | string  | Key type (`"sensor"`, `"thirdParty"`, `"rum"`) |
| `remoteConfig` | boolean | Whether remote configuration is enabled        |
| `tags`         | array   | Array of tags associated with the key          |

### Related Documentation

For comprehensive information about ingestion keys, including creation, usage, and best practices, see:

* [Ingestion Keys](https://docs.groundcover.com/collect-data/ingestion-keys.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/remote-access-and-apis/api-examples/list-ingestion-keys.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.
