Skip to content

Policy Groups

Policy Groups follow the same pattern as Configuration Groups but focus on policy-related profiles.

POST /v1/policy-group
Content-Type: application/json

Request Body:

{
"name": "Branch-Policy-PG",
"description": "Policy group for branch offices",
"solution": "sdwan",
"profiles": [
{ "id": "policy-profile-uuid-1111" },
{ "id": "policy-profile-uuid-2222" }
]
}
Field Type Required Description
name string Unique name
description string Description
solution string sdwan or sd-routing
profiles array References to Policy Feature Profiles

Response — 200 OK:

{
"id": "pg-uuid-0001-0002-0003-000000000001"
}

Operation Method Endpoint
List all GET /v1/policy-group
Get by ID GET /v1/policy-group/{policyGroupId}
Edit PUT /v1/policy-group/{policyGroupId}
Delete DELETE /v1/policy-group/{policyGroupId}

All follow the same request/response patterns as Configuration Groups (Section 5.2–5.5).


Operation Method Endpoint
Associate POST /v1/policy-group/{policyGroupId}/device/associate
Move PUT /v1/policy-group/{policyGroupId}/device/associate
Disassociate DELETE /v1/policy-group/{policyGroupId}/device/associate
Get associations GET /v1/policy-group/{policyGroupId}/device/associate

Same request body pattern: { "devices": [{ "id": "device-uuid" }] }


Operation Method Endpoint
Fetch variables POST /v1/policy-group/{policyGroupId}/device/variables
Get variables GET /v1/policy-group/{policyGroupId}/device/variables
Assign variables PUT /v1/policy-group/{policyGroupId}/device/variables
Get schema GET /v1/policy-group/{policyGroupId}/device/variables/schema
Preview POST /v1/policy-group/{policyGroupId}/device/{deviceId}/preview
Get rules GET /v1/policy-group/{policyGroupId}/rules

Same request/response patterns as Configuration Groups (Section 5.10–5.11, 5.13).


POST /v1/policy-group/{policyGroupId}/device/deploy
Content-Type: application/json

Response — 200 OK:

{
"parentTaskId": "task-uuid-policy-deploy-001"
}