...
Figure 1. Policy Engine Interfaces
The API contains the following services:
...
- createConfigRequestUsingPOST
- createConfigRequestUsingPOST1
- createConfigRequestUsingPUT
- createEventParameterRequestUsingPOST
- createFirewallConfigRequestUsingPUT
- createListConfigRequestUsingPOST
- createRequestUsingPUT
- deletePolicyRequestUsingDELETE
- listPAPsUsingGET
- listPDPsUsingGET
- pushPolicyRequestUsingPUT
- updateConfigRequestUsingPUT
- updateFirewallConfigRequestUsingPUT
- updateRequestUsingPUT
Policy Engine REST API
API and SDK Documentation
Version: 2.0
...
Policyengineservices
...
Gets the configuration from the PolicyDecisionPoint(PDP)
/getConfigByPolicyNameUsage and SDK Samples
curl -X POST "https://172.99.115.94:8480/PyPDPServer/getConfigByPolicyName"Parameters
Header parameters
| Name | Description |
|---|---|
| clientAuth* | string ClientAuth |
| xECOMPRequestID | string X-ECOMP-RequestID |
| authorization* | string Required |
| environment* | string Required |
...
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
...
Status: 404 - Not Found
...
Gets the configuration from the PolicyDecisionPoint(PDP)
/getConfigUsage and SDK Samples
curl -X POST "https://172.99.115.94:8480/PyPDPServer/getConfig"Parameters
Header parameters
| Name | Description |
|---|---|
| clientAuth* | string ClientAuth |
| xECOMPRequestID | string X-ECOMP-RequestID |
| authorization* | string Required |
| environment* | string Required |
...
Responses
Status: 200 - OK
...
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
...
Creates a Config Policy based on given Policy Parameters.
/createConfigUsage and SDK Samples
curl -X PUT "https://172.99.115.94:8480/PyPDPServer/createConfig"Parameters
Header parameters
| Name | Description |
|---|---|
| clientAuth* | string ClientAuth |
| xECOMPRequestID | string X-ECOMP-RequestID |
| authorization* | string Required |
| environment* | string Required |
...
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
...
Sends the Events specified to the Policy Engine
/sendEventUsage and SDK Samples
curl -X POST "https://172.99.115.94:8480/PyPDPServer/sendEvent"Parameters
Header parameters
| Name | Description |
|---|---|
| clientAuth* | string ClientAuth |
| xECOMPRequestID | string X-ECOMP-RequestID |
| authorization* | string Required |
| environment* | string Required |
...
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
...
...
Creates a Config Firewall Policy
/createFirewallConfigUsage and SDK Samples
curl -X PUT "https://172.99.115.94:8480/PyPDPServer/createFirewallConfig"Parameters
Header parameters
...
ClientAuth
Required
...
X-ECOMP-RequestID
...
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
...
...
Gets the configuration from the PDP
/listConfigUsage and SDK Samples
curl -X POST "https://172.99.115.94:8480/PyPDPServer/listConfig"Parameters
Header parameters
| Name | Description |
|---|---|
| clientAuth* | string ClientAuth |
| xECOMPRequestID | string X-ECOMP-RequestID |
| authorization* | string Required |
| environment* | string Required |
...
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
...
...
Creates a Policy based on given Policy Parameters.
/createPolicyUsage and SDK Samples
curl -X PUT "https://172.99.115.94:8480/PyPDPServer/createPolicy"Parameters
Header parameters
| Name | Description |
|---|---|
| clientAuth* | string ClientAuth |
| xECOMPRequestID | string X-ECOMP-RequestID |
| authorization* | string Required |
| environment* | string Required |
...
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
...
...
Deletes the specified policy from the PDP Group or PAP.
/deletePolicyUsage and SDK Samples
curl -X DELETE "https://172.99.115.94:8480/PyPDPServer/deletePolicy"Parameters
Header parameters
...
ClientAuth
Required
...
X-ECOMP-RequestID
...
Responses
Status: 200 - OK
...
Status: 401 - Unauthorized
Status: 403 - Forbidden
...
Gets the PAPs that are listed to provide service.
/papsUsage and SDK Samples
...
Parameters
Header parameters
| Name | Description |
|---|---|
| authorization* | string Required |
Responses
Status: 200 - OK
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
...
Gets the PDPs that are listed to provide service.
/pdpsUsage and SDK Samples
curl -X GET "https://172.99.115.94:8480/PyPDPServer/pdps"Parameters
Header parameters
| Name | Description |
|---|---|
| authorization* | string Required |
Responses
Status: 200 - OK
...
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
...
Pushes the specified policy to the PDP Group.
/pushPolicyUsage and SDK Samples
curl -X PUT "https://172.99.115.94:8480/PyPDPServer/pushPolicy"Parameters
Header parameters
| Name | Description |
|---|---|
| clientAuth* | string ClientAuth |
| xECOMPRequestID | string X-ECOMP-RequestID |
| authorization* | string Required |
| environment* | string Required |
...
Responses
...
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
...
Updates a Config Policy based on given Policy Parameters.
/updateConfigUsage and SDK Samples
curl -X PUT "https://172.99.115.94:8480/PyPDPServer/updateConfig"Parameters
Header parameters
| Name | Description |
|---|---|
| clientAuth* | string ClientAuth |
| xECOMPRequestID | string X-ECOMP-RequestID |
| authorization* | string Required |
| environment* | string Required |
...
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
...
...
Updates a Config Firewall Policy
/updateFirewallConfigUsage and SDK Samples
curl -X PUT "https://172.99.115.94:8480/PyPDPServer/updateFirewallConfig"Parameters
Header parameters
...
ClientAuth
Required
...
X-ECOMP-RequestID
...
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
...
...
Updates a Policy based on given Policy Parameters.
/updatePolicyUsage and SDK Samples
curl -X PUT "https://172.99.115.94:8480/PyPDPServer/updatePolicy"Parameters
Header parameters
...
ClientAuth
Required
...
X-ECOMP-RequestID
...
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
Suggestions, contact, support and error reporting;
Information URL: https://helloreverb.com
Contact Info: hello@helloreverb.com
...