Cisco Catalyst SD-WAN Policy - Policy Group API

openapi: 3.2.0
info:
  title: UX 2.0 Configuration Policy - Policy Group API
  description: "Configuration of UX 2.0 device, policy, and topology\nIncludes API operations for the following\n  Configuration Groups (SD-WAN and SD-Routing)\n  Policy Groups\n  Topology Groups"
  contact:
    email: vmanage@cisco.com
  license:
    name: Commercial License
    url: https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html
  version: 26.1.0+2026-01-06
  x-provenance:
    method: harvested
    authored_by: Cisco Catalyst SD-WAN
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    provider_published: true
    source_host: pubhub.devnetcloud.com
    note: 4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host.
  x-evidence:
  - type: source
    url: https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/
  - type: source
    url: https://developer.cisco.com/docs/sdwan/
servers:
- url: /dataservice
tags:
- name: Policy - Policy Group
paths:
  /v1/policy-group:
    post:
      tags:
      - Policy - Policy Group
      description: Create a new Policy Group
      operationId: CreatePolicyGroup
      requestBody:
        description: Policy Group
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  pattern: ^[^&<>! "]+$
                  minLength: 1
                  maxLength: 128
                  $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef'
                description:
                  type: string
                solution:
                  type: string
                  enum:
                  - sdwan
                  - sd-routing
                profiles:
                  type: array
                  description: list of profile ids that belongs to the policy group
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                    required:
                    - id
                    additionalProperties: false
                    $$ref: '#/components/schemas/PolicygroupCommonPostRequest_profileIdObjDef'
                  uniqueItems: true
                  additionalProperties: false
                fromPolicyGroup:
                  type: object
                  description: from another policy group
                  oneOf:
                  - properties:
                      copy:
                        type: string
                        pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
                        $$ref: '#/components/schemas/CommonCommonDefs_uuidDef'
                    required:
                    - copy
                    additionalProperties: false
                  $$ref: '#/components/schemas/PolicygroupCommonPostRequest_fromPolicyGroupDef'
              required:
              - name
              - description
              - solution
              additionalProperties: false
              $$ref: '#/components/schemas/PolicygroupCommonPostRequest_SchemaPayload'
            examples:
              CEDGE-PolicyGroup1-NY:
                value:
                  name: CEDGE-PolicyGroup1-NY
                  description: CEDGE Policy Group 1 for devices at site NY
                  solution: sdwan
                  profiles:
                  - id: EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FED
                  - id: 4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4
                  - id: 4C56e3c3-C67F-Cf66-d02f-8c666bd005CC
                $$ref: '#/components/examples/PolicygroupCommonPostRequest_CEDGE-PolicyGroup1-NY'
              CEDGE-PolicyGroup1-COPY:
                value:
                  name: CEDGE-PolicyGroup1-COPY
                  description: Copy Policy Group from EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99
                  solution: sdwan
                  fromPolicyGroup:
                    copy: EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993F99
                $$ref: '#/components/examples/PolicygroupCommonPostRequest_CEDGE-PolicyGroup1-COPY'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
                  profiles:
                    type: array
                    description: (Optional - only applicable for AON) List of profile ids that belongs to the policy group
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        profileType:
                          type: string
                          enum:
                          - global
                      required:
                      - id
                      - profileType
                      additionalProperties: false
                      $$ref: '#/components/schemas/PolicygroupCommonPostResponse_profileObjDef'
                required:
                - id
                additionalProperties: false
                $$ref: '#/components/schemas/PolicygroupCommonPostResponse_SchemaPayload'
              examples:
                example_1:
                  value:
                    id: 3EEF02A6-DD2A-bE42-ae6d-cda4CF2C30ac
                  $$ref: '#/components/examples/PolicygroupCommonPostResponse_example_1'
                example_2:
                  value:
                    id: 5eDFc2F7-3F0A-0Efe-6E1f-E5caAE0C6060
                    profiles:
                    - id: 002C4d1e-AA45-8e75-8CAB-C9CA0FE882a6
                      profileType: global
                  $$ref: '#/components/examples/PolicygroupCommonPostResponse_example_2'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Policy Group-write
    get:
      tags:
      - Policy - Policy Group
      description: Get a Policy Group by Solution
      operationId: GetPolicyGroupBySolution
      parameters:
      - name: solution
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  required:
                  - name
                  - solution
                  - state
                  - version
                  type: object
                  properties:
                    copyInfo:
                      type: string
                    createdBy:
                      type: string
                      description: User who last created this.
                      readOnly: true
                    createdOn:
                      type: integer
                      description: Timestamp of creation
                      format: int64
                      readOnly: true
                    description:
                      type: string
                      description: Description of the  Group.
                      example: group for west coast retail stores
                    devices:
                      uniqueItems: true
                      type: array
                      items:
                        type: string
                    id:
                      type: string
                      description: System generated unique identifier of the  Group in UUID format.
                      example: 6fa14197-c25f-4a14-b81b-299de32ed2ca
                    lastUpdatedBy:
                      type: string
                      description: User who last updated this.
                      readOnly: true
                    lastUpdatedOn:
                      type: integer
                      description: Timestamp of last update
                      format: int64
                      readOnly: true
                    name:
                      type: string
                      description: Name of the  Group. Must be unique.
                      example: West coast retail stores
                    numberOfDevices:
                      type: integer
                      format: int64
                    numberOfDevicesUpToDate:
                      type: integer
                      format: int64
                    origin:
                      type: string
                    originInfo:
                      type: object
                      additionalProperties:
                        type: string
                    profiles:
                      type: array
                      description: List of devices UUIDs associated with this group
                      example:
                      - id: 6fa14197-c25f-4a14-b81b-299de32ed2ca
                        name: system feature profile
                        solution: sdwan
                        type: system
                        description: Profile file description
                        lastUpdatedBy: admin
                        lastUpdatedOn: 1694179200000
                        createdBy: admin
                        createdOn: 1694092800000
                        profileParcelCount: 5
                        origin: internal
                      items:
                        required:
                        - name
                        - solution
                        - type
                        type: object
                        properties:
                          createdBy:
                            type: string
                            description: User who last created this.
                            readOnly: true
                          createdOn:
                            type: integer
                            description: Timestamp of creation
                            format: int64
                            readOnly: true
                          description:
                            type: string
                            description: Description of the feature Profile.
                            example: Profile file description
                          id:
                            type: string
                            description: System generated unique identifier of the feature profile in UUID format.
                            example: 6fa14197-c25f-4a14-b81b-299de32ed2ca
                          lastUpdatedBy:
                            type: string
                            description: User who last updated this.
                            readOnly: true
                          lastUpdatedOn:
                            type: integer
                            description: Timestamp of last update
                            format: int64
                            readOnly: true
                          name:
                            type: string
                            description: Name of the feature Profile. Must be unique.
                            example: system feature profile
                          origin:
                            type: string
                          profileParcelCount:
                            type: integer
                            description: Number of Parcels attached with Feature Profile
                            format: int64
                            readOnly: true
                          solution:
                            type: string
                            description: Solution of the feature Profile.
                            example: sdwan
                          type:
                            type: string
                            description: Type of the feature Profile.
                            example: system
                        $$ref: '#/components/schemas/FeatureProfile'
                    solution:
                      type: string
                      description: Specify one of the device platform solution
                      example: sdwan
                      enum:
                      - mobility
                      - sdwan
                      - sd-routing
                      - common
                      - nfvirtual
                      - service-insertion
                      - cellulargateway
                    source:
                      type: string
                      description: Source of group
                      example: retail_workflow
                    state:
                      type: string
                      description: ' Group Deployment state'
                      example: ' Group Deployment state.Initial state Deployed '
                    version:
                      type: integer
                      description: ' Group Version Flag'
                      format: int64
                  $$ref: '#/components/schemas/PolicyGroup'
              examples:
                West coast retail stores:
                  value:
                  - description: group for west coast retail stores
                    id: 6fa14197-c25f-4a14-b81b-299de32ed2ca
                    name: West coast retail stores
                    profiles:
                    - description: Profile file description
                      id: 6fa14197-c25f-4a14-b81b-299de32ed2ca
                      name: system feature profile
                      solution: sdwan
                      type: system
                    solution: sdwan
                    source: retail_workflow
                    state: ' Group Deployment state.Initial state Deployed '
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Policy Group-read
  /v1/policy-group/{policyGroupId}:
    get:
      tags:
      - Policy - Policy Group
      description: Get a Policy Group by ID
      operationId: GetPolicyGroup
      parameters:
      - name: policyGroupId
        in: path
        required: true
        schema:
          pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                required:
                - name
                - solution
                - state
                - version
                type: object
                properties:
                  copyInfo:
                    type: string
                  createdBy:
                    type: string
                    description: User who last created this.
                    readOnly: true
                  createdOn:
                    type: integer
                    description: Timestamp of creation
                    format: int64
                    readOnly: true
                  description:
                    type: string
                    description: Description of the  Group.
                    example: group for west coast retail stores
                  devices:
                    uniqueItems: true
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                    description: System generated unique identifier of the  Group in UUID format.
                    example: 6fa14197-c25f-4a14-b81b-299de32ed2ca
                  lastUpdatedBy:
                    type: string
                    description: User who last updated this.
                    readOnly: true
                  lastUpdatedOn:
                    type: integer
                    description: Timestamp of last update
                    format: int64
                    readOnly: true
                  name:
                    type: string
                    description: Name of the  Group. Must be unique.
                    example: West coast retail stores
                  numberOfDevices:
                    type: integer
                    format: int64
                  numberOfDevicesUpToDate:
                    type: integer
                    format: int64
                  origin:
                    type: string
                  originInfo:
                    type: object
                    additionalProperties:
                      type: string
                  profiles:
                    type: array
                    description: List of devices UUIDs associated with this group
                    example:
                    - id: 6fa14197-c25f-4a14-b81b-299de32ed2ca
                      name: system feature profile
                      solution: sdwan
                      type: system
                      description: Profile file description
                      lastUpdatedBy: admin
                      lastUpdatedOn: 1694179200000
                      createdBy: admin
                      createdOn: 1694092800000
                      profileParcelCount: 5
                      origin: internal
                    items:
                      required:
                      - name
                      - solution
                      - type
                      type: object
                      properties:
                        createdBy:
                          type: string
                          description: User who last created this.
                          readOnly: true
                        createdOn:
                          type: integer
                          description: Timestamp of creation
                          format: int64
                          readOnly: true
                        description:
                          type: string
                          description: Description of the feature Profile.
                          example: Profile file description
                        id:
                          type: string
                          description: System generated unique identifier of the feature profile in UUID format.
                          example: 6fa14197-c25f-4a14-b81b-299de32ed2ca
                        lastUpdatedBy:
                          type: string
                          description: User who last updated this.
                          readOnly: true
                        lastUpdatedOn:
                          type: integer
                          description: Timestamp of last update
                          format: int64
                          readOnly: true
                        name:
                          type: string
                          description: Name of the feature Profile. Must be unique.
                          example: system feature profile
                        origin:
                          type: string
                        profileParcelCount:
                          type: integer
                          description: Number of Parcels attached with Feature Profile
                          format: int64
                          readOnly: true
                        solution:
                          type: string
                          description: Solution of the feature Profile.
                          example: sdwan
                        type:
                          type: string
                          description: Type of the feature Profile.
                          example: system
                      $$ref: '#/components/schemas/FeatureProfile'
                  solution:
                    type: string
                    description: Specify one of the device platform solution
                    example: sdwan
                    enum:
                    - mobility
                    - sdwan
                    - sd-routing
                    - common
                    - nfvirtual
                    - service-insertion
                    - cellulargateway
                  source:
                    type: string
                    description: Source of group
                    example: retail_workflow
                  state:
                    type: string
                    description: ' Group Deployment state'
                    example: ' Group Deployment state.Initial state Deployed '
                  version:
                    type: integer
                    description: ' Group Version Flag'
                    format: int64
                $$ref: '#/components/schemas/PolicyGroup'
              examples:
                West coast retail stores:
                  value:
                    description: group for west coast retail stores
                    id: 6fa14197-c25f-4a14-b81b-299de32ed2ca
                    name: West coast retail stores
                    profiles:
                    - description: Profile file description
                      id: 6fa14197-c25f-4a14-b81b-299de32ed2ca
                      name: system feature profile
                      solution: sdwan
                      type: system
                    solution: sdwan
                    source: retail_workflow
                    state: ' Group Deployment state.Initial state Deployed '
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Policy Group-read
    put:
      tags:
      - Policy - Policy Group
      description: Edit a Policy Group
      operationId: EditPolicyGroup
      parameters:
      - name: policyGroupId
        in: path
        required: true
        schema:
          pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
          type: string
      requestBody:
        description: Policy Group
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  pattern: ^[^&<>! "]+$
                  minLength: 1
                  maxLength: 128
                  $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef'
                description:
                  type: string
                solution:
                  type: string
                  enum:
                  - sdwan
                  - sd-routing
                profiles:
                  type: array
                  description: list of profile ids that belongs to the policy group
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                    required:
                    - id
                    additionalProperties: false
                    $$ref: '#/components/schemas/PolicygroupCommonPutRequest_profileIdObjDef'
                  uniqueItems: true
                  additionalProperties: false
              required:
              - name
              - description
              - solution
              additionalProperties: false
              $$ref: '#/components/schemas/PolicygroupCommonPutRequest_SchemaPayload'
            examples:
              CEDGE-PolicyGroup1-NY:
                value:
                  name: CEDGE-PolicyGroup1-NY
                  description: CEDGE Policy Group 1 for devices at site NY
                  solution: sdwan
                  profiles:
                  - id: EEBE1AaD-DbC6-A9C2-E5F2-a9aFDD993FED
                  - id: 4D7eb1e4-Bf34-9aeA-58d8-C86824ECF8f4
                  - id: 4C56e3c3-C67F-Cf66-d02f-8c666bd005CC
                $$ref: '#/components/examples/PolicygroupCommonPutRequest_CEDGE-PolicyGroup1-NY'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
                  profiles:
                    type: array
                    description: (Optional - only applicable for AON) List of profile ids that belongs to the Policy group
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        profileType:
                          type: string
                          enum:
                          - global
                      required:
                      - id
                      - profileType
                      additionalProperties: false
                      $$ref: '#/components/schemas/PolicygroupCommonPutResponse_profileObjDef'
                required:
                - id
                additionalProperties: false
                $$ref: '#/components/schemas/PolicygroupCommonPutResponse_SchemaPayload'
              examples:
                example_1:
                  value:
                    id: 3EEF02A6-DD2A-bE42-ae6d-cda4CF2C30ac
                  $$ref: '#/components/examples/PolicygroupCommonPutResponse_example_1'
                example_2:
                  value:
                    id: 5eDFc2F7-3F0A-0Efe-6E1f-E5caAE0C6060
                    profiles:
                    - id: 002C4d1e-AA45-8e75-8CAB-C9CA0FE882a6
                      profileType: global
                  $$ref: '#/components/examples/PolicygroupCommonPutResponse_example_2'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Policy Group-write
    delete:
      tags:
      - Policy - Policy Group
      description: Delete Policy Group
      operationId: DeletePolicyGroup
      parameters:
      - name: policyGroupId
        in: path
        required: true
        schema:
          pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
          type: string
      - name: deleteProfiles
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Policy Group-write
  /v1/policy-group/{policyGroupId}/device/associate:
    get:
      tags:
      - Policy - Policy Group
      description: Get devices association with a policy group
      operationId: GetPolicyGroupAssociation
      parameters:
      - name: policyGroupId
        in: path
        required: true
        schema:
          type: string
      - name: associatedGroups
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Policy Group > Device-read
    put:
      tags:
      - Policy - Policy Group
      description: Move the devices from one policy group to another
      operationId: UpdatePolicyGroupAssociation
      parameters:
      - name: policyGroupId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                devices:
                  type: array
                  description: list of device ids that policy group need to be associated with
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        pattern: ^[a-zA-Z0-9\-/]+$
                    required:
                    - id
                    additionalProperties: false
                    $$ref: '#/components/schemas/PolicygroupCommonAssociatePutRequest_deviceIdDef'
                  uniqueItems: true
                  additionalProperties: false
              required:
              - devices
              additionalProperties: false
              $$ref: '#/components/schemas/PolicygroupCommonAssociatePutRequest_SchemaPayload'
            examples:
              example_1:
                value:
                  devices:
                  - id: y-e8
                  - id: DFVIWeA6Kl2
                $$ref: '#/components/examples/PolicygroupCommonAssociatePutRequest_example_1'
              example_2:
                value:
                  devices:
                  - id: zTC8Rw
                  - id: xy
                $$ref: '#/components/examples/PolicygroupCommonAssociatePutRequest_example_2'
        required: true
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Policy Group > Device-write
    delete:
      tags:
      - Policy - Policy Group
      description: Delete Policy Group Association from devices
      operationId: DeletePolicyGroupAssociation
      parameters:
      - name: policyGroupId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                devices:
                  type: array
                  description: list of device ids that policy group need to be associated with
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        pattern: ^[a-zA-Z0-9\-/]+$
                    required:
                    - id
                    additionalProperties: false
                    $$ref: '#/components/schemas/PolicygroupCommonAssociateDeleteRequest_deviceIdDef'
                  uniqueItems: true
                  minItems: 1
                  additionalProperties: false
              required:
              - devices
              additionalProperties: false
              $$ref: '#/components/schemas/PolicygroupCommonAssociateDeleteRequest_SchemaPayload'
            examples:
              example_1:
                value:
                  devices:
                  - id: y-e8
                  - id: DFVIWeA6Kl2
                $$ref: '#/components/examples/PolicygroupCommonAssociateDeleteRequest_example_1'
              example_2:
                value:
                  devices:
                  - id: zTC8Rw
                  - id: xy
                $$ref: '#/components/examples/PolicygroupCommonAssociateDeleteRequest_example_2'
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Policy Group > Device-write
    post:
      tags:
      - Policy - Policy Group
      description: Create associations with device and a policy group
      operationId: CreatePolicyGroupAssociation
      parameters:
      - name: policyGroupId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                devices:
                  type: array
                  description: list of device ids that policy group need to be associated with
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        pattern: ^[a-zA-Z0-9\-/]+$
             

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-sdwan/refs/heads/main/openapi/cisco-catalyst-sdwan-policy-policy-group-api-openapi.yml