Ingestion Keys

post

List Ingestion Keys

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Body

application/json

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

application/json

createdBystringOptional

idstringOptional

keystringOptional

namestringOptional

remoteConfigbooleanOptional

tagsstring[]Optional

typestringOptional

400

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

post

/api/rbac/ingestion-keys/list

HTTPcURLJavaScriptPython

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"
}

[
  {
    "createdBy": "text",
    "id": "text",
    "key": "text",
    "name": "text",
    "remoteConfig": true,
    "tags": [
      "text"
    ],
    "type": "text"
  }
]

post

Create Ingestion Key

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Body

application/json

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

application/json

400

ErrorResponse defines a common error response structure.

application/json

409

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

post

/api/rbac/ingestion-keys/create

HTTPcURLJavaScriptPython

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"
}

{
  "createdBy": "text",
  "id": "text",
  "key": "text",
  "name": "text",
  "remoteConfig": true,
  "tags": [
    "text"
  ],
  "type": "text"
}

delete

Delete Ingestion Key

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Body

application/json

namestringRequired

Name of the ingestion key to delete

Responses

202

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

400

ErrorResponse defines a common error response structure.

application/json

404

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

delete

/api/rbac/ingestion-keys/delete

HTTPcURLJavaScriptPython

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