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 API Key authentication via the Authorization header.

Headers

Authorization: Bearer <YOUR_API_KEY>
Content-Type: application/json

Request Body

Optional filters for ingestion keys:

{
  "name": "string",
  "type": "sensor|thirdParty|rum",
  "remoteConfig": boolean
}

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

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

Filter by Type

Get only sensor keys:

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

Filter by Name and Remote Config

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

Response Example

[
  {
    "id": "12345678-1234-1234-1234-123456789abc",
    "name": "production-sensor-key",
    "createdBy": "[email protected]",
    "creationDate": "2025-08-31T11:48:18Z",
    "key": "gcik_AEBAAAD4_XXXXXXXXX_XXXXXXXXX_XXXXXXXX",
    "type": "sensor",
    "remoteConfig": true,
    "tags": []
  },
  {
    "id": "87654321-4321-4321-4321-987654321def",
    "name": "my-sensor-key",
    "createdBy": "[email protected]",
    "creationDate": "2025-08-31T11:48:18Z",
    "key": "gcik_AEBAAAC7_XXXXXXXXX_XXXXXXXXX_XXXXXXXX",
    "type": "sensor",
    "remoteConfig": true,
    "tags": []
  },
  {
    "id": "abcdefab-cdef-abcd-efab-cdefabcdefab",
    "name": "third-party-integration",
    "createdBy": "[email protected]",
    "creationDate": "2025-08-31T11:48:18Z",
    "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
creationDate	string	ISO 8601 timestamp of key creation
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