Services
This Public Stable API gets, creates, updates, or deletes services. To write services, they must be in the “draft” state, which means they have not been provisioned. To provision changes made to services, use the Security Policy API.
Services API Methods
Functionality | HTTP | URI |
|---|---|---|
Get a collection of services. |
|
|
Get an individual service. |
|
|
Create a new service. |
|
|
Update an individual service. |
|
|
Delete an individual service. |
|
|
Active vs. Draft
Get Services
This API gets all the services in your organization that are in the “draft” policy state (not yet provisioned).
By default, the maximum number returned on a GET collection of services is 500.
URI to Get a Collection of Services
GET [api_version][org_href]/sec_policy/draft/services
URI to Get an Individual Service
GET [api_version][service_href]
Create a Service
This method creates an individual service. Once a service is created, it can be used to write rules for a security policy.
URI to Create a Service
POST [api_version][org_href]/sec_policy/draft/services
Update a Service
To update (PUT) an individual service, you need to know its HREF. The HREF of a service is returned when you get a collection of services from the PCE.
URI to Update an Individual Service
PUT [api_version][service_href]
Delete a Service
To delete an individual service, use the HREF of the service you want to delete, which is returned when you get a collection of services.
URI to Delete an Individual Service
DELETE [api_version][service_href]
Core Services Detection
This Public Experimental API helps you identify core services and suggests an appropriate label. 51 services can be detected.
Core services (such as DNS, Domain Controller, NTP, and LDP) are essential to your computing environment and run on one or multiple workloads. Identifying and labeling these workloads is important because they are centrally connected, and other applications depend on them.
When you use core service detection to label and write policies for core services, you can save time on application policies and introduce enforcement faster.
Users can change the port numbers on which a specific core service is running to adjust them to their environment. However, users cannot change ports using the UI, only the APIs.
The user authorized to manage core services is the Organization Administrator.
The Common schemas for managing core services:
core_services_labels.schema.jsoncore_services_type_ports_def.schema.jsoncore_services_type_ports.schema.json
Core Services API Methods
Functionality | HTTP | URI |
|---|---|---|
Get all detected core services for this organization. |
|
|
Get a detected core service by UUID. |
|
|
Get the core service summary details. |
|
|
Get all core service types for this organization. |
|
|
Get the core service type by UUID. |
|
|
Accept, reject, or skip the core service recommendation. |
|
|
Edit the suggested labels of a core service type for the organization. |
|
|
Filter for Managed Services
Filtering Workloads and Virtual Services
This API allows you to filter all managed services, such as workloads and virtual services.
Functionality | HTTP | URI |
|---|---|---|
Get a list of Virtual Servers |
|
|
Get a specified Virtual Server |
|
|