3 "_postman_id": "76860e78-4c44-45c1-9da0-ba001c0be587",
4 "name": "Policy Framework Administration API",
5 "description": "This collection lists all the Administration API's supported by ONAP Policy Framework. These API's are used to perform administrative operations for managing policies, groups, statistics & health information for all registered PDP engines.",
6 "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
10 "name": "PAP healthcheck",
11 "protocolProfileBehavior": {
12 "disableBodyPruning": true
18 "key": "Content-Type",
20 "value": "application/json"
25 "value": "application/json"
33 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/healthcheck",
44 "description": "This is an API to fetch current healthcheck information for the policy-pap component."
49 "name": "Policy Consolidated healthcheck",
50 "protocolProfileBehavior": {
51 "disableBodyPruning": true
57 "key": "Content-Type",
58 "value": "application/json",
63 "value": "application/json",
72 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/components/healthcheck",
84 "description": "This is an API to fetch current healthcheck information for all the policy framework components."
89 "name": "PdpGroup Query",
90 "protocolProfileBehavior": {
91 "disableBodyPruning": true
97 "key": "Content-Type",
99 "value": "application/json"
104 "value": "application/json"
112 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/pdps",
123 "description": "This is an API to fetch details of all PdpGroups currently available in Policy DB."
128 "name": "PdpGroup State Change",
133 "key": "Content-Type",
134 "value": "application/json",
139 "value": "application/json",
144 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/pdps/groups/defaultGroup?state=ACTIVE",
163 "description": "This is an API to change the current state of a PdpGroup (example - \"defaultGroup\") resulting in changing state of all the PDP instances registered with the PdpGroup. As of now, the allowed states are ACTIVE and PASSIVE."
168 "name": "Simple Deploy Policy",
173 "key": "Content-Type",
175 "value": "application/json"
180 "value": "application/json"
185 "raw": "{\r\n \"policies\" : [\r\n {\r\n \"policy-id\": \"operational.modifyconfig\",\r\n \"policy-version\": \"1.0.0\"\r\n }\r\n ]\r\n}"
188 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/pdps/policies",
200 "description": "This is an API to deploy one or more policies in all available & matching PdpGroups in Policy DB. The match is done based on supported policy types in the PdpSunGroup and the policy type referred by the given policy."
205 "name": "Simple Undeploy Policy",
211 "value": "application/json",
215 "key": "Content-Type",
216 "value": "application/json",
221 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/pdps/policies/operational.modifyconfig",
231 "operational.modifyconfig"
234 "description": "This is an API to undeploy one or more policies from all PdpGroups in Policy DB."
239 "name": "Create/Update PdpGroup",
244 "key": "Content-Type",
246 "value": "application/json"
251 "value": "application/json"
256 "raw": "{\n \"groups\": [\n {\n \"name\": \"SampleGroup\",\n \"pdpGroupState\": \"ACTIVE\",\n \"properties\": {},\n \"pdpSubgroups\": [\n {\n \"pdpType\": \"apex\",\n \"desiredInstanceCount\": 2,\n \"properties\": {},\n \"supportedPolicyTypes\": [\n {\n \"name\": \"onap.policies.controlloop.operational.common.Apex\",\n \"version\": \"1.0.0\"\n }\n ],\n \"policies\": []\n },\n {\n \"pdpType\": \"xacml\",\n \"desiredInstanceCount\": 1,\n \"properties\": {},\n \"supportedPolicyTypes\": [\n {\n \"name\": \"onap.policies.monitoring.*\",\n \"version\": \"1.0.0\"\n }\n ],\n \"policies\": []\n }\n ]\n }\n ]\n}"
259 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/pdps/groups/batch",
272 "description": "This is a generic API to create/update PdpGroups in Policy DB. However, the supportedPolicyTypes field of PdpSubGroup cannot be changed once created."
277 "name": "PDPGroup Deploy Policy",
282 "key": "Content-Type",
284 "value": "application/json"
289 "value": "application/json"
294 "raw": "{\n \"groups\": [\n {\n \"name\": \"defaultGroup\",\n \"deploymentSubgroups\": [\n {\n \"pdpType\": \"drools\",\n \"action\": \"POST\",\n \"policies\": [\n {\n \"name\": \"operational.modifyconfig\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n ]\n }\n ]\n}"
297 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/pdps/deployments/batch",
310 "description": "This is an API to deploy one or more policies to the specified PdpGroup, resulting in deployment of policies to all registered PDP instances of that specified PdpGroup."
315 "name": "PDPGroup Undeploy Policy",
320 "key": "Content-Type",
322 "value": "application/json"
327 "value": "application/json"
332 "raw": "{\n \"groups\": [\n {\n \"name\": \"defaultGroup\",\n \"deploymentSubgroups\": [\n {\n \"pdpType\": \"drools\",\n \"action\": \"DELETE\",\n \"policies\": [\n {\n \"name\": \"operational.modifyconfig\",\n \"version\": \"1.0.0\"\n }\n ]\n }\n ]\n }\n ]\n}"
335 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/pdps/deployments/batch",
348 "description": "This is an API to undeploy one or more policies from the specified PdpGroup, resulting in removal of policies from all registered PDP instances of that specified PdpGroup."
353 "name": "Fetch All Policy Status",
354 "protocolProfileBehavior": {
355 "disableBodyPruning": true
361 "key": "Content-Type",
363 "value": "application/json"
368 "value": "application/json"
376 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/policies/status",
388 "description": "This is a generic API to fetch status of all policies in the registered PDP instances."
393 "name": "Fetch All Policy Status in a Group",
394 "protocolProfileBehavior": {
395 "disableBodyPruning": true
401 "key": "Content-Type",
403 "value": "application/json"
408 "value": "application/json"
416 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/policies/status/defaultGroup",
429 "description": "This is a generic API to fetch status of all policies in the registered PDP instances in a PDP Group."
434 "name": "Fetch Policy Status in a Group",
435 "protocolProfileBehavior": {
436 "disableBodyPruning": true
442 "key": "Content-Type",
444 "value": "application/json"
449 "value": "application/json"
457 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/policies/status/defaultGroup/operational.modifyconfig",
468 "operational.modifyconfig"
471 "description": "This is a generic API to fetch status of all versions of a policy in the registered PDP instances in a PDP Group."
476 "name": "Fetch All Policy deployment Status",
477 "protocolProfileBehavior": {
478 "disableBodyPruning": true
484 "key": "Content-Type",
486 "value": "application/json"
491 "value": "application/json"
499 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/policies/deployed",
511 "description": "This is a generic API to fetch status of all deployed policies in the registered PDP instances."
516 "name": "Fetch Policy deployment Status",
517 "protocolProfileBehavior": {
518 "disableBodyPruning": true
524 "key": "Content-Type",
526 "value": "application/json"
531 "value": "application/json"
539 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/policies/deployed/operational.modifyconfig",
549 "operational.modifyconfig"
552 "description": "This is an API to fetch status of a specific deployed policy in the registered PDP instances."
557 "name": "Fetch All PDPs Statistics",
558 "protocolProfileBehavior": {
559 "disableBodyPruning": true
565 "key": "Content-Type",
566 "value": "application/json",
571 "value": "application/json",
580 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/pdps/statistics?recordCount=5",
593 "key": "recordCount",
598 "description": "This is an API to fetch current statistics information for the all registered PDP instances."
603 "name": "Fetch PdpGroup Statistics",
604 "protocolProfileBehavior": {
605 "disableBodyPruning": true
611 "key": "Content-Type",
613 "value": "application/json"
618 "value": "application/json"
626 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/pdps/statistics/defaultGroup?recordCount=5",
640 "key": "recordCount",
645 "description": "This is an API to fetch current statistics information for the all registered PDP instances of the specified PdpGroup (example - \"defaultGroup\")."
650 "name": "Fetch PdpSubGroup Statistics",
651 "protocolProfileBehavior": {
652 "disableBodyPruning": true
658 "key": "Content-Type",
660 "value": "application/json"
665 "value": "application/json"
673 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/pdps/statistics/defaultGroup/apex?recordCount=5",
688 "key": "recordCount",
693 "description": "This is an API to fetch current statistics information for the all registered PDP instances of the specified PdpGroup (example - \"defaultGroup\") & PdpSubgroup (example - \"apex\")."
698 "name": "Fetch PDP Statistics",
699 "protocolProfileBehavior": {
700 "disableBodyPruning": true
706 "key": "Content-Type",
708 "value": "application/json"
713 "value": "application/json"
721 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/pdps/statistics/defaultGroup/apex/dev-policy-apex-pdp-0?recordCount=5",
733 "dev-policy-apex-pdp-0"
737 "key": "recordCount",
742 "description": "This is an API to fetch current statistics information for the specified PDP instance (example - \"dev-policy-apex-pdp-0\") of the specified PdpGroup (example - \"defaultGroup\") & PdpSubgroup (example - \"apex\")."
747 "name": "Fetch All Policy Audit Records",
750 "listen": "prerequest",
755 "type": "text/javascript"
759 "protocolProfileBehavior": {
760 "disableBodyPruning": true
766 "key": "Content-Type",
768 "value": "application/json"
773 "value": "application/json"
781 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/policies/audit?recordCount=5",
794 "key": "recordCount",
799 "value": "1627219515",
804 "value": "1627478715",
809 "description": "This is a generic API to fetch audit records of all policies in the database."
814 "name": "Fetch All Policy Audit Records of a Group",
815 "protocolProfileBehavior": {
816 "disableBodyPruning": true
822 "key": "Content-Type",
824 "value": "application/json"
829 "value": "application/json"
837 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/policies/audit/defaultGroup?recordCount=5",
851 "key": "recordCount",
856 "value": "1627219515",
861 "value": "1627478715",
866 "description": "This is a generic API to fetch audit records of all policies in the database belonging to a PDP Group."
871 "name": "Fetch Policy Audit Records of a Group",
872 "protocolProfileBehavior": {
873 "disableBodyPruning": true
879 "key": "Content-Type",
881 "value": "application/json"
886 "value": "application/json"
894 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/policies/audit/defaultGroup/operational.modifyconfig/1.0.0?recordCount=5",
905 "operational.modifyconfig",
910 "key": "recordCount",
915 "value": "1627219515",
920 "value": "1627478715",
925 "description": "This is an API to fetch audit records of a policy in the database belonging to a PDP Group."
930 "name": "Fetch Policy Audit Records",
931 "protocolProfileBehavior": {
932 "disableBodyPruning": true
938 "key": "Content-Type",
940 "value": "application/json"
945 "value": "application/json"
953 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/policies/audit/operational.modifyconfig/1.0.0?recordCount=5",
963 "operational.modifyconfig",
968 "key": "recordCount",
973 "value": "1627219515",
978 "value": "1627478715",
983 "description": "This is an API to fetch audit records of a policy in the database."
988 "name": "Delete PdpGroup",
995 "value": "application/json"
998 "key": "Content-Type",
1000 "value": "application/json"
1004 "raw": "{{POLICY-PAP-URL}}/policy/pap/v1/pdps/groups/SampleGroup",
1006 "{{POLICY-PAP-URL}}"
1017 "description": "This is an API to delete a specific PdpGroup (example - \"SampleGroup\") currently available in Policy DB, resulting in removing all the PDP instances registered with the group."
1027 "value": "{{PASSWORD}}",
1032 "value": "{{USER}}",
1039 "listen": "prerequest",
1041 "type": "text/javascript",
1050 "type": "text/javascript",
1060 "value": "healthcheck",
1065 "value": "zb!XztG34",