Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Others Configuration - Control Component Setting 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: Configuration - Control Component Setting
paths:
/v1/control-component/devices/settings/deploy:
post:
tags:
- Configuration - Control Component Setting
description: Deploy control component settings to one or multiple control component devices
operationId: deployControlComponentSettingsToDevice
requestBody:
description: Deploy settings to control components
content:
application/json:
schema:
required:
- devices
type: object
properties:
devices:
maxItems: 2147483647
minItems: 1
type: array
description: Control Component device UUID list
items:
required:
- id
type: object
properties:
id:
pattern: ^[a-zA-Z0-9\-/]+$
type: string
description: Control Component device UUID
example: 48844743-8f58-4fff-845a-e54ec27340f5
description: Control Component device UUID
$$ref: '#/components/schemas/ControlComponentDeviceId'
description: Deploy control component setting to multiple control component devices
$$ref: '#/components/schemas/ControlComponentDeployRequest'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
required:
- id
type: object
properties:
id:
type: string
description: Task ID
example: deploy_control_component_setting-da0ca791-8a3f-4cec-9d14-f4102d6364a1
description: Return the task ID for the deploy operation
$$ref: '#/components/schemas/ControlComponentDeviceDeployResponse'
'400':
description: Bad Request
content:
application/json:
schema:
required:
- error
type: object
properties:
error:
required:
- code
- details
- message
- type
type: object
properties:
code:
type: string
description: Internal error code
example: CCS0018
details:
type: string
description: Error message detail
example: Unrecognized field user1
message:
type: string
description: Error message summary
example: Invalid control component setting payload
type:
type: string
description: Error message title
example: error
description: Error response
$$ref: '#/components/schemas/ErrorDetails'
$$ref: '#/components/schemas/ErrorResponse'
examples:
DeployControlComponentDeviceFailed:
description: DeployControlComponentDeviceFailed
value:
error:
message: Deploy control component setting to device failed
code: CCS0019
details: Device daaa0139-4572-4373-9fd9-f6620c1368e3 is already deploying in-progress
type: error
$$ref: '#/components/examples/ComViptelaVmanageServerDeviceconfigControlcomponentSettingResponseExampleDeploycontrolcomponentfailedresponse'
'403':
description: Forbidden
'500':
description: Internal Server Error
x-roles-required: Control Component Settings-write
/v1/control-component/devices/{deviceId}/settings:
post:
tags:
- Configuration - Control Component Setting
description: Create device-specific settings for a specific control component. The deviceId can be obtained from the "uuid" field in the data returned by the API (GET /dataservice/certificate/data/controller/list)
operationId: createControlComponentDeviceSpecificSettings
parameters:
- name: deviceId
in: path
description: Control component device UUID
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
oneOf:
- required:
- system
- vpn
type: object
properties:
system:
required:
- hostName
- siteId
- systemIp
type: object
properties:
clock:
required:
- timezone
type: object
properties:
timezone:
type: string
description: Set the timezone
example: UTC
enum:
- Europe/Andorra
- Asia/Dubai
- Asia/Kabul
- America/Antigua
- America/Anguilla
- Europe/Tirane
- Asia/Yerevan
- Africa/Luanda
- Antarctica/McMurdo
- Antarctica/Rothera
- Antarctica/Palmer
- Antarctica/Mawson
- Antarctica/Davis
- Antarctica/Casey
- Antarctica/Vostok
- Antarctica/DumontDUrville
- Antarctica/Syowa
- America/Argentina/Buenos_Aires
- America/Argentina/Cordoba
- America/Argentina/Salta
- America/Argentina/Jujuy
- America/Argentina/Tucuman
- America/Argentina/Catamarca
- America/Argentina/La_Rioja
- America/Argentina/San_Juan
- America/Argentina/Mendoza
- America/Argentina/San_Luis
- America/Argentina/Rio_Gallegos
- America/Argentina/Ushuaia
- Pacific/Pago_Pago
- Europe/Vienna
- Australia/Lord_Howe
- Antarctica/Macquarie
- Australia/Hobart
- Australia/Currie
- Australia/Melbourne
- Australia/Sydney
- Australia/Broken_Hill
- Australia/Brisbane
- Australia/Lindeman
- Australia/Adelaide
- Australia/Darwin
- Australia/Perth
- Australia/Eucla
- America/Aruba
- Europe/Mariehamn
- Asia/Baku
- Europe/Sarajevo
- America/Barbados
- Asia/Dhaka
- Europe/Brussels
- Africa/Ouagadougou
- Europe/Sofia
- Asia/Bahrain
- Africa/Bujumbura
- Africa/Porto-Novo
- America/St_Barthelemy
- Atlantic/Bermuda
- Asia/Brunei
- America/La_Paz
- America/Kralendijk
- America/Noronha
- America/Belem
- America/Fortaleza
- America/Recife
- America/Araguaina
- America/Maceio
- America/Bahia
- America/Sao_Paulo
- America/Campo_Grande
- America/Cuiaba
- America/Santarem
- America/Porto_Velho
- America/Boa_Vista
- America/Manaus
- America/Eirunepe
- America/Rio_Branco
- America/Nassau
- Asia/Thimphu
- Africa/Gaborone
- Europe/Minsk
- America/Belize
- America/St_Johns
- America/Halifax
- America/Glace_Bay
- America/Moncton
- America/Goose_Bay
- America/Blanc-Sablon
- America/Toronto
- America/Nipigon
- America/Thunder_Bay
- America/Iqaluit
- America/Pangnirtung
- America/Resolute
- America/Atikokan
- America/Rankin_Inlet
- America/Winnipeg
- America/Rainy_River
- America/Regina
- America/Swift_Current
- America/Edmonton
- America/Cambridge_Bay
- America/Yellowknife
- America/Inuvik
- America/Creston
- America/Dawson_Creek
- America/Vancouver
- America/Whitehorse
- America/Dawson
- Indian/Cocos
- Africa/Kinshasa
- Africa/Lubumbashi
- Africa/Bangui
- Africa/Brazzaville
- Europe/Zurich
- Africa/Abidjan
- Pacific/Rarotonga
- America/Santiago
- Pacific/Easter
- Africa/Douala
- Asia/Shanghai
- Asia/Harbin
- Asia/Chongqing
- Asia/Urumqi
- Asia/Kashgar
- America/Bogota
- America/Costa_Rica
- America/Havana
- Atlantic/Cape_Verde
- America/Curacao
- Indian/Christmas
- Asia/Nicosia
- Europe/Prague
- Europe/Berlin
- Europe/Busingen
- Africa/Djibouti
- Europe/Copenhagen
- America/Dominica
- America/Santo_Domingo
- Africa/Algiers
- America/Guayaquil
- Pacific/Galapagos
- Europe/Tallinn
- Africa/Cairo
- Africa/El_Aaiun
- Africa/Asmara
- Europe/Madrid
- Africa/Ceuta
- Atlantic/Canary
- Africa/Addis_Ababa
- Europe/Helsinki
- Pacific/Fiji
- Atlantic/Stanley
- Pacific/Chuuk
- Pacific/Pohnpei
- Pacific/Kosrae
- Atlantic/Faroe
- Europe/Paris
- Africa/Libreville
- Europe/London
- America/Grenada
- Asia/Tbilisi
- America/Cayenne
- Europe/Guernsey
- Africa/Accra
- Europe/Gibraltar
- America/Godthab
- America/Danmarkshavn
- America/Scoresbysund
- America/Thule
- Africa/Banjul
- Africa/Conakry
- America/Guadeloupe
- Africa/Malabo
- Europe/Athens
- Atlantic/South_Georgia
- America/Guatemala
- Pacific/Guam
- Africa/Bissau
- America/Guyana
- Asia/Hong_Kong
- America/Tegucigalpa
- Europe/Zagreb
- America/Port-au-Prince
- Europe/Budapest
- Asia/Jakarta
- Asia/Pontianak
- Asia/Makassar
- Asia/Jayapura
- Europe/Dublin
- Asia/Jerusalem
- Europe/Isle_of_Man
- Asia/Kolkata
- Indian/Chagos
- Asia/Baghdad
- Asia/Tehran
- Atlantic/Reykjavik
- Europe/Rome
- Europe/Jersey
- America/Jamaica
- Asia/Amman
- Asia/Tokyo
- Africa/Nairobi
- Asia/Bishkek
- Asia/Phnom_Penh
- Pacific/Tarawa
- Pacific/Enderbury
- Pacific/Kiritimati
- Indian/Comoro
- America/St_Kitts
- Asia/Pyongyang
- Asia/Seoul
- Asia/Kuwait
- America/Cayman
- Asia/Almaty
- Asia/Qyzylorda
- Asia/Aqtobe
- Asia/Aqtau
- Asia/Oral
- Asia/Vientiane
- Asia/Beirut
- America/St_Lucia
- Europe/Vaduz
- Asia/Colombo
- Africa/Monrovia
- Africa/Maseru
- Europe/Vilnius
- Europe/Luxembourg
- Europe/Riga
- Africa/Tripoli
- Africa/Casablanca
- Europe/Monaco
- Europe/Chisinau
- Europe/Podgorica
- America/Marigot
- Indian/Antananarivo
- Pacific/Majuro
- Pacific/Kwajalein
- Europe/Skopje
- Africa/Bamako
- Asia/Rangoon
- Asia/Ulaanbaatar
- Asia/Hovd
- Asia/Choibalsan
- Asia/Macau
- Pacific/Saipan
- America/Martinique
- Africa/Nouakchott
- America/Montserrat
- Europe/Malta
- Indian/Mauritius
- Indian/Maldives
- Africa/Blantyre
- America/Mexico_City
- America/Cancun
- America/Merida
- America/Monterrey
- America/Matamoros
- America/Mazatlan
- America/Chihuahua
- America/Ojinaga
- America/Hermosillo
- America/Tijuana
- America/Santa_Isabel
- America/Bahia_Banderas
- Asia/Kuala_Lumpur
- Asia/Kuching
- Africa/Maputo
- Africa/Windhoek
- Pacific/Noumea
- Africa/Niamey
- Pacific/Norfolk
- Africa/Lagos
- America/Managua
- Europe/Amsterdam
- Europe/Oslo
- Asia/Kathmandu
- Pacific/Nauru
- Pacific/Niue
- Pacific/Auckland
- Pacific/Chatham
- Asia/Muscat
- America/Panama
- America/Lima
- Pacific/Tahiti
- Pacific/Marquesas
- Pacific/Gambier
- Pacific/Port_Moresby
- Asia/Manila
- Asia/Karachi
- Europe/Warsaw
- America/Miquelon
- Pacific/Pitcairn
- America/Puerto_Rico
- Asia/Gaza
- Asia/Hebron
- Europe/Lisbon
- Atlantic/Madeira
- Atlantic/Azores
- Pacific/Palau
- America/Asuncion
- Asia/Qatar
- Indian/Reunion
- Europe/Bucharest
- Europe/Belgrade
- Europe/Kaliningrad
- Europe/Moscow
- Europe/Volgograd
- Europe/Samara
- Asia/Yekaterinburg
- Asia/Omsk
- Asia/Novosibirsk
- Asia/Novokuznetsk
- Asia/Krasnoyarsk
- Asia/Irkutsk
- Asia/Yakutsk
- Asia/Khandyga
- Asia/Vladivostok
- Asia/Sakhalin
- Asia/Ust-Nera
- Asia/Magadan
- Asia/Kamchatka
- Asia/Anadyr
- Africa/Kigali
- Asia/Riyadh
- Pacific/Guadalcanal
- Indian/Mahe
- Africa/Khartoum
- Europe/Stockholm
- Asia/Singapore
- Atlantic/St_Helena
- Europe/Ljubljana
- Arctic/Longyearbyen
- Europe/Bratislava
- Africa/Freetown
- Europe/San_Marino
- Africa/Dakar
- Africa/Mogadishu
- America/Paramaribo
- Africa/Juba
- Africa/Sao_Tome
- America/El_Salvador
- America/Lower_Princes
- Asia/Damascus
- Africa/Mbabane
- America/Grand_Turk
- Africa/Ndjamena
- Indian/Kerguelen
- Africa/Lome
- Asia/Bangkok
- Asia/Dushanbe
- Pacific/Fakaofo
- Asia/Dili
- Asia/Ashgabat
- Africa/Tunis
- Pacific/Tongatapu
- Europe/Istanbul
- America/Port_of_Spain
- Pacific/Funafuti
- Asia/Taipei
- Africa/Dar_es_Salaam
- Europe/Kiev
- Europe/Uzhgorod
- Europe/Zaporozhye
- Europe/Simferopol
- Africa/Kampala
- Pacific/Johnston
- Pacific/Midway
- Pacific/Wake
- America/New_York
- America/Detroit
- America/Kentucky/Louisville
- America/Kentucky/Monticello
- America/Indiana/Indianapolis
- America/Indiana/Vincennes
- America/Indiana/Winamac
- America/Indiana/Marengo
- America/Indiana/Petersburg
- America/Indiana/Vevay
- America/Chicago
- America/Indiana/Tell_City
- America/Indiana/Knox
- America/Menominee
- America/North_Dakota/Center
- America/North_Dakota/New_Salem
- America/North_Dakota/Beulah
- America/Denver
- America/Boise
- America/Phoenix
- America/Los_Angeles
- America/Anchorage
- America/Juneau
- America/Sitka
- America/Yakutat
- America/Nome
- America/Adak
- America/Metlakatla
- Pacific/Honolulu
- America/Montevideo
- Asia/Samarkand
- Asia/Tashkent
- Europe/Vatican
- America/St_Vincent
- America/Caracas
- America/Tortola
- America/St_Thomas
- Asia/Ho_Chi_Minh
- Pacific/Efate
- Pacific/Wallis
- Pacific/Apia
- Asia/Aden
- Indian/Mayotte
- Africa/Johannesburg
- Africa/Lusaka
- Africa/Harare
- UTC
default: UTC
description: Configure clock
$$ref: '#/components/schemas/Clock'
description:
pattern: ^[^<>]{1,32}$
type: string
description: Set a text description of the device
example: System settings
deviceGroups:
type: array
description: Configure device groups
items:
type: string
description: Configure device groups
gpsLocation:
required:
- latitude
- longitude
type: object
properties:
latitude:
maximum: 90
minimum: -90
type: number
description: Set the device’s physical latitude
example: 60
longitude:
maximum: 180
minimum: -180
type: number
description: Set the device’s physical longitude
example: 60
description: GPS latitude and longitude of the device
$$ref: '#/components/schemas/GpsLocation'
hostName:
pattern: ^[a-zA-Z0-9\-_]{1,32}$
type: string
description: Set the hostname
example: vm12
location:
pattern: ^[^<>]{1,127}$
type: string
description: Set the location of the device
example: USA
siteId:
maximum: 4294967295
minimum: 0
type: integer
description: Set the site ID
format: int64
example: 100
systemIp:
pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))
type: string
description: Set the system IP address
example: 102.2.3.2
vbond:
required:
- address
type: object
properties:
address:
pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))
type: string
description: Set the vBond IP address
example: 10.0.12.22
$$ref: '#/components/schemas/Vbond'
description: System configuration for validator
$$ref: '#/components/schemas/ValidatorSystemSetting'
vpn:
required:
- transport
type: object
properties:
management:
required:
- interface
type: object
properties:
dns:
type: object
properties:
dnsServerPrimary:
pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))
type: string
description: Primary DNS server IPv4 or IPv6 Address
example: 10.2.2.2
dnsServerSecondary:
pattern: (^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$)|((([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-f
# --- truncated at 32 KB (1080 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-sdwan/refs/heads/main/openapi/cisco-catalyst-sdwan-configuration-control-component-setting-api-openapi.yml