Figure 1 shows the interfaces to the Policy Engine:
Figure 1. Policy Engine Interfaces
The API contains the following services:
Service | Method | Description |
---|---|---|
getConfig | POST | Gets the configuration from the Policy Decision Point |
sendEvent | POST | Sends specified events to the Policy Engine |
pushPolicy | PUT | Pushes specified policy to the PDP Group |
createPolicy | PUT | Creates a Policy based on given Policy Parameters |
updatePolicy | PUT | Updates a Policy based on given Policy Parameters |
- 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
This API helps applications across Domain 2.0 Platform to make queries against Policy Engine
Policyengineservices
createConfigRequestUsingPOST
Gets the configuration from the PolicyDecisionPoint(PDP)
/getConfigByPolicyName
Usage 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 |
Body parameters
Name | Description |
---|---|
pep * |
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
createConfigRequestUsingPOST1
Gets the configuration from the PolicyDecisionPoint(PDP)
/getConfig
Usage 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 |
Body parameters
Name | Description |
---|---|
pep * |
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
createConfigRequestUsingPUT
Creates a Config Policy based on given Policy Parameters.
/createConfig
Usage 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 |
Body parameters
Name | Description |
---|---|
pep * |
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
createEventParameterRequestUsingPOST
Sends the Events specified to the Policy Engine
/sendEvent
Usage 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 |
Body parameters
Name | Description |
---|---|
pep * |
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
createFirewallConfigRequestUsingPUT
Creates a Config Firewall Policy
/createFirewallConfig
Usage and SDK Samples
curl -X PUT "https://172.99.115.94:8480/PyPDPServer/createFirewallConfig"
Parameters
Header parameters
Name | Description |
---|---|
clientAuth* | string ClientAuth |
xECOMPRequestID | string X-ECOMP-RequestID |
authorization* | string Required |
environment* | string Required |
Body parameters
Name | Description |
---|---|
pep * |
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
createListConfigRequestUsingPOST
Gets the configuration from the PDP
/listConfig
Usage 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 |
Body parameters
Name | Description |
---|---|
pep * |
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
createRequestUsingPUT
Creates a Policy based on given Policy Parameters.
/createPolicy
Usage 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 |
Body parameters
Name | Description |
---|---|
pep * |
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
deletePolicyRequestUsingDELETE
Deletes the specified policy from the PDP Group or PAP.
/deletePolicy
Usage and SDK Samples
curl -X DELETE "https://172.99.115.94:8480/PyPDPServer/deletePolicy"
Parameters
Header parameters
Name | Description |
---|---|
clientAuth* | string ClientAuth |
xECOMPRequestID | string X-ECOMP-RequestID |
authorization* | string Required |
environment* | string Required |
Body parameters
Name | Description |
---|---|
pep * |
Responses
Status: 200 - OK
Status: 204 - No Content
Status: 401 - Unauthorized
Status: 403 - Forbidden
listPAPsUsingGET
Gets the PAPs that are listed to provide service.
/paps
Usage and SDK Samples
curl -X GET "https://172.99.115.94:8480/PyPDPServer/paps"
Parameters
Header parameters
Name | Description |
---|---|
authorization* | string Required |
Responses
Status: 200 - OK
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
listPDPsUsingGET
Gets the PDPs that are listed to provide service.
/pdps
Usage 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
pushPolicyRequestUsingPUT
Pushes the specified policy to the PDP Group.
/pushPolicy
Usage 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 |
Body parameters
Name | Description |
---|---|
pep * |
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
updateConfigRequestUsingPUT
Updates a Config Policy based on given Policy Parameters.
/updateConfig
Usage 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 |
Body parameters
Name | Description |
---|---|
pep * |
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
updateFirewallConfigRequestUsingPUT
Updates a Config Firewall Policy
/updateFirewallConfig
Usage and SDK Samples
curl -X PUT "https://172.99.115.94:8480/PyPDPServer/updateFirewallConfig"
Parameters
Header parameters
Name | Description |
---|---|
clientAuth* | string ClientAuth |
xECOMPRequestID | string X-ECOMP-RequestID |
authorization* | string Required |
environment* | string Required |
Body parameters
Name | Description |
---|---|
pep * |
Responses
Status: 200 - OK
Status: 201 - Created
Status: 401 - Unauthorized
Status: 403 - Forbidden
Status: 404 - Not Found
updateRequestUsingPUT
Updates a Policy based on given Policy Parameters.
/updatePolicy
Usage and SDK Samples
curl -X PUT "https://172.99.115.94:8480/PyPDPServer/updatePolicy"
Parameters
Header parameters
Name | Description |
---|---|
clientAuth* | string ClientAuth |
xECOMPRequestID | string X-ECOMP-RequestID |
authorization* | string Required |
environment* | string Required |
Body parameters
Name | Description |
---|---|
pep * |
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
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Generated 2017-02-10T16:15:29.480Z