K8s
Retrieves and filters Kubernetes events, allowing for sorting and pagination.
Authorizations
Body
Endstring · date-timeRequired
End timestamp for the query range.
Limitinteger · uint32Optional
Maximum number of events to return.
Skipinteger · uint32Optional
Number of events to skip (for pagination).
SortBystring · enumRequiredPossible values:
Field to sort events by.
SortOrderstring · enumRequiredPossible values:
Sort order.
Startstring · date-timeRequired
Start timestamp for the query range.
WithRawEventsbooleanOptional
Include raw event data in the response.
Responses
200Success
400
ErrorResponse defines a common error response structure.
500
ErrorResponse defines a common error response structure.
post
POST /api/k8s/v2/events-over-time HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 515
{
"Conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"End": "2025-08-12T14:14:27.513Z",
"Limit": 1,
"Skip": 1,
"SortBy": "timestamp",
"SortOrder": "asc",
"Sources": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"Start": "2025-08-12T14:14:27.513Z",
"WithRawEvents": true
}No content
post
Events search
Authorizations
Body
enableStreambooleanOptional
EnableStream indicates if the response should be streamed
endstring · date-timeRequired
End time of the search range
filtersstringOptional
Extra filters to apply on the events
querystringOptional
LogsQL Query to filter events
startstring · date-timeRequired
Start time of the search range
Responses
200Success
400
ErrorResponse defines a common error response structure.
500
ErrorResponse defines a common error response structure.
post
POST /api/k8s/v2/events/search HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 8277
{
"enableStream": true,
"end": "2025-08-12T14:14:27.513Z",
"filters": "text",
"pipeline": {
"except": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"filters": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
"[Circular Reference]"
],
"operator": "text"
}
],
"operator": "text"
},
"from": {
"except": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"filters": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
"[Circular Reference]"
],
"operator": "text"
}
],
"operator": "text"
},
"from": {
"except": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"filters": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
"[Circular Reference]"
],
"operator": "text"
}
],
"operator": "text"
},
"from": {
"except": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"filters": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
"[Circular Reference]"
],
"operator": "text"
}
],
"operator": "text"
},
"from": {
"except": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"filters": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": [
"[Circular Reference]"
],
"operator": "text"
}
],
"operator": "text"
},
"from": "[Circular Reference]",
"groupBy": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"having": "[Circular Reference]",
"limit": 1,
"offset": 1,
"orderBy": [
{
"direction": "text",
"selector": {
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
}
],
"selectors": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
]
},
"groupBy": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"having": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
},
"limit": 1,
"offset": 1,
"orderBy": [
{
"direction": "text",
"selector": {
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
}
],
"selectors": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
]
},
"groupBy": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"having": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
},
"limit": 1,
"offset": 1,
"orderBy": [
{
"direction": "text",
"selector": {
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
}
],
"selectors": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
]
},
"groupBy": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"having": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
},
"limit": 1,
"offset": 1,
"orderBy": [
{
"direction": "text",
"selector": {
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
}
],
"selectors": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
]
},
"groupBy": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"having": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"disabled": true,
"groups": "[Circular Reference]",
"operator": "text"
},
"limit": 1,
"offset": 1,
"orderBy": [
{
"direction": "text",
"selector": {
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
}
],
"selectors": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
]
},
"query": "text",
"sources": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"start": "2025-08-12T14:14:27.513Z"
}No content
Retrieves a list of Kubernetes clusters based on provided source filters.
Authorizations
Body
Responses
200
Add response wrapper definition ---
400
ErrorResponse defines a common error response structure.
500
ErrorResponse defines a common error response structure.
post
POST /api/k8s/v3/clusters/list HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183
{
"Sources": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
]
}No content
Retrieves a list of Kubernetes workloads based on provided source filters, conditions, sorting, and pagination.
Authorizations
Body
Limitinteger · uint32Optional
OrderstringOptional
Skipinteger · uint32Optional
SortBystringOptional
Responses
200Success
400
ErrorResponse defines a common error response structure.
500
ErrorResponse defines a common error response structure.
post
POST /api/k8s/v3/workloads/list HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 418
{
"Conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"Limit": 1,
"Order": "text",
"Skip": 1,
"SortBy": "text",
"Sources": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
]
}No content
Last updated