Cisco Catalyst SD-WAN Secure Device Onboarding - Communication Plans API

openapi: 3.2.0
info:
  title: Others Secure Device Onboarding - Communication Plans API
  description: 'Other APIs

    Include APIs that do not belong to other categories'
  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: Secure Device Onboarding - Communication Plans
paths:
  /v1/securedeviceonboarding/{accountId}/commplans:
    get:
      tags:
      - Secure Device Onboarding - Communication Plans
      description: Get communication plans by account Id
      operationId: getCommPlansByAcctId
      parameters:
      - name: accountId
        in: path
        description: Service User Account ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                required:
                - communicationPlans
                - pageNumber
                type: object
                properties:
                  commPlans:
                    type: array
                    writeOnly: true
                    items:
                      required:
                      - apns
                      - lteApns
                      - lteEnabled
                      - name
                      type: object
                      properties:
                        apns:
                          type: array
                          description: List of APNs associated with the Comm Plan
                          example: '[{name:M2MTEST}]'
                          items:
                            required:
                            - name
                            type: object
                            properties:
                              name:
                                type: string
                            description: List of APNs associated with the Comm Plan
                            example: '[{name:M2MTEST}]'
                            $$ref: '#/components/schemas/Apn'
                        commPlanDescription:
                          type: string
                          description: Description of the communication plan.
                          example: sms data shared
                        commPlanName:
                          type: string
                          writeOnly: true
                        lteApns:
                          type: array
                          description: 'List of LTE APNs associated with the Comm Plan.Empty if lteEnabled is false '
                          example: []
                          items:
                            required:
                            - name
                            type: object
                            properties:
                              name:
                                type: string
                            description: 'List of LTE APNs associated with the Comm Plan.Empty if lteEnabled is false '
                            example: []
                            $$ref: '#/components/schemas/LteApn'
                        lteEnabled:
                          type: boolean
                          description: Specifies whether the Comm Plan has LTE enabled
                          example: false
                        name:
                          type: string
                          description: Name of the communication plan.
                          example: vm cp sms data share
                      $$ref: '#/components/schemas/CommunicationPlan'
                  communicationPlans:
                    type: array
                    description: List of communication plans.
                    example: Refer to CommunicationPlan
                    items:
                      required:
                      - apns
                      - lteApns
                      - lteEnabled
                      - name
                      type: object
                      properties:
                        apns:
                          type: array
                          description: List of APNs associated with the Comm Plan
                          example: '[{name:M2MTEST}]'
                          items:
                            required:
                            - name
                            type: object
                            properties:
                              name:
                                type: string
                            description: List of APNs associated with the Comm Plan
                            example: '[{name:M2MTEST}]'
                            $$ref: '#/components/schemas/Apn'
                        commPlanDescription:
                          type: string
                          description: Description of the communication plan.
                          example: sms data shared
                        commPlanName:
                          type: string
                          writeOnly: true
                        lteApns:
                          type: array
                          description: 'List of LTE APNs associated with the Comm Plan.Empty if lteEnabled is false '
                          example: []
                          items:
                            required:
                            - name
                            type: object
                            properties:
                              name:
                                type: string
                            description: 'List of LTE APNs associated with the Comm Plan.Empty if lteEnabled is false '
                            example: []
                            $$ref: '#/components/schemas/LteApn'
                        lteEnabled:
                          type: boolean
                          description: Specifies whether the Comm Plan has LTE enabled
                          example: false
                        name:
                          type: string
                          description: Name of the communication plan.
                          example: vm cp sms data share
                      $$ref: '#/components/schemas/CommunicationPlan'
                  pageNumber:
                    type: integer
                    description: Page Number.
                    format: int32
                    example: 1
                $$ref: '#/components/schemas/CommunicationPlansResponse'
              examples:
                Communication plans response example:
                  description: Communication plans response example
                  value: "[ \n     {\n      \"commPlanName\": \"vm cp sms data shared\",\n      \"apns\":[{\"name\":\"M2MTEST\"}]\n      \"lteApns\":[]\n      \"lteEnabled\":false\n     }\n    ]"
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Secure Device Onboarding-read