Cisco Catalyst SD-WAN Configuration - Feature Profile (Mobility) API

openapi: 3.2.0
info:
  title: Feature Profiles - Mobility and NFV Configuration - Feature Profile (Mobility) API
  description: "Feature profiles associated with UX 2.0 configuration\nIncludes API operations for the following:\n  Feature Profiles in Mobility and NFV Solutions\n  Supporting mobility features and Network Function Virtualization (NFV) configurations."
  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: Configuration - Feature Profile (Mobility)
paths:
  /v1/feature-profile/mobility/cli:
    get:
      tags:
      - Configuration - Feature Profile (Mobility)
      description: Get Mobility Cli Feature Profiles
      operationId: GetMobilityCliFeatureProfile
      parameters:
      - name: offset
        in: query
        description: Pagination offset
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: Pagination limit
        schema:
          type: integer
          format: int32
          default: 0
      - name: referenceCount
        in: query
        description: get associated group details
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    profileId:
                      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'
                    profileName:
                      type: string
                      pattern: ^[^&<>! "]+$
                      minLength: 1
                      maxLength: 128
                      $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef'
                    profileType:
                      type: string
                      enum:
                      - cli
                    createdBy:
                      type: string
                      description: User who last created this.
                      readOnly: true
                    createdOn:
                      type: integer
                      description: Timestamp of creation
                      format: int64
                      readOnly: true
                    lastUpdatedBy:
                      type: string
                      description: User who last updated this.
                      readOnly: true
                    lastUpdatedOn:
                      type: integer
                      description: Timestamp of last update
                      format: int64
                      readOnly: true
                    description:
                      type: string
                    solution:
                      type: string
                      enum:
                      - mobility
                $$ref: '#/components/schemas/getListMobilityCliPayload'
              examples:
                get response example:
                  value:
                  - profileId: bc99ae4f-0ac3-4a51-95cb-c718953143ce
                    profileName: cg1_LAN
                    solution: mobility
                    profileType: cli
                    createdBy: admin
                    lastUpdatedBy: admin
                    createdOn: 1701850310222
                    description: cg1 cli Profile
                    lastUpdatedOn: 1702292120081
                  $$ref: '#/components/examples/getListMobilityCliExample'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Feature Profile > Teleworker CLI Add On-read
  /v1/feature-profile/mobility/cli/{cliId}:
    get:
      tags:
      - Configuration - Feature Profile (Mobility)
      description: Get a Mobility Feature Profile with Cli profile type
      operationId: GetMobilityCliFeatureProfileByCliId
      parameters:
      - name: cliId
        in: path
        description: Feature Profile Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  profileId:
                    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'
                  profileType:
                    type: string
                    enum:
                    - cli
                  profileName:
                    type: string
                    pattern: ^[^&<>! "]+$
                    minLength: 1
                    maxLength: 128
                    $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef'
                  description:
                    type: string
                  solution:
                    type: string
                    enum:
                    - mobility
                  createdBy:
                    type: string
                    description: User who last created this.
                    readOnly: true
                  createdOn:
                    type: integer
                    description: Timestamp of creation
                    format: int64
                    readOnly: true
                  lastUpdatedBy:
                    type: string
                    description: User who last updated this.
                    readOnly: true
                  lastUpdatedOn:
                    type: integer
                    description: Timestamp of last update
                    format: int64
                    readOnly: true
                  associatedProfileParcels:
                    type: array
                    items:
                      type: object
                      minItems: 0
                      properties:
                        parcelId:
                          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'
                        parcelType:
                          type: string
                        payload:
                          type: object
                        subparcels:
                          type: array
                          minItems: 0
                          items:
                            type: object
                $$ref: '#/components/schemas/getSingleMobilityCliPayload'
              examples:
                get response example:
                  value:
                    profileName: cg1_LAN
                    lastUpdatedBy: admin
                    description: cg1 cli Profile
                    profileParcelCount: 613
                    createdOn: 1701850310222
                    '@rid': 3262
                    profileType: cli
                    solution: mobility
                    createdBy: admin
                    profileId: bc99ae4f-0ac3-4a51-95cb-c718953143ce
                    lastUpdatedOn: 1702292120081
                    associatedProfileParcels: []
                  $$ref: '#/components/examples/getSingleMobilityCliExample'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Feature Profile > Teleworker CLI Add On-read
  /v1/feature-profile/mobility/cli/{cliId}/config:
    get:
      tags:
      - Configuration - Feature Profile (Mobility)
      description: Get config Features for cli feature profile
      operationId: GetAllConfigFeatureForMobility
      parameters:
      - name: cliId
        in: path
        description: Feature Profile ID
        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:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        parcelId:
                          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'
                        parcelType:
                          type: string
                        createdBy:
                          type: string
                          description: User who last created this.
                          readOnly: true
                        createdOn:
                          type: integer
                          description: Timestamp of creation
                          format: int64
                          readOnly: true
                        lastUpdatedBy:
                          type: string
                          description: User who last updated this.
                          readOnly: true
                        lastUpdatedOn:
                          type: integer
                          description: Timestamp of last update
                          format: int64
                          readOnly: true
                        payload:
                          type: object
                          properties:
                            name:
                              type: string
                              pattern: ^[^&<>! "]+$
                              minLength: 1
                              maxLength: 128
                              $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef'
                            description:
                              type: string
                            data:
                              type: object
                              properties:
                                config:
                                  type: string
                              required:
                              - config
                              additionalProperties: false
                          required:
                          - name
                          - data
                          x-metadata:
                            supportedDeviceTypes:
                            - all
                            minVManageVersion: 20.15.1
                          additionalProperties: false
                          $$ref: '#/components/schemas/ProfileparcelMobilityCliConfigPostRequest_SchemaPayload'
                $$ref: '#/components/schemas/getListMobilityCliConfigPayload'
              examples:
                get response example:
                  value:
                    header:
                      generatedOn: 1702438718825
                    data:
                    - parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902
                      parcelType: config
                      createdBy: admin
                      lastUpdatedBy: admin
                      createdOn: 1701866357838
                      lastUpdatedOn: 1701866357838
                      payload:
                        data:
                          config: 'gw-system:system logging disk enable

                            gw-system:system admin-tech-on-failure'
                  $$ref: '#/components/examples/getListMobilityCliConfigExample'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Feature Profile > Teleworker CLI Add On > Config-read
    post:
      tags:
      - Configuration - Feature Profile (Mobility)
      description: Create a config Feature for cli feature profile
      operationId: CreateConfigFeatureForMobility
      parameters:
      - name: cliId
        in: path
        description: Feature Profile ID
        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: cli config Feature
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  pattern: ^[^&<>! "]+$
                  minLength: 1
                  maxLength: 128
                  $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef'
                description:
                  type: string
                data:
                  type: object
                  properties:
                    config:
                      type: string
                  required:
                  - config
                  additionalProperties: false
              required:
              - name
              - data
              x-metadata:
                supportedDeviceTypes:
                - all
                minVManageVersion: 20.15.1
              additionalProperties: false
              $$ref: '#/components/schemas/ProfileparcelMobilityCliConfigPostRequest_SchemaPayload'
            examples:
              CliConfigParcel1:
                value:
                  data:
                    config: 'gw-system:system logging disk enable

                      gw-system:system admin-tech-on-failure'
                  name: CliConfigParcel1
                $$ref: '#/components/examples/ProfileparcelMobilityCliConfigPostRequest_CliConfigParcel1'
        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}'
                required:
                - id
                x-metadata:
                  minVManageVersion: 20.15.1
                additionalProperties: false
                $$ref: '#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload'
              examples:
                example_1:
                  value:
                    id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A
                  $$ref: '#/components/examples/ProfileparcelCommonPostResponse_example_1'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Feature Profile > Teleworker CLI Add On > Config-write
  /v1/feature-profile/mobility/cli/{cliId}/config/{configId}:
    get:
      tags:
      - Configuration - Feature Profile (Mobility)
      description: Get config Feature by configId for cli feature profile
      operationId: GetConfigFeatureForMobilityByParcelId
      parameters:
      - name: cliId
        in: path
        description: Feature Profile ID
        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: configId
        in: path
        description: Feature ID
        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:
                type: object
                properties:
                  parcelId:
                    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'
                  parcelType:
                    type: string
                  createdBy:
                    type: string
                    description: User who last created this.
                    readOnly: true
                  createdOn:
                    type: integer
                    description: Timestamp of creation
                    format: int64
                    readOnly: true
                  lastUpdatedBy:
                    type: string
                    description: User who last updated this.
                    readOnly: true
                  lastUpdatedOn:
                    type: integer
                    description: Timestamp of last update
                    format: int64
                    readOnly: true
                  payload:
                    type: object
                    properties:
                      name:
                        type: string
                        pattern: ^[^&<>! "]+$
                        minLength: 1
                        maxLength: 128
                        $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef'
                      description:
                        type: string
                      data:
                        type: object
                        properties:
                          config:
                            type: string
                        required:
                        - config
                        additionalProperties: false
                    required:
                    - name
                    - data
                    x-metadata:
                      supportedDeviceTypes:
                      - all
                      minVManageVersion: 20.15.1
                    additionalProperties: false
                    $$ref: '#/components/schemas/ProfileparcelMobilityCliConfigPutRequest_SchemaPayload'
                $$ref: '#/components/schemas/getSingleMobilityCliConfigPayload'
              examples:
                get response example:
                  value:
                    parcelId: 09fc54fe-ff36-4640-ae57-c9e71a103902
                    parcelType: config
                    createdBy: admin
                    lastUpdatedBy: admin
                    createdOn: 1701866357838
                    lastUpdatedOn: 1701866357838
                    payload:
                      data:
                        config: 'gw-system:system logging disk enable

                          gw-system:system admin-tech-on-failure'
                  $$ref: '#/components/examples/getSingleMobilityCliConfigExample'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Feature Profile > Teleworker CLI Add On > Config-read
    put:
      tags:
      - Configuration - Feature Profile (Mobility)
      description: Update a config Feature for cli feature profile
      operationId: EditConfigFeatureForMobility
      parameters:
      - name: cliId
        in: path
        description: Feature Profile ID
        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: configId
        in: path
        description: Feature ID
        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: cli config Feature
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  pattern: ^[^&<>! "]+$
                  minLength: 1
                  maxLength: 128
                  $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef'
                description:
                  type: string
                data:
                  type: object
                  properties:
                    config:
                      type: string
                  required:
                  - config
                  additionalProperties: false
              required:
              - name
              - data
              x-metadata:
                supportedDeviceTypes:
                - all
                minVManageVersion: 20.15.1
              additionalProperties: false
              $$ref: '#/components/schemas/ProfileparcelMobilityCliConfigPutRequest_SchemaPayload'
            examples:
              CliConfigParcel1:
                value:
                  data:
                    config: 'gw-system:system logging disk enable

                      gw-system:system admin-tech-on-failure'
                  name: CliConfigParcel1
                $$ref: '#/components/examples/ProfileparcelMobilityCliConfigPutRequest_CliConfigParcel1'
        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}'
                required:
                - id
                x-metadata:
                  minVManageVersion: 20.15.1
                additionalProperties: false
                $$ref: '#/components/schemas/ProfileparcelCommonPutResponse_SchemaPayload'
              examples:
                example_1:
                  value:
                    id: 24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A
                  $$ref: '#/components/examples/ProfileparcelCommonPutResponse_example_1'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Feature Profile > Teleworker CLI Add On > Config-write
    delete:
      tags:
      - Configuration - Feature Profile (Mobility)
      description: Delete a config Feature for cli feature profile
      operationId: DeleteConfigFeatureForMobility
      parameters:
      - name: cliId
        in: path
        description: Feature Profile ID
        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: configId
        in: path
        description: Feature ID
        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
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Feature Profile > Teleworker CLI Add On > Config-write
  /v1/feature-profile/mobility/global:
    get:
      tags:
      - Configuration - Feature Profile (Mobility)
      description: Get Mobility Global Feature Profiles
      operationId: GetMobilityGlobalFeatureProfile
      parameters:
      - name: offset
        in: query
        description: Pagination offset
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: Pagination limit
        schema:
          type: integer
          format: int32
          default: 0
      - name: referenceCount
        in: query
        description: get associated group details
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    profileId:
                      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'
                    profileName:
                      type: string
                      pattern: ^[^&<>! "]+$
                      minLength: 1
                      maxLength: 128
                      $$ref: '#/components/schemas/CommonCommonDefs_cgFpPpNameDef'
                    profileType:
                      type: string
                      enum:
                      - global
                    createdBy:
                      type: string
                      description: User who last created this.
                      readOnly: true
                    createdOn:
                      type: integer
                      description: Timestamp of creation
                      format: int64
                      readOnly: true
                    lastUpdatedBy:
                      type: string
                      description: User who last updated this.
                      readOnly: true
                    lastUpdatedOn:
                      type: integer
                      description: Timestamp of last update
                      format: int64
                      readOnly: true
                    description:
                      type: string
                    solution:
                      type: string
                      enum:
                      - mobility
                $$ref: '#/components/schemas/getListMobilityGlobalPayload'
              examples:
                get response example:
                  value:
                  - profileId: bc99ae4f-0ac3-4a51-95cb-c718953143ce
                    profileName: cg1_LAN
                    solution: mobility
                    profileType: global
                    createdBy: admin
                    lastUpdatedBy: admin
                    createdOn: 1701850310222
                    description: cg1 global Profile
                    lastUpdatedOn: 1702292120081
                  $$ref: '#/components/examples/getListMobilityGlobalExample'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Feature Profile > Teleworker-read
  /v1/feature-profile/mobility/global/basic/schema:
    get:
      tags:
      - Configuration - Feature Profile (Mobility)
      description: Get a Mobility Global Basic Parcel Schema by Schema Type
      operationId: GetMobilityGlobalBasicParcelSchemaBySchemaType
      parameters:
      - name: schemaType
        in: query
        required: true
        schema:
          type: string
          enum:
          - post
          - put
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
              examples:
                post:
                  value:
                    type: object
                    properties:
                      name:
                        type: string
                        pattern: ^[^&<>! "]+$
                        minLength: 1
                        maxLength: 128
                      description:
                        description: Set the parcel description
                        type: string
                      data:
                        type: object
                        properties:
                          user:
                            description: Create local login account
                            type: array
                            uniqueItems: true
                            minItems: 1
                            maxItems: 1
                            items:
                              type: object
                              properties:
                                name:
                                  properties:
                                    optionType:
                                      type: string
                                      enum:
                                      - global
                                    value:
                                      type: string
                                      enum:
                                      - admin
                                  required:
                                  - optionType
                                  - value
                                  additionalProperties: false
                                password:
                                  properties:
                                    optionType:
                                      type: string
                                      enum:
                                      - global
                                    value:
                                      type: string
                                      description: Password should contain atleast 1 uppercase letter, 1 lowercase letter, 1 special character, 1 number and have minimum length of 8 characters and maximum length of 32 characters
                                      minLength: 8
                                      maxLength: 32
                                      allOf:
                                      - pattern: .*\d{1,}.*
                                      - pattern: .*[A-Z]{1,}.*
                                      - pattern: .*[a-z]{1,}.*
                                      - pattern: .*[!@#$%^&*-+=;:",<.>?~`]{1,}.*
                                  required:
                                  - optionType
                                  - value
                                  additionalProperties: false
                              required:
                              - name
                              - password
                              additionalProperties: false
                        required:
                        - user
                        additionalProperties: false
                    required:
                    - name
                    - data
                    x-metadata:
                      minVManageVersion: 20.15.1
                    additionalProperties: false
                  $$ref: '#/components/examples/ProfileparcelMobilityGlobalBasicPostRequest_ResolvedSchema'
                put:
                  value:
                    type: object
                    properties:
                      name:
                        type: string
                        pattern: ^[^&<>! "]+$
                        minLength: 1
                        maxLength: 128
                      description:
                        description: Set the parcel description
                        type: string
                      data:
                        type: object
                        properties:
                          user:
                            description: Create local login account
                            type: array
                            uniqueItems: true
                            minItems: 1
                            maxItems: 1
                            items:
                              type: object
                              properties:
                                name:
                                  properties:
                                    optionType:
                                      type: string
                                      enum:
                                 

# --- truncated at 32 KB (784 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-sdwan/refs/heads/main/openapi/cisco-catalyst-sdwan-configuration-feature-profile-mobility-api-openapi.yml