Contents
Resource search
GET /xdr/api/v2.1/kuma/resources/
Access: Main administrator, Tenant administrator, Tier 2 analyst, Tier 1 analyst, Observer.
Query parameters (URL Query)
Name |
Data type |
Mandatory |
Description |
Value example |
page |
number |
No |
Page number. Starts with 1. The page size is 250 entries. If the parameter is not specified, the default value is 1. |
1 |
id |
string |
No |
Resource ID. If the parameter is specified several times, then a list is generated and the logical OR operator is applied. |
00000000-0000-0000-0000-000000000000 |
tenantID |
string |
No |
Resource tenant ID. If the parameter is specified several times, then a list is generated and the logical OR operator is applied. If the user does not have the required role in the specified tenant, then this tenant is ignored. |
00000000-0000-0000-0000-000000000000 |
name |
string |
No |
Resource name. Case-insensitive regular expression (PCRE). |
resource |
kind |
string |
No |
Resource type. If the parameter is specified several times, then a list is generated and the logical OR operator is applied |
collector, correlator, storage, activeList, aggregationRule, connector, correlationRule, dictionary, enrichmentRule, destination, filter, normalizer, responseRule, search, agent, proxy, secret |
userID |
string |
No |
User ID. If the parameter is specified several times, then a list is generated and the logical OR operator is applied. The me value corresponds to the user that performs the request. |
00000000-0000-0000-0000-000000000000 me |
Response
HTTP code: 200
Format: JSON
type Response []Resource
type Resource struct {
ID string `json:"id"`
Kind string `json:"kind"`
Name string `json:"name"`
Description string `json:"description"`
TenantID string `json:"tenantID"`
TenantName string `json:"tenantName"`
UserID string `json:"userID"`
UserName string `json:"userName"`
Created string `json:"created"`
Updated string `json:"updated"`
}
|
Possible errors
HTTP code |
Description |
|
|
400 |
Invalid value of the "page" parameter |
invalid query parameter value |
page |
400 |
Invalid value of the "kind" parameter |
invalid kind |
<kind> |
500 |
Any other internal error |
variable |
variable |