Skip to main content

REST APIs for 24.2.20 and 24.2.10

Core Services Reference

This topic covers parameters, properties, and examples for core services.

Query Parameters for core services

Parameter	Description	Type	Required
`org_id`	Organization ID	Integer	Yes
`action`	The action taken on the detected core services.	String	No
`core_service_type`	Get all detected core services for a particular core service type.	String	No
`max_results`	The maximum results to be returned	Integer	No
`detected_core_service_id`	UUID of the detected core service	String	Yes

Properties for core services

Property	Description	Type
`href`	The href of this detected core service	String
`ip_address`	The ip address that is detected as core service	String
`core_service_type`	Get all detected core services of a particular type, such as Splunk/NFS. The href will be given in the query parameter.	String
`method_name`	The method by which this core service was detected	String
`created_at`	The date at which core service was detected	date/time
`updated_at`	The date core service was updated with action information.	date/time
`confidence`	Confidence of the detected core service. "minimum": 50, "maximum": 100"	Integer
`feedback`	Feedback is provided for this core service recommendation, if any. "maxLength": 500	String
`action`	Users can accept, skip, or reject the core service determination.	String
`labels_applied`	Indicates if the end-user applied labels for this workload	Boolean
`last_detected_at`	The core service detection algorithm last recommended Date core service.	date/time
`workload`	Reference to `traffic_flows_workload.schema.json`	Object

Parameters for detected_core_services_summary

Parameter	Description	Type	Required
`core_service_type`	The unique identifier for the core service type. A core service type is defined by a name, port information and PCE-recommended labels	String	Yes
`recommended`	Total number of detected core services which are skipped or no decision has been made yet	Integer	No
`accepted`	Number of accepted recommendations	Integer	No
`rejected`	Number of recommendations rejected by the user	Integer	No

Parameters for core_services_types

Parameter	Description	Type	Required
`href`	The href of this core service type	URI	Yes
`name`	The name of the core service type	String	Yes
`labels`	Reference to `core_services_labels.schema.json`
`created_at`	The timestamp at which this core service type was created	String	Yes
`updated_at`	The timestamp at which this core service type was updated	String	Yes
`required_ports`	Required ports for this core service type, if any Reference to `core_services_type_ports.schema.json`
`optional_ports`	Optional ports for this core service type, if any "$ref": "core_services_type_ports.schema.json"
`priority`	Each IP/workload is identified for one core service type, and they are ordered by priority. For PUT: "minimum": 1	Integer	No
`num_optional_ports_required`	Number of optional ports required For PUT: "maximum": 65535	Integer	No
`provider`	Indicates whether the provider is a core service. The default value is `true`, which means the provider is the core service.	Boolean	No

Sample URLs and Payloads

`GET /api/v2/orgs/1/detected_core_services/ ddfe5204-ad29-4bcd-9821-fcb62353a985`.

{ 
    "href" : 
        "/orgs/1/detected_core_services/ddfe5204-ad29-4bcd-9821-fcb62353a985" , 
	"ip_address" : 
	"103.10.11.44" , 
	"workload" : { 
            "hostname" : 
		"SE555Q5" , 
	    "href" : 
		"/orgs/2/workloads/e62d71b3-36c4-4c27-926b-411b93ba6d6f" , 
	    "labels" : [] 
	}, 
	"core_service_type" : { 
            "href" : 
             "/orgs/1/core_service_type/3555d1e4-fcb2-49c2-9a4a-215c4d5e86dc" 
	}, 
	"confidence" : 
		100  , 
	"method_name" : 
		"process_based" , 
	"created_at" : 
		"2020-08-04T05:02:46.648Z" , 
	"updated_at" : 
		"2020-08-04T05:02:46.648Z" , 
	"last_detected_at" : 
		"2020-09-05T05:02:46.648Z" 
}

`PUT /api/v2/orgs/1/detected_core_services/3ddd5204-ad29-4bcd-9821-fcb62353a98f`

Take the appropriate action for the identified core services, such as accepting the recommendation to apply the suggested labels to the workload.

Example 
	1  : 
{ "action" : "accept" } 
 
Example 
	2  : 
{ "action" : "accept" , 
	"workload" :{ "href" : 
	"/orgs/2/workloads/e62d71b3-36c4-4c27-926b-411b93ba6d6f" }} # for the 
	case when an IP is converted to UMWL and accepted as core service 
  
Example 
	3  : 
{ "action" : "reject" } 
 
Example 
	4  : 
{ "action" : "reject" , 
	"feedback" : "Not a core service." } 
 
Example 
	5  : 
{ "action" : "skip" , 
	"feedback" : "Check with Ops if this is a core service." } 
  
Example 
	6  : 
{ "labels_applied" : true }

`GET /api/v2/orgs/ :xorg_id /core_service_types/44dd5204-ad29-4bcd-9821-fcb62353a98f`

{ 
	"href" : "/orgs/2/core_service_type/44dd5204-ad29-4bcd-9821-fcb62353a98f" , 
	"core_service" : "splunk" , 
	"required_ports" :[{ "port" : 9997 , 
		"to_port" : 10000 }], 
	"optional_ports" :[{ "port" : 112 }, { "port" : 455 }], 
	"labels" : [ 
	{ 
		"value" : "app-splunk" , 
		"key" : 
			"app" 
		"href" : "/orgs/1/labels/2" 
	}, 
	{ 
		"value" : "role-splunk" , 
		"key" : 
			"role" , 
		"href" : "/orgs/1/labels/12" 
	} ], 
	"created_at" : 
		"2020-08-04T05:02:46.648Z" , 
	"updated_at" : 
		"2020-08-05T05:02:46.648Z" 
}

`PUT /api/v2/orgs/ :xorg_id /core_service_types/44dd5204-ad29-4bcd-9821-fcb62353a98f`

{ 
"labels" : [ 
	{ 
		"href" : "/orgs/1/labels/3" 
	}, 
	{ 
		"href" : "/orgs/1/labels/10" 
	}] 
}

See also:

Was this helpful?

Would you like to provide feedback? Just click here to suggest edits.