API Description | API Path |
---|---|
List forwarding policies for the given domainList all forwarding policies for the given domain ordered by precedence. |
GET /policy/api/v1/infra/domains/{domain-id}/forwarding-policies
GET /policy/api/v1/global-infra/domains/{domain-id}/forwarding-policies |
Delete forwarding policyDelete forwarding policy. |
DELETE /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}
|
Read forwarding policyRead forwarding policy. |
GET /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}
GET /policy/api/v1/global-infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id} |
Create or update forwarding policyCreate or update the forwarding policy. Performance Note: If you want to edit several rules in a forwarding policy use this API. It will perform better than several individual rule APIs. Just pass all the rules which you wish to edit as embedded rules to it. |
PATCH /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}
|
Create or update forwarding policyCreate or update the forwarding policy. Performance Note: If you want to edit several rules in a forwarding policy use this API. It will perform better than several individual rule APIs. Just pass all the rules which you wish to edit as embedded rules to it. |
PUT /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}
|
List rulesList rules |
GET /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules
GET /policy/api/v1/global-infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules |
Get forwarding rule statistics.Get aggregated statistics of Forwarding Policy Rule. Stats include total number of packets and total number of bytes for the 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}/forwarding-policies/{forwarding-policy-id}/rules/{forwarding-rule-id}/statistics
|
Delete ForwardingRuleDelete ForwardingRule |
DELETE /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}
|
Read ruleRead rule |
GET /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}
GET /policy/api/v1/global-infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id} |
Update forwarding ruleCreate a rule with the rule-id is not already present, otherwise update the rule. Performance Note: If you want to edit several rules in a forwarding policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id> |
PATCH /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}
|
Update forwarding ruleCreate a rule with the rule-id is not already present, otherwise update the rule. Performance Note: If you want to edit several rules in a forwarding policy, prefer below mentioned API for optimal performance. Pass all the rules which you wish to edit as embedded rules to it. Use this API - PATCH (or PUT) /infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id> |
PUT /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules/{rule-id}
|
Get forwarding policy statistics.Get aggregated stattistics of Forwarding Policy. Stats include total number of packets and total number of bytes for all Forwarding rules in a given Forwarding 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}/forwarding-policies/{forwarding-policy-id}/statistics
|
Reset Forwarding rule statisticsSets Forwarding Policy rule statistics counter to zero. - no enforcement point path specified: Reset of stats will be executed for each enforcement point. - {enforcement_point_path}: Reset of stats will be executed only for the given enforcement point. |
POST /policy/api/v1/infra/domains/{domain-id}/forwarding-policies/stats?action=reset
|
List DPD profilesGet paginated list of all DPD Profiles. |
GET /policy/api/v1/infra/ipsec-vpn-dpd-profiles
|
Delete custom dead peer detection (DPD) profileDelete custom dead peer detection (DPD) profile. Profile can not be deleted if profile has references to it. |
DELETE /policy/api/v1/infra/ipsec-vpn-dpd-profiles/{dpd-profile-id}
|
Get dead peer detection (DPD) profileGet custom dead peer detection (DPD) profile, given the particular id. |
GET /policy/api/v1/infra/ipsec-vpn-dpd-profiles/{dpd-profile-id}
|
Create or patch a custom DPD ProfileCreate or patch dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile. System will be provisioned with system owned editable default DPD profile. Any change in profile affects all sessions consuming this profile. |
PATCH /policy/api/v1/infra/ipsec-vpn-dpd-profiles/{dpd-profile-id}
|
Create or fully replace a custom IPSec tunnel ProfileCreate or patch dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile. System will be provisioned with system owned editable default DPD profile. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/ipsec-vpn-dpd-profiles/{dpd-profile-id}
|
List IKE profilesGet paginated list of all IKE Profiles. |
GET /policy/api/v1/infra/ipsec-vpn-ike-profiles
|
Delete custom IKE ProfileDelete custom IKE Profile. Profile can not be deleted if profile has references to it. |
DELETE /policy/api/v1/infra/ipsec-vpn-ike-profiles/{ike-profile-id}
|
Get IKE ProfileGet custom IKE Profile, given the particular id. |
GET /policy/api/v1/infra/ipsec-vpn-ike-profiles/{ike-profile-id}
|
Create or patch a custom internet key exchange (IKE) ProfileCreate or patch custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile. |
PATCH /policy/api/v1/infra/ipsec-vpn-ike-profiles/{ike-profile-id}
|
Create or fully replace a custom internet key exchange (IKE) ProfileCreate or fully replace custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/ipsec-vpn-ike-profiles/{ike-profile-id}
|
List IPSec tunnel profilesGet paginated list of all IPSec tunnel Profiles. |
GET /policy/api/v1/infra/ipsec-vpn-tunnel-profiles
|
Delete custom IPSec tunnel ProfileDelete custom IPSec tunnel Profile. Profile can not be deleted if profile has references to it. |
DELETE /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/{tunnel-profile-id}
|
Get IPSec tunnel ProfileGet custom IPSec tunnel Profile, given the particular id. |
GET /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/{tunnel-profile-id}
|
Create or patch a custom IPSec tunnel ProfileCreate or patch custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile. |
PATCH /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/{tunnel-profile-id}
|
Create or fully replace a custom IPSec tunnel ProfileCreate or fully replace custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/ipsec-vpn-tunnel-profiles/{tunnel-profile-id}
|
List LBAppProfilesPaginated list of all LBAppProfiles. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-app-profiles
|
Delete LBAppProfile and all the entities contained by this LBAppProfileDelete the LBAppProfile along with all the entities contained by this LBAppProfile. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
DELETE /policy/api/v1/infra/lb-app-profiles/{lb-app-profile-id}
|
Read LBAppProfileRead a LBAppProfile. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-app-profiles/{lb-app-profile-id}
|
Create or update a LBAppProfileIf a LBAppProfile with the lb-app-profile-id is not already present, create a new LBAppProfile. If it already exists, update the LBAppProfile. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
PATCH /policy/api/v1/infra/lb-app-profiles/{lb-app-profile-id}
|
Create or update a LBAppProfileIf a LBAppProfile with the lb-app-profile-id is not already present, create a new LBAppProfile. If it already exists, update the LBAppProfile. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
PUT /policy/api/v1/infra/lb-app-profiles/{lb-app-profile-id}
|
List LBClientSslProfilesPaginated list of all LBClientSslProfiles. |
GET /policy/api/v1/infra/lb-client-ssl-profiles
(Deprecated)
|
Delete LBClientSslProfile and all the entities contained by this LBClientSslProfileDelete the LBClientSslProfile along with all the entities contained by this LBClientSslProfile. |
DELETE /policy/api/v1/infra/lb-client-ssl-profiles/{lb-client-ssl-profile-id}
(Deprecated)
|
Read LBClientSslProfileRead a LBClientSslProfile. |
GET /policy/api/v1/infra/lb-client-ssl-profiles/{lb-client-ssl-profile-id}
(Deprecated)
|
Create or update a LBClientSslProfileIf a LBClientSslProfile with the lb-client-ssl-profile-id is not already present, create a new LBClientSslProfile. If it already exists, update the LBClientSslProfile. This is a full replace. |
PATCH /policy/api/v1/infra/lb-client-ssl-profiles/{lb-client-ssl-profile-id}
(Deprecated)
|
Create or update a LBClientSslProfileIf a LBClientSslProfile with the lb-client-ssl-profile-id is not already present, create a new LBClientSslProfile. If it already exists, update the LBClientSslProfile. This is a full replace. |
PUT /policy/api/v1/infra/lb-client-ssl-profiles/{lb-client-ssl-profile-id}
(Deprecated)
|
List LBMonitorProfiles for infraPaginated list of all LBMonitorProfiles for infra. |
GET /policy/api/v1/infra/lb-monitor-profiles
(Deprecated)
|
Delete LBMonitorProfile and all the entities contained by this LBMonitorProfileDelete the LBMonitorProfile along with all the entities contained by this LBMonitorProfile. |
DELETE /policy/api/v1/infra/lb-monitor-profiles/{lb-monitor-profile-id}
(Deprecated)
|
Read LBMonitorProfileRead a LBMonitorProfile. |
GET /policy/api/v1/infra/lb-monitor-profiles/{lb-monitor-profile-id}
(Deprecated)
|
Create or update a LBMonitorProfileIf a LBMonitorProfile with the lb-monitor-profile-id is not already present, create a new LBMonitorProfile. If it already exists, update the LBMonitorProfile. This is a full replace. |
PATCH /policy/api/v1/infra/lb-monitor-profiles/{lb-monitor-profile-id}
(Deprecated)
|
Create or update a LBMonitorProfileIf a LBMonitorProfile with the lb-monitor-profile-id is not already present, create a new LBMonitorProfile. If it already exists, update the LBMonitorProfile. This is a full replace. |
PUT /policy/api/v1/infra/lb-monitor-profiles/{lb-monitor-profile-id}
(Deprecated)
|
Read load balancer usage for the given nodeAPI is used to retrieve node usage for load balancer which contains basic information, LB entity usages and capacities for the given node. Currently only edge node is supported. The parameter ?node_path=<node-path> is required. For example, ?node_path= /infra/sites/default/enforcement-points/default/edge-clusters/ 85175e0b-4d74-461d-83e1-f3b785adef9c/edge-nodes/ 86e077c0-449f-11e9-87c8-02004eb37029. |
GET /policy/api/v1/infra/lb-node-usage
(Deprecated)
|
Read load balancer node usage summaryThe API is used to retrieve the load balancer node usage summary of all nodes for every enforcement point. - If the parameter ?include_usages=true exists, the property node_usages are included in response. By default, the property node_usages is not included in response. - If parameter ?enforcement_point_path=<enforcement-point-path> exists, only node usage summary from specific enforcement point is included in response. If no enforcement point path is specified, information will be aggregated from each enforcement point. |
GET /policy/api/v1/infra/lb-node-usage-summary
(Deprecated)
|
List LBPersistenceProfiles for infraPaginated list of all LBPersistenceProfiles for infra. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-persistence-profiles
|
Delete LBPersistenceProfile and all the entities contained by this LBPersistenceProfileDelete the LBPersistenceProfile along with all the entities contained by this LBPersistenceProfile. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
DELETE /policy/api/v1/infra/lb-persistence-profiles/{lb-persistence-profile-id}
|
Read LBPersistenceProfileRead a LBPersistenceProfile. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-persistence-profiles/{lb-persistence-profile-id}
|
Create or update a LBPersistenceProfileIf a LBPersistenceProfile with the lb-persistence-profile-id is not already present, create a new LBPersistenceProfile. If it already exists, update the LBPersistenceProfile. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
PATCH /policy/api/v1/infra/lb-persistence-profiles/{lb-persistence-profile-id}
|
Create or update a LBPersistenceProfileIf a LBPersistenceProfile with the lb-persistence-profile-id is not already present, create a new LBPersistenceProfile. If it already exists, update the LBPersistenceProfile. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
PUT /policy/api/v1/infra/lb-persistence-profiles/{lb-persistence-profile-id}
|
List LBPoolsPaginated list of all LBPools. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-pools
|
Delete LBPool and all the entities contained by this LBPoolDelete the LBPool along with all the entities contained by this LBPool. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
DELETE /policy/api/v1/infra/lb-pools/{lb-pool-id}
|
Read LBPoolRead a LBPool. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-pools/{lb-pool-id}
|
Create or update a LBPoolIf a LBPool with the lb-pool-id is not already present, create a new LBPool. If it already exists, update the LBPool. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
PATCH /policy/api/v1/infra/lb-pools/{lb-pool-id}
|
Create or update a LBPoolIf a LBPool with the lb-pool-id is not already present, create a new LBPool. If it already exists, update the LBPool. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
PUT /policy/api/v1/infra/lb-pools/{lb-pool-id}
|
List LBServerSslProfilesPaginated list of all LBServerSslProfiles. |
GET /policy/api/v1/infra/lb-server-ssl-profiles
(Deprecated)
|
Delete LBServerSslProfile and all the entities contained by this LBServerSslProfileDelete the LBServerSslProfile along with all the entities contained by this LBServerSslProfile. |
DELETE /policy/api/v1/infra/lb-server-ssl-profiles/{lb-server-ssl-profile-id}
(Deprecated)
|
Read LBServerSslProfileRead a LBServerSslProfile. |
GET /policy/api/v1/infra/lb-server-ssl-profiles/{lb-server-ssl-profile-id}
(Deprecated)
|
Create or update a LBServerSslProfileIf a LBServerSslProfile with the lb-server-ssl-profile-id is not already present, create a new LBServerSslProfile. If it already exists, update the LBServerSslProfile. This is a full replace. |
PATCH /policy/api/v1/infra/lb-server-ssl-profiles/{lb-server-ssl-profile-id}
(Deprecated)
|
Create or update a LBServerSslProfileIf a LBServerSslProfile with the lb-server-ssl-profile-id is not already present, create a new LBServerSslProfile. If it already exists, update the LBServerSslProfile. This is a full replace. |
PUT /policy/api/v1/infra/lb-server-ssl-profiles/{lb-server-ssl-profile-id}
(Deprecated)
|
Read load balancer service usage summaryAPI is used to retrieve the load balancer usage summary for all load balancer services. If the parameter ?include_usages=true exists, the property service-usages is included in the response. By default, service-usages is not included in the response. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-service-usage-summary
|
List LBServicePaginated list of all LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-services
|
Delete LBService and all the entities contained by this LBServiceDelete the LBService along with all the entities contained by this LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
DELETE /policy/api/v1/infra/lb-services/{lb-service-id}
|
Read LBServiceRead an LBService. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-services/{lb-service-id}
|
Create or update a LBVirtualServerIf a LBService with the lb-service-id is not already present, create a new LBService. If it already exists, update the LBService. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
PATCH /policy/api/v1/infra/lb-services/{lb-service-id}
|
Create or update a LBServiceIf a LBService with the lb-service-id is not already present, create a new LBService. If it already exists, update the LBService. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
PUT /policy/api/v1/infra/lb-services/{lb-service-id}
|
Get LBService status informationGet LBService detailed status information. - no enforcement point path specified: Information will be aggregated from each enforcement point. - {enforcement_point_path}: Information will be retrieved only from the given enforcement point. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-services/{lb-service-id}/detailed-status
|
Get LBPool status informationGet LBPool detailed status information. - no enforcement point path specified: Information will be aggregated from each enforcement point. - {enforcement_point_path}: Information will be retrieved only from the given enforcement point. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-services/{lb-service-id}/lb-pools/{lb-pool-id}/detailed-status
|
Get LBPool statistics informationGet LBPoolStatistics information. - no enforcement point path specified: Information will be aggregated from each enforcement point. - {enforcement_point_path}: Information will be retrieved only from the given enforcement point. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-services/{lb-service-id}/lb-pools/{lb-pool-id}/statistics
|
Get LBVirtualServer status informationGet LBVirtualServer detailed status information. - no enforcement point path specified: Information will be aggregated from each enforcement point. - {enforcement_point_path}: Information will be retrieved only from the given enforcement point. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-services/{lb-service-id}/lb-virtual-servers/{lb-virtual-server-id}/detailed-status
|
Get LBVirtualServer statistics informationGet LBVirtualServerStatistics information. - no enforcement point path specified: Information will be aggregated from each enforcement point. - {enforcement_point_path}: Information will be retrieved only from the given enforcement point. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-services/{lb-service-id}/lb-virtual-servers/{lb-virtual-server-id}/statistics
|
Get LBService usage informationGet LBServiceUsage information. - no enforcement point path specified: Information will be aggregated from each enforcement point. - {enforcement_point_path}: Information will be retrieved only from the given enforcement point. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-services/{lb-service-id}/service-usage
|
Get LBService statistics informationGet LBServiceStatistics information. - no enforcement point path specified: Information will be aggregated from each enforcement point. - {enforcement_point_path}: Information will be retrieved only from the given enforcement point. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-services/{lb-service-id}/statistics
|
Retrieve a list of supported SSL ciphers and protocolsRetrieve a list of supported SSL ciphers and protocols. |
GET /policy/api/v1/infra/lb-ssl-ciphers-and-protocols
(Deprecated)
|
List LBVirtualServersPaginated list of all LBVirtualServers. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-virtual-servers
|
Delete LBVirtualServer and all the entities contained by this LBVirtualServer.Delete the LBVirtualServer along with all the entities contained by this LBVirtualServer. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
DELETE /policy/api/v1/infra/lb-virtual-servers/{lb-virtual-server-id}
|
Read LBVirtualServerRead a LBVirtualServer. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
GET /policy/api/v1/infra/lb-virtual-servers/{lb-virtual-server-id}
|
Create or update a LBVirtualServerIf a LBVirtualServer with the lb-virtual-server-id is not already present, create a new LBVirtualServer. If it already exists, update the LBVirtualServer. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
PATCH /policy/api/v1/infra/lb-virtual-servers/{lb-virtual-server-id}
|
Create or update a LBVirtualServerIf a LBVirtualServer with the lb-virtual-server-id is not already present, create a new LBVirtualServer. If it already exists, update the LBVirtualServer. This is a full replace. This API is deprecated for the NSX-T Load Balancer, but not for the NSX-T Distributed Load Balancer. |
PUT /policy/api/v1/infra/lb-virtual-servers/{lb-virtual-server-id}
|
List Metadata Proxy ConfigurationsList all L2 Metadata Proxy Configurations |
GET /policy/api/v1/infra/metadata-proxies
|
Delete Metadata Proxy ConfigAPI will delete Metadata Proxy Config with ID profile-id |
DELETE /policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}
|
Get Metadata Proxy ConfigAPI will read Metadata Proxy Config with ID profile-id |
GET /policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}
|
Create or update Metadata Proxy ConfigAPI will create or update Metadata Proxy Config with ID profile-id. Maximum 10 Metadata Proxy Configurations are supported. |
PATCH /policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}
|
Create or update Metadata Proxy ConfigAPI will create or update Metadata Proxy Config with ID profile-id |
PUT /policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}
|
Get metadata proxy status |
GET /policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}/statistics
GET /policy/api/v1/global-infra/metadata-proxies/{metadata-proxy-id}/statistics |
Get metadata proxy status |
GET /policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}/status
GET /policy/api/v1/global-infra/metadata-proxies/{metadata-proxy-id}/status |
Get IPSec VPN service list resultGet paginated list of all IPSec VPN services for given Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services
|
Delete IPSec VPN serviceDelete IPSec VPN service for under Tier-0. |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}
|
Get IPSec VPN serviceGet IPSec VPN service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}
|
Create or patch IPSec VPN serviceCreate or patch IPSec VPN service under Tier-0. |
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}
|
Create or fully replace IPSec VPN serviceCreate or fully replace IPSec VPN service under given Tier-0. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}
|
Get IPSec VPN local endpoint list resultGet paginated list of all IPSec VPN local endpoints for a given ipsec vpn service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/local-endpoints
|
Delete IPSec VPN local endpointDelete IPSec VPN local endpoint for a given ipsec vpn service under Tier-0. |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Get IPSec VPN local endpointGet IPSec VPN local endpoint for a given ipsec vpn service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Create or patch a custom IPSec VPN local endpointCreate or patch a custom IPSec VPN local endpoint under Tier-0. |
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Create or fully replace IPSec VPN local endpointCreate or fully replace IPSec VPN local endpoint for a given ipsec vpn service under Tier-0. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Get IPSec VPN sessions list resultGet paginated list of all IPSec VPN sessions for a given ipsec vpn service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions
|
Delete IPSec VPN sessionDelete IPSec VPN session for a given ipsec vpn service under Tier-0. |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Get IPSec VPN SessionGet IPSec VPN session with senstive data for a given ipsec vpn service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data
|
Get IPSec VPN SessionGet IPSec VPN session without sensitive data for a given ipsec vpn service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Create or patch an IPSec VPN sessionCreate or patch an IPSec VPN session for a given ipsec vpn service under Tier-0. |
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Create or fully replace IPSec VPN sessionCreate or fully replace IPSec VPN session for a given ipsec vpn service under Tier-0. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Get IPSec VPN session detailed status under Tier-0- no enforcement point path specified: detailed status is evaluated on each enforcement point. - an enforcement point path is specified: detailed status is evaluated only on the given enforcement point. - source=realtime: detailed status is fetched realtime from the enforcement point. - source=cached: cached detailed status from enforcement point is returned. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status
(Deprecated)
|
Get IPSec VPN configuration for the peer siteDownload IPSec VPN configuration for the peer site. Peer config also contains PSK; be careful when sharing or storing it. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config
|
Get IPSec VPN session statistics under Tier-0- no enforcement point path specified: statistics are evaluated on each enforcement point. - an enforcement point path is specified: statistics are evaluated only on the given enforcement point. - source=realtime: statistics are fetched realtime from the enforcement point. - source=cached: cached statistics from enforcement point are returned. Please note that cache synchronization is based on triggering this API with source=realtime or empty source and not polling based. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
|
Reset the statistics of the given VPN sessionResets the statistics of the given VPN session. Since source of data is enforcement point, data is reset there. |
POST /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
POST /policy/api/v1/global-infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics |
Get IPSec VPN Session SummarySummarized view of all tier-0 IPSec VPN sessions for a specified service. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/ipsec-vpn-services/{service-id}/summary |
Get L2VPN service list result under Tier-0Get paginated list of all L2VPN services under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services
|
Delete L2VPN service under Tier-0Delete L2VPN service for given Tier-0. |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}
|
Get L2VPN service under Tier-0Get L2VPN service for given Tier-0 |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}
|
Create or patch L2VPN service under Tier-0Create or patch L2VPN service for given Tier-0 |
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}
|
Create or fully replace L2VPN service under Tier-0Create or fully replace L2VPN service for given Tier-0. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}
|
Get L2VPN sessions list result under Tier-0Get paginated list of all L2VPN sessions under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions
|
Delete L2VPN session under Tier-0Delete L2VPN session under Tier-0. When L2VPN Service is in CLIENT Mode, the L2VPN Session is deleted along with its transpot tunnels and related resources. |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Get L2VPN Session under Tier-0Get L2VPN session under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Create or patch an L2VPN session under Tier-0Create or patch an L2VPN session under Tier-0. API supported only when L2VPN Service is in Server Mode. |
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Create or patch an L2VPN session under Tier-0 from Peer CodesCreate or patch an L2VPN session under Tier-0 from Peer Codes. In addition to the L2VPN Session, the IPSec VPN Session, along with the IKE, Tunnel, and DPD Profiles are created and owned by the system. IPSec VPN Service and Local Endpoint are created only when required, i.e., an IPSec VPN Service does not already exist, or an IPSec VPN Local Endpoint with same local address does not already exist. Updating the L2VPN Session can be performed only through this API by specifying new peer codes. Use of specific APIs to update the L2VPN Session and the different resources associated with it is not allowed, except for IPSec VPN Service and Local Endpoint, resources that are not system owned. API supported only when L2VPN Service is in Client Mode. |
POST /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code
|
Create or fully replace L2VPN session under Tier-0Create or fully replace L2VPN session under Tier-0. API supported only when L2VPN Service is in Server Mode. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Get L2VPN session detailed status under Tier-0- no enforcement point path specified: detailed tatus is evaluated on each enforcement point. - an enforcement point path is specified: detailed status is evaluated only on the given enforcement point. - source=realtime: detailed tatus is fetched realtime from the enforcement point. - source=cached: cached detailed status is returned. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}/detailed-status
|
Get Tier-0 L2VPN session configuration for the peer siteGet peer config for the Tier-0 L2VPN session to configure the remote side of the tunnel. - no enforcement point path specified: L2VPN Session Peer Codes will be evaluated on each enforcement point. - enforcement point paths specified: L2VPN Session Peer Codes are evaluated only on the given enforcement points. API supported only when L2VPN Service is in Server Mode. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}/peer-config
|
Get L2Vpn session remote mac for logical switchReturns L2Vpn session remote macs for a logical switch. Data is fetched from enforcement point. This API is deprecated. Please use GET /infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/ sessions/<session-id>/detailed-status instead. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}/remote-mac
|
Get L2VPN session statistics under Tier-0- no enforcement point path specified: statistics are evaluated on each enforcement point. - an enforcement point path is specified: statistics are evaluated only on the given enforcement point. - source=realtime: statistics are fetched realtime from the enforcement point. - source=cached: cached statistics from the enforcement point are returned. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/l2vpn-services/{service-id}/sessions/{session-id}/statistics
|
Get IPSec VPN service list resultGet paginated list of all IPSec VPN services for given locale service under Tier-0. Note: Please note that request is validated and any error messages returned from validation may include the new VPN path instead of the deprecated path. Both new path and old path refer to same resource. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services
(Deprecated)
|
Delete IPSec VPN serviceDelete IPSec VPN service for given locale service under Tier-0. |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Get IPSec VPN serviceGet IPSec VPN service for given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Create or patch IPSec VPN serviceCreate or patch IPSec VPN service for given locale service under Tier-0. |
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Create or fully replace IPSec VPN serviceCreate or fully replace IPSec VPN service for given locale service under Tier-0. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Get IPSec VPN local endpoint list resultGet paginated list of all IPSec VPN local endpoints for a given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints
(Deprecated)
|
Delete IPSec VPN local endpointDelete IPSec VPN local endpoint for a given locale service under Tier-0. |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Get IPSec VPN local endpointGet IPSec VPN local endpoint for a given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Create or patch a custom IPSec VPN local endpointCreate or patch a custom IPSec VPN local endpoint for a given locale service under Tier-0. |
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Create or fully replace IPSec VPN local endpointCreate or fully replace IPSec VPN local endpoint for a given locale service under Tier-0. Revision is optional for creation and required for update. Note: Please note that request is validated and any error messages returned from validation may include the new VPN path instead of the deprecated path. Both new path and old path refer to same resource. Also VPN path returned in the Alarm, GPRR payload may include the new VPN path |
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Get IPSec VPN sessions list resultGet paginated list of all IPSec VPN sessions for a given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions
(Deprecated)
|
Delete IPSec VPN sessionDelete IPSec VPN session for a given locale service under Tier-0. |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get IPSec VPN SessionGet IPSec VPN session with senstive data for a given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data
(Deprecated)
|
Get IPSec VPN SessionGet IPSec VPN session without sensitive data for a given locale service under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or patch an IPSec VPN sessionCreate or patch an IPSec VPN session for a given locale service under Tier-0. |
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or fully replace IPSec VPN sessionCreate or fully replace IPSec VPN session for a given locale service under Tier-0. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get IPSec VPN session detailed status under Tier-0- no enforcement point path specified: detailed status is evaluated on each enforcement point. - an enforcement point path is specified: detailed status is evaluated only on the given enforcement point. - source=realtime: detailed status is fetched realtime from the enforcement point. - source=cached: cached detailed status from enforcement point is returned. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status (Deprecated) |
Get IPSec VPN configuration for the peer siteDownload IPSec VPN configuration for the peer site. Peer config also contains PSK; be careful when sharing or storing it. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config
(Deprecated)
|
Get IPSec VPN session statistics under Tier-0- no enforcement point path specified: statistics are evaluated on each enforcement point. - an enforcement point path is specified: statistics are evaluated only on the given enforcement point. - source=realtime: statistics are fetched realtime from the enforcement point. - source=cached: cached statistics from enforcement point are returned. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics (Deprecated) |
Reset the statistics of the given VPN sessionResets the statistics of the given VPN session. Since source of data is enforcement point, data is reset there. |
POST /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics (Deprecated) |
Get IPSec VPN Session SummarySummarized view of all tier-0 IPSec VPN sessions for a specified service. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary (Deprecated) |
Get L2VPN service list result under Tier-0Get paginated list of all L2VPN services under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services
(Deprecated)
|
Delete L2VPN service under Tier-0Delete L2VPN service for given Tier-0 locale service. |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Get L2VPN service under Tier-0Get L2VPN service for given Tier-0 locale service. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Create or patch L2VPN service under Tier-0Create or patch L2VPN service for given Tier-0 locale service. |
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Create or fully replace L2VPN service under Tier-0Create or fully replace L2VPN service for given Tier-0 locale service. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Get L2VPN sessions list result under Tier-0Get paginated list of all L2VPN sessions under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions
(Deprecated)
|
Delete L2VPN session under Tier-0Delete L2VPN session under Tier-0. When L2VPN Service is in CLIENT Mode, the L2VPN Session is deleted along with its transpot tunnels and related resources. |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get L2VPN Session under Tier-0Get L2VPN session under Tier-0. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or patch an L2VPN session under Tier-0Create or patch an L2VPN session under Tier-0. API supported only when L2VPN Service is in Server Mode. |
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or patch an L2VPN session under Tier-0 from Peer CodesCreate or patch an L2VPN session under Tier-0 from Peer Codes. In addition to the L2VPN Session, the IPSec VPN Session, along with the IKE, Tunnel, and DPD Profiles are created and owned by the system. IPSec VPN Service and Local Endpoint are created only when required, i.e., an IPSec VPN Service does not already exist, or an IPSec VPN Local Endpoint with same local address does not already exist. Updating the L2VPN Session can be performed only through this API by specifying new peer codes. Use of specific APIs to update the L2VPN Session and the different resources associated with it is not allowed, except for IPSec VPN Service and Local Endpoint, resources that are not system owned. API supported only when L2VPN Service is in Client Mode. Note: Please note that request is validated and any error messages returned from validation may include the new VPN path instead of the deprecated path. Both new path and old path refer to same resource. Also VPN path returned in the Alarm, GPRR payload may include the new VPN path. |
POST /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code
(Deprecated)
|
Create or fully replace L2VPN session under Tier-0Create or fully replace L2VPN session under Tier-0. API supported only when L2VPN Service is in Server Mode. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get L2VPN session detailed status under Tier-0- no enforcement point path specified: detailed tatus is evaluated on each enforcement point. - an enforcement point path is specified: detailed status is evaluated only on the given enforcement point. - source=realtime: detailed tatus is fetched realtime from the enforcement point. - source=cached: cached detailed status is returned. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/detailed-status
(Deprecated)
|
Get Tier-0 L2VPN session configuration for the peer siteGet peer config for the Tier-0 L2VPN session to configure the remote side of the tunnel. - no enforcement point path specified: L2VPN Session Peer Codes will be evaluated on each enforcement point. - enforcement point paths specified: L2VPN Session Peer Codes are evaluated only on the given enforcement points. API supported only when L2VPN Service is in Server Mode. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/peer-config
(Deprecated)
|
Get L2Vpn session remote mac for logical switchReturns L2Vpn session remote macs for a logical switch. Data is fetched from enforcement point. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/remote-mac
(Deprecated)
|
Get L2VPN session statistics under Tier-0- no enforcement point path specified: statistics are evaluated on each enforcement point. - an enforcement point path is specified: statistics are evaluated only on the given enforcement point. - source=realtime: statistics are fetched realtime from the enforcement point. - source=cached: cached statistics from the enforcement point are returned. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
|
List Policy NAT types.List all NAT sections under the given Tier-0 ID. For more details related to NAT section please refer to PolicyNAT schema. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/nat
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/nat |
List NAT RulesList NAT Rules from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules |
Delete NAT RuleDelete NAT Rule from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Get NAT RuleGet NAT Rule from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PUT/PATCH API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id} |
Create or update a NAT Rule on tier-0If a NAT Rule is not already present on Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>, create a new NAT Rule. If it already exists, update the NAT Rule. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact. |
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Create or update NAT RuleCreate or update NAT Rule on Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PUT API, the path returned in the PUT/GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact. |
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
|
Get NAT Rule StatisticsGet NAT Rule Statistics from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics |
List NAT Rules StatisticsList NAT Rules Statistics from Tier-0 denoted by Tier-0 ID. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/nat/statistics
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/nat/statistics |
Get IPSec VPN service list resultGet paginated list of all IPSec VPN services under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services
|
Delete IPSec VPN serviceDelete given IPSec VPN service under Tier-1. |
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}
|
Get IPSec VPN serviceGet given IPSec VPN service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}
|
Create or patch IPSec VPN serviceCreate or patch IPSec VPN service under Tier-1. |
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}
|
Create or fully replace IPSec VPN serviceCreate or fully replace IPSec VPN service under Tier-1. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}
|
Get IPSec VPN local endpoint list resultGet paginated list of all IPSec VPN local endpoints for a given ipsec vpn service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/local-endpoints
|
Delete IPSec VPN local endpointDelete IPSec VPN local endpoint for a ipsec vpn service under Tier-1. |
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Get IPSec VPN local endpointGet IPSec VPN local endpoint for a ipsec vpn service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Create or patch a custom IPSec VPN local endpointCreate or patch a custom IPSec VPN local endpoint for a given ipsec vpn service under Tier-1. |
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Create or fully replace IPSec VPN local endpointCreate or fully replace IPSec VPN local endpoint for a given ipsec vpn service under Tier-1. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
|
Get IPSec VPN sessions list resultGet paginated list of all IPSec VPN sessions for a given ipsec vpn service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions
|
Delete IPSec VPN sessionDelete IPSec VPN session for a given ipsec-vpn service under Tier-1. |
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Get IPSec VPN SessionGet IPSec VPN session without sensitive data for a ipsec vpn service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Get IPSec VPN SessionGet IPSec VPN session with senstive data for a ipsec vpn service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data
|
Create or patch an IPSec VPN sessionCreate or patch an IPSec VPN session for a ipsec vpn service under Tier-1. |
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Create or fully replace IPSec VPN sessionCreate or fully replace IPSec VPN session for a ipsec vpn service under Tier-1. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
|
Get IPSec VPN session detailed status under Tier-1- no enforcement point path specified: detailed status is evaluated on each enforcement point. - an enforcement point path is specified: detailed status is evaluated only on the given enforcement point. - source=realtime: detailed status is fetched realtime from the enforcement point. - source=cached: cached detailed status from enforcement point is returned. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status
|
Get IPSec VPN configuration for the peer siteDownload IPSec VPN configuration for the peer site. Peer config also contains PSK; be careful when sharing or storing it. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config
|
Get IPSec VPN session statistics under Tier-1- no enforcement point path specified: statistics are evaluated on each enforcement point. - an enforcement point path is specified: statistics are evaluated only on the given enforcement point. - source=realtime: statistics are fetched realtime from the enforcement point. - source=cached: cached statistics from enforcement point are returned. Please note that cache synchronization is based on triggering this API with source=realtime or empty source and not polling based. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
|
Reset the statistics of the given VPN sessionResets the statistics of the given VPN session. Since source of data is enforcement point, data is reset there. |
POST /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
POST /policy/api/v1/global-infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics |
Get IPSec VPN Session SummarySummarized view of all tier-1 IPSec VPN sessions for a specified service. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/ipsec-vpn-services/{service-id}/summary
|
Get L2VPN service list result under Tier-1Get paginated list of all L2VPN services under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services
|
Delete L2VPN service under Tier-1Delete L2VPN service for given Tier-1. |
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}
|
Get L2VPN service under Tier-1Get L2VPN service for given Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}
|
Create or patch L2VPN service under Tier-1Create or patch L2VPN service for given Tier-1. |
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}
|
Create or fully replace L2VPN service under Tier-1Create or fully replace L2VPN service for given Tier-1. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}
|
Get L2VPN sessions list result under Tier-1Get paginated list of all L2VPN sessions under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions
|
Delete L2VPN session under Tier-1Delete L2VPN session under Tier-1. When L2VPN Service is in CLIENT Mode, the L2VPN Session is deleted along with its transpot tunnels and related resources. |
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Get L2VPN Session under Tier-1Get L2VPN session under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Create or patch an L2VPN session under Tier-1Create or patch an L2VPN session under Tier-1. API supported only when L2VPN Service is in Server Mode. |
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Create or patch an L2VPN session under Tier-1 from Peer CodesCreate or patch an L2VPN session under Tier-1 from Peer Codes. In addition to the L2VPN Session, the IPSec VPN Session, along with the IKE, Tunnel, and DPD Profiles are created and owned by the system. IPSec VPN Service and Local Endpoint are created only when required, i.e., an IPSec VPN Service does not already exist, or an IPSec VPN Local Endpoint with same local address does not already exist. Updating the L2VPN Session can be performed only through this API by specifying new peer codes. Use of specific APIs to update the L2VPN Session and the different resources associated with it is not allowed, except for IPSec VPN Service and Local Endpoint, resources that are not system owned. API supported only when L2VPN Service is in Client Mode. |
POST /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code
|
Create or fully replace L2VPN session under Tier-1Create or fully replace L2VPN session under Tier-1. API supported only when L2VPN Service is in Server Mode. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}
|
Get L2VPN session detailed status under Tier-1- no enforcement point path specified: detailed tatus is evaluated on each enforcement point. - an enforcement point path is specified: detailed status is evaluated only on the given enforcement point. - source=realtime: detailed tatus is fetched realtime from the enforcement point. - source=cached: cached detailed status is returned. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}/detailed-status
|
Get Tier-1 L2VPN session configuration for the peer siteGet peer config for the Tier-1 L2VPN session to configure the remote side of the tunnel. - no enforcement point path specified: L2VPN Session Peer Codes will be evaluated on each enforcement point. - enforcement point paths specified: L2VPN Session Peer Codes are evaluated only on the given enforcement points. API supported only when L2VPN Service is in Server Mode. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}/peer-config
|
Get L2Vpn session remote mac for logical switchReturns L2Vpn session remote macs for a logical switch. Data is fetched from enforcement point. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}/remote-mac
|
Get L2VPN session statistics under Tier-1- no enforcement point path specified: statistics are evaluated on each enforcement point. - an enforcement point path is specified: statistics are evaluated only on the given enforcement point. - source=realtime: statistics are fetched realtime from the enforcement point. - source=cached: cached statistics from the enforcement point are returned. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/l2vpn-services/{service-id}/sessions/{session-id}/statistics
|
Get IPSec VPN service list resultGet paginated list of all IPSec VPN services for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services
(Deprecated)
|
Delete IPSec VPN serviceDelete IPSec VPN service for a given locale service under Tier-1. |
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Get IPSec VPN serviceGet IPSec VPN service for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Create or patch IPSec VPN serviceCreate or patch IPSec VPN service for a given locale service under Tier-1. |
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Create or fully replace IPSec VPN serviceCreate or fully replace IPSec VPN service for a given locale service under Tier-1. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}
(Deprecated)
|
Get IPSec VPN local endpoint list resultGet paginated list of all IPSec VPN local endpoints for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints
(Deprecated)
|
Delete IPSec VPN local endpointDelete IPSec VPN local endpoint for a given locale service under Tier-1. |
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Get IPSec VPN local endpointGet IPSec VPN local endpoint for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Create or patch a custom IPSec VPN local endpointCreate or patch a custom IPSec VPN local endpoint for a given locale service under Tier-1. |
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Create or fully replace IPSec VPN local endpointCreate or fully replace IPSec VPN local endpoint for a given locale service under Tier-1. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/local-endpoints/{local-endpoint-id}
(Deprecated)
|
Get IPSec VPN sessions list resultGet paginated list of all IPSec VPN sessions for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions
(Deprecated)
|
Delete IPSec VPN sessionDelete IPSec VPN session for a given locale service under Tier-1. |
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get IPSec VPN SessionGet IPSec VPN session with senstive data for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}?action=show_sensitive_data
(Deprecated)
|
Get IPSec VPN SessionGet IPSec VPN session without sensitive data for a given locale service under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or patch an IPSec VPN sessionCreate or patch an IPSec VPN session for a given locale service under Tier-1. |
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or fully replace IPSec VPN sessionCreate or fully replace IPSec VPN session for a given locale service under Tier-1. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get IPSec VPN session detailed status under Tier-1- no enforcement point path specified: detailed status is evaluated on each enforcement point. - an enforcement point path is specified: detailed status is evaluated only on the given enforcement point. - source=realtime: detailed status is fetched realtime from the enforcement point. - source=cached: cached detailed status from enforcement point is returned. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/detailed-status (Deprecated) |
Get IPSec VPN configuration for the peer siteDownload IPSec VPN configuration for the peer site. Peer config also contains PSK; be careful when sharing or storing it. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/peer-config
(Deprecated)
|
Get IPSec VPN session statistics under Tier-1- no enforcement point path specified: statistics are evaluated on each enforcement point. - an enforcement point path is specified: statistics are evaluated only on the given enforcement point. - source=realtime: statistics are fetched realtime from the enforcement point. - source=cached: cached statistics from enforcement point are returned. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics (Deprecated) |
Reset the statistics of the given VPN sessionResets the statistics of the given VPN session. Since source of data is enforcement point, data is reset there. |
POST /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/sessions/{session-id}/statistics (Deprecated) |
Get IPSec VPN Session SummarySummarized view of all tier-1 IPSec VPN sessions for a specified service. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary
(Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/ipsec-vpn-services/{service-id}/summary (Deprecated) |
Get L2VPN service list result under Tier-1Get paginated list of all L2VPN services under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services
(Deprecated)
|
Delete L2VPN service under Tier-1Delete L2VPN service for given Tier-1 locale service. |
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Get L2VPN service under Tier-1Get L2VPN service for given Tier-1 locale service. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Create or patch L2VPN service under Tier-1Create or patch L2VPN service for given Tier-1 locale service. |
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Create or fully replace L2VPN service under Tier-1Create or fully replace L2VPN service for given Tier-1 locale service. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}
(Deprecated)
|
Get L2VPN sessions list result under Tier-1Get paginated list of all L2VPN sessions under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions
(Deprecated)
|
Delete L2VPN session under Tier-1Delete L2VPN session under Tier-1. When L2VPN Service is in CLIENT Mode, the L2VPN Session is deleted along with its transpot tunnels and related resources. |
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get L2VPN Session under Tier-1Get L2VPN session under Tier-1. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or patch an L2VPN session under Tier-1Create or patch an L2VPN session under Tier-1. API supported only when L2VPN Service is in Server Mode. |
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Create or patch an L2VPN session under Tier-1 from Peer CodesCreate or patch an L2VPN session under Tier-1 from Peer Codes. In addition to the L2VPN Session, the IPSec VPN Session, along with the IKE, Tunnel, and DPD Profiles are created and owned by the system. IPSec VPN Service and Local Endpoint are created only when required, i.e., an IPSec VPN Service does not already exist, or an IPSec VPN Local Endpoint with same local address does not already exist. Updating the L2VPN Session can be performed only through this API by specifying new peer codes. Use of specific APIs to update the L2VPN Session and the different resources associated with it is not allowed, except for IPSec VPN Service and Local Endpoint, resources that are not system owned. API supported only when L2VPN Service is in Client Mode. |
POST /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}?action=create_with_peer_code
(Deprecated)
|
Create or fully replace L2VPN session under Tier-1Create or fully replace L2VPN session under Tier-1. API supported only when L2VPN Service is in Server Mode. Revision is optional for creation and required for update. |
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}
(Deprecated)
|
Get L2VPN session detailed status under Tier-1- no enforcement point path specified: detailed tatus is evaluated on each enforcement point. - an enforcement point path is specified: detailed status is evaluated only on the given enforcement point. - source=realtime: detailed tatus is fetched realtime from the enforcement point. - source=cached: cached detailed status is returned. sessions/<session-id>/detailed-status instead. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/detailed-status
(Deprecated)
|
Get Tier-1 L2VPN session configuration for the peer siteGet peer config for the Tier-1 L2VPN session to configure the remote side of the tunnel. - no enforcement point path specified: L2VPN Session Peer Codes will be evaluated on each enforcement point. - enforcement point paths specified: L2VPN Session Peer Codes are evaluated only on the given enforcement points. API supported only when L2VPN Service is in Server Mode. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/peer-config
(Deprecated)
|
Get L2Vpn session remote mac for logical switchReturns L2Vpn session remote macs for a logical switch. Data is fetched from enforcement point. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/remote-mac
(Deprecated)
|
Get L2VPN session statistics under Tier-1- no enforcement point path specified: statistics are evaluated on each enforcement point. - an enforcement point path is specified: statistics are evaluated only on the given enforcement point. - source=realtime: statistics are fetched realtime from the enforcement point. - source=cached: cached statistics from the enforcement point are returned. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/statistics
(Deprecated)
|
List Policy NAT types.List all NAT sections under the given Tier-1 ID. For more details related to NAT section please refer to PolicyNAT schema. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/nat
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/nat GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat |
List NAT RulesList NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules |
Delete NAT RuleDelete NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. |
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id} |
Get NAT RuleGet NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PATCH/PUT PoliycNatRule API, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id} |
Create or update a Nat RuleIf a NAT Rule is not already present on Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>, create a new NAT Rule. If it already exists, update the NAT Rule. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property, the path returned in the GET response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact. |
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id} |
Create or update NAT RuleCreate or update NAT Rule on Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. Note: IPSecVpnSession as Scope: Please note that old IPSecVpnSession policy path deprecated. If user specifiy old IPSecVpnSession path in the scope property in the PUT API, the path returned in the GET/PUT response payload will be a new path instead of the deprecated IPSecVpnSession path Both old and new IPSecVpnSession path refer to same resource. there is no functional impact. |
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id} |
Get NAT Rule StatisticsGet NAT Rule Statistics from Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}/statistics |
List NAT Rules StatisticsList NAT Rules Statistics from Tier-1 denoted by Tier-1 ID. |
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/nat/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/nat/statistics GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/nat/statistics |