Log in|Playground

Ingestion Keys

post

List Ingestion Keys

Authorizations
Body
namestringOptional

Name of the ingestion key to filter by

remoteConfigbooleanOptional

RemoteConfig indicates if the key is for remote config

typestringOptional

Type of the ingestion key to filter by

Responses
200Success
post
POST /api/rbac/ingestion-keys/list HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "name": "text",
  "remoteConfig": true,
  "type": "text"
}
No content
post

Create Ingestion Key

Authorizations
Body
namestringRequired

The desired name for the ingestion key.

remoteConfigbooleanOptional

Indicates whether the key is explicitly for remote configuration or not.

tagsstring[]Optional

A list of tags to associate with the key.

typestring · enumRequired

The type of the ingestion key.

Possible values:
Responses
201Success
post
POST /api/rbac/ingestion-keys/create HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "name": "text",
  "remoteConfig": true,
  "tags": [
    "text"
  ],
  "type": "sensor"
}
No content
delete

Delete Ingestion Key

Authorizations
Body
namestringRequired

Name of the ingestion key to delete

Responses
202

NoContentResponse indicates success but that no response body is expected or included.

delete
DELETE /api/rbac/ingestion-keys/delete HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
No content

Last updated