
Edit a default entity type in ITSI
Every entity type comes with at least one default metrics filter and one default events filter that populates the Analysis Workspace with data. You can edit a default entity type in the ITSI user interface or through an ITSI REST API endpoint. You can delete a custom entity type in ITSI, but you can't delete a default entity type. For a list of default entity types in ITSI, see Default entity types and their properties.
Prerequisites
Requirement | Description |
---|---|
ITSI roles | You need to log in as a user with the itoa_admin or itoa_team_admin role.
|
Edit a default entity type in the ITSI user interface
Perform the following steps to edit a default entity type in ITSI:
- From the ITSI main menu, click Configuration > Entities.
- Click Entity Types.
- Click Edit on the entity type you want to edit.
- After you make your changes, click Save.
Edit a default entity type through the REST API
You can edit a default entity type through the ITSI REST API. You can delete custom entity types that you create, but you can't delete the default entity types included with ITSI. For more information, see ITSI REST API reference in the ITSI REST API reference manual.
servicesNS/nobody/SA-ITOA/itoa_interface/entity_type
The following example shows how to edit an entity type through the ITSI REST API.
GET
Get a list of entity types in your environment.
Request parameters
N/A
Data payload:
N/A
Return
A list of entity types.
Example request
curl -k -u admin:password https://localhost:8089/servicesNS/nobody/SA-ITOA/itoa_interface/entity_type
POST
Edit an entity type.
Request parameters
N/A
Data payload:
N/A
Return
The updated object key.
Example request
curl -k -u admin:password -X POST -H "Content-Type: application/json" https://localhost:8089/servicesNS/nobody/SA-ITOA/itoa_interface/entity_type/<entity-type-key> -d '{ "title": "<new entity type name>", "description": "Windows type", "data_drilldowns": [{"type": "metrics", "title": "System metrics", "static_filter": {"type": "include", "field": "metric_name", "values": ["*"]}, "entity_field_filter": {"type": "entity", "entity_field": "host", "data_field": "host"}}, {"type": "events", "title": "Windows logs", "static_filter": {"type": "include", "field": "sourcetype", "values": ["*"]}, "entity_field_filter": {"type": "entity", "entity_field": "host", "data_field": "host"}}], "_key": "windows", "dashboard_drilldowns": [{"id": "windows_overview_dashboard", "base_url": "", "is_splunk_dashboard": false, "title": "Windows Overview Dashboard", "params": {"static_params": {}, "alias_param_map": []}}]}'
DELETE
Delete entity types.
Request parameters
N/A
Data payload:
N/A
Return
204 success message if you delete a custom entity type.
400 error if you try to delete a default entity type.
Example request
curl -k -u admin:password -X DELETE https://localhost:8089/servicesNS/nobody/SA-ITOA/itoa_interface/entity_type/<_key>
PREVIOUS Overview of entity types in ITSI |
NEXT Create custom entity types in ITSI |
This documentation applies to the following versions of Splunk® IT Service Intelligence: 4.6.0 Cloud only, 4.6.1 Cloud only, 4.6.2 Cloud only, 4.7.0, 4.7.1, 4.7.2, 4.7.3, 4.7.4, 4.8.0 Cloud only, 4.8.1 Cloud only
Feedback submitted, thanks!