Skip to main content

REST APIs for 24.2.20 and 24.2.10

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

[api_version][org_href]/sec_policy/{pversion}/services

Get an individual service.

GET

[api_version][org_href]/sec_policy/{pversion}/services/service_id

Create a new service.

POST

[api_version][org_href]/sec_policy/draft/services/service_id

Update an individual service.

PUT

[api_version][org_href]/sec_policy/draft/services/service_id

Delete an individual service.

DELETE

[api_version][org_href]/sec_policy/draft/services/service_id

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]