Policy > Security > North South Security

Associated URIs:

API Description API Path

List gateway policies


List all gateway policies for specified Domain.
GET /policy/api/v1/infra/domains/<domain-id>/gateway-policies
GET /policy/api/v1/global-infra/domains/<domain-id>/gateway-policies

Delete GatewayPolicy


Delete GatewayPolicy
DELETE /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>

Read gateway policy


Read gateway policy for a domain.
GET /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>
GET /policy/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>

Update gateway policy


Update the gateway policy for a domain. This is a full replace.
All the rules are replaced.
PATCH /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>

Revise the positioning of gateway policy


This is used to set a precedence of a gateway policy w.r.t others.
POST /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>?action=revise

Update gateway policy


Update the gateway policy for a domain. This is a full replace.
All the rules are replaced.
PUT /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>

List rules


List rules
GET /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules
GET /policy/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules

Delete rule


Delete rule
DELETE /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>

Read rule


Read rule
GET /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>
GET /policy/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>

Update gateway rule


Update the gateway rule.
Create new rule if a rule with the rule-id is not already present.
PATCH /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>

Revise the positioning of gateway rule


This is used to re-order a gateway rule within a gateway policy.
POST /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>?action=revise

Update gateway rule


Update the gateway rule.
Create new rule if a rule with the rule-id is not already present.
PUT /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>

Get gateway rule statistics


Get statistics of a gateway rule.
- no enforcement point path specified: Stats will be evaluated on each enforcement.
point.
- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.
GET /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>/statistics
GET /policy/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/rules/<rule-id>/statistics

Get gateway policy statistics


Get statistics of a gateay policy.
- no enforcement point path specified: Stats will be evaluated on each enforcement.
point.
- {enforcement_point_path}: Stats are evaluated only on the given enforcement point.
GET /policy/api/v1/infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/statistics
GET /policy/api/v1/global-infra/domains/<domain-id>/gateway-policies/<gateway-policy-id>/statistics

Delete PolicyUrlCategorizationConfig


Delete PolicyUrlCategorizationConfig. If deleted, the URL categorization
will be disabled for that edge cluster.
DELETE /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-clusters/<edge-cluster-id>/url-categorization-configs/<url-categorization-config-id>

Get PolicyUrlCategorizationConfig


Gets a PolicyUrlCategorizationConfig. This returns the details of the
config like whether the URL categorization is enabled or disabled, the id
of the context profiles which are used to filter the categories, and the
update frequency of the data from the cloud.
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-clusters/<edge-cluster-id>/url-categorization-configs/<url-categorization-config-id>

Create or Update PolicyUrlCategorizationConfig


Creates/Updates a PolicyUrlCategorizationConfig. Creating or updating the
PolicyUrlCategorizationConfig will enable or disable URL categorization for
the given edge cluster. If the context_profiles field is empty, the edge
cluster will detect all the categories of URLs. If context_profiles field
has any context profiles, the edge cluster will detect only the categories
listed within those context profiles. The context profiles should have
attribute type URL_CATEGORY. The update_frequency specifies how frequently
in minutes, the edge cluster will get updates about the URL data from the
URL categorization cloud service. If the update_frequency is not specified,
the default update frequency will be 30 min.
PATCH /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-clusters/<edge-cluster-id>/url-categorization-configs/<url-categorization-config-id>

Create or Update PolicyUrlCategorizationConfig


Creates/Updates a PolicyUrlCategorizationConfig. Creating or updating the
PolicyUrlCategorizationConfig will enable or disable URL categorization for
the given edge cluster. If the context_profiles field is empty, the edge
cluster will detect all the categories of URLs. If context_profiles field
has any context profiles, the edge cluster will detect only the categories
listed within those context profiles. The context profiles should have
attribute type URL_CATEGORY. The update_frequency specifies how frequently
in minutes, the edge cluster will get updates about the URL data from the
URL categorization cloud service. If the update_frequency is not specified,
the default update frequency will be 30 min.
PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcement-point-id>/edge-clusters/<edge-cluster-id>/url-categorization-configs/<url-categorization-config-id>

Get list of gateway policies with rules that belong to the specific Tier-0 logical router.


Get filtered view of gateway rules associated
with the Tier-0. The gateay policies are returned in the
order of category and precedence.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/gateway-firewall
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/gateway-firewall

Get list of gateway policies with rules that belong to the specific Tier-0 LocalServices.


Get filtered view of Gateway Firewall rules associated
with the Tier-0 Locale Services. The gateway policies are
returned in the order of category and sequence number.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/gateway-firewall
GET /policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/gateway-firewall

Get list of gateway policies with rules that belong to the specific Tier-1.


Get filtered view of Gateway Firewall rules associated with the Tier-1.
The gateway policies are returned in the order of category and sequence number.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/gateway-firewall
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/gateway-firewall

Get list of gateway policies with rules that belong to the specific Tier-1 LocalServices.


Get filtered view of Gateway Firewall rules associated
with the Tier-1 Locale Services. The gateway policies are
returned in the order of category and sequence number.
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/gateway-firewall
GET /policy/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/gateway-firewall

Get the list of URL categories.


Gets the list of categories. This will provide all the supported categories
along with their ids. Few examples of these categories are Shopping, Social
Networks, Streaming sites, etc.
GET /policy/api/v1/infra/url-categories

Get the list of reputation severity


Gets the list of reputation severities. This will provide all the supported
severities along with their ids, min and max reputaitons.
The min_reputation and max_reputation
specify the range of the reputations which belong to a particular
severity. For instance, any reputation between 1 to 20 belongs to the
severity 'High Risk'. Similary a reputation between 81 to 100 belong
to the severity 'Trustworthy'.
GET /policy/api/v1/infra/url-reputation-severities