Contents
Viewing custom fields of the assets
GET /xdr/api/v2.1/kuma/settings/id/:id
The user can view a list of custom fields made by the KUMA user in the application web interface.
A custom field is a bucket for entering text. If necessary, the default value and the mask can be used to validate the entered text in the following format: https://pkg.go.dev/regexp/syntax. All forward slash characters in the mask must be shielded.
Access: Main administrator, Tenant administrator, Tier 2 analyst, Tier 1 analyst, Approver, Observer, Access to NCIRCC, Access to CII.
Query parameters
Name |
Data type |
Mandatory |
Description |
Value example |
id |
string |
Yes |
Configuration ID of the custom fields |
00000000-0000-0000-0000-000000000000 |
Response
HTTP code: 200
Format: JSON
type Settings struct {
ID string `json:"id"`
TenantID string `json:"tenantID"`
TenantName string `json:"tenantName"`
Kind string `json:"kind"`
UpdatedAt int64 `json:"updatedAt"`
CreatedAt int64 `json:"createdAt"`
Disabled bool `json:"disabled"`
CustomFields []*CustomField `json:"customFields"`
}
type CustomField struct {
ID string `json:"id"`
Name string `json:"name"`
Default string `json:"default"`
Mask string `json:"mask"`
}
|
Possible errors
HTTP code |
Description |
|
|
404 |
Parameters not found: invalid ID or parameters are missing |
Not found in database |
null |
500 |
Any other internal error |
variable |
variable |