Cisco Catalyst SD-WAN Manager API — Partner Integrations

Partner and third-party integration operations: Cisco Catalyst Center (DNAC) SDA, ACI policy builder, Cisco ISE servers, Umbrella, Webex cloud service, Cisco software licensing and TAC case tooling exposed through SD-WAN Manager.

OpenAPI Specification

cisco-catalyst-sdwan-partner-integrations-openapi.json Raw ↑
{
  "openapi": "3.1.0",
  "info": {
    "title": "Partner Integrations",
    "description": "Includes API operations for partner integrations, such as Webex, Identity Services Engine (ISE), Secure Access, and more",
    "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": "Cisco Software"
    },
    {
      "name": "Configuration - Cloud On Ramp SaaS"
    },
    {
      "name": "Configuration - Ise Server"
    },
    {
      "name": "Deployment Mode"
    },
    {
      "name": "Partner - ACI Policy Builder"
    },
    {
      "name": "Partner - DNAC SDA API"
    },
    {
      "name": "Partner - Registration"
    },
    {
      "name": "Partner - WCM Configs"
    },
    {
      "name": "System - Cloud Service Webex"
    },
    {
      "name": "Tools - TAC Cases"
    },
    {
      "name": "Umbrella"
    }
  ],
  "paths": {
    "/fedramp/dnssec/actions": {
      "get": {
        "tags": [
          "Deployment Mode"
        ],
        "description": "Request DNS-Sec actions",
        "operationId": "requesDNSSecActions",
        "parameters": [
          {
            "name": "action",
            "in": "query",
            "description": "DNS-Sec action",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "examples": {
                  "DNS-Sec action status": {
                    "description": "DNS-Sec action status",
                    "value": {}
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "x-roles-required": "Settings-read,FedRamp-read"
      }
    },
    "/fedramp/dnssec/config": {
      "post": {
        "tags": [
          "Deployment Mode"
        ],
        "description": "Configure DNS-Sec",
        "operationId": "configureDNSSec",
        "requestBody": {
          "description": "DNS sec config request",
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "examples": {
                "DNS sec config request": {
                  "description": "DNS sec config request",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "x-roles-required": "Settings-write,FedRamp-write"
      }
    },
    "/fedramp/dnssec/status": {
      "get": {
        "tags": [
          "Deployment Mode"
        ],
        "description": "Get DNS-Sec status",
        "operationId": "getDNSSecStatus",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "examples": {
                  "DNS-Sec status": {
                    "description": "DNS-Sec status",
                    "value": {}
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "x-roles-required": "Settings-read,FedRamp-read"
      }
    },
    "/fedramp/status": {
      "post": {
        "tags": [
          "Deployment Mode"
        ],
        "description": "Set network deployment mode",
        "operationId": "configFedrampMode",
        "requestBody": {
          "description": "Network deployment mode",
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "examples": {
                "Network deployment mode": {
                  "description": "Network deployment mode",
                  "value": {
                    "deploymentMode": [
                      {
                        "FRMod": "FedRAMP Moderate"
                      },
                      {
                        "DODIL5": "DOD-IL5"
                      },
                      {
                        "PCIDSS": "PCI-DSS"
                      },
                      {
                        "SOC2": "SOC2"
                      },
                      {
                        "SOC3": "SOC3"
                      },
                      {
                        "C5": "C5"
                      },
                      {
                        "ENS": "ENS"
                      },
                      {
                        "ISO27001": "ISO 27001"
                      },
                      {
                        "ISO27017": "ISO 27017"
                      },
                      {
                        "ISO27018": "ISO 27018"
                      },
                      {
                        "ISO27701": "ISO 27701"
                      },
                      {
                        "Tx-RAMP": "Tx-RAMP"
                      }
                    ]
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "x-roles-required": "Settings-write,FedRamp-write"
      }
    },
    "/fedramp/wazuh/actions": {
      "get": {
        "tags": [
          "Deployment Mode"
        ],
        "description": "Wazuh agent action",
        "operationId": "requestWazuhActions",
        "parameters": [
          {
            "name": "action",
            "in": "query",
            "description": "Wazhuh Action",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object"
                  }
                },
                "examples": {
                  "Wazhug agent action status": {
                    "description": "Wazhug agent action status",
                    "value": []
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "x-roles-required": "Settings-read,FedRamp-read"
      }
    },
    "/fedramp/wazuh/config": {
      "post": {
        "tags": [
          "Deployment Mode"
        ],
        "description": "Configure Wazuh agent",
        "operationId": "configureWazuhClient",
        "requestBody": {
          "description": "Wazhuh configuration",
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "examples": {
                "Wazhuh configuration request": {
                  "description": "Wazhuh configuration request",
                  "value": {}
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Success"
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "x-roles-required": "Settings-write,FedRamp-write"
      }
    },
    "/fedramp/wazuh/status": {
      "get": {
        "tags": [
          "Deployment Mode"
        ],
        "description": "Get Wazuh agent status",
        "operationId": "getWazuhAgentStatus",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object"
                  }
                },
                "examples": {
                  "Wazhug agent status": {
                    "description": "Wazhug agent status",
                    "value": []
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "x-roles-required": "Settings-read,FedRamp-read"
      }
    },
    "/ise/connect": {
      "get": {
        "tags": [
          "Configuration - Ise Server"
        ],
        "description": "Check if the configured ISE server is reachable",
        "operationId": "connect_ConfigurationIseServer_1203",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "VersionInfo": {
                      "type": "object",
                      "properties": {
                        "currentServerVersion": {
                          "type": "string",
                          "example": "1.2"
                        },
                        "link": {
                          "type": "object",
                          "properties": {
                            "href": {
                              "type": "string",
                              "example": "https://172.27.216.141:9060/ers/config/adminuser/versioninfo"
                            },
                            "rel": {
                              "type": "string",
                              "example": "self"
                            },
                            "type": {
                              "type": "string",
                              "example": "application/json"
                            }
                          },
                          "$$ref": "#/components/schemas/LinkObject"
                        },
                        "supportedVersions": {
                          "type": "string",
                          "example": "1.0,1.1,1.2"
                        }
                      },
                      "$$ref": "#/components/schemas/VersionInformation"
                    }
                  },
                  "description": "Response from ISE ERS version info api",
                  "$$ref": "#/components/schemas/ConnectResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    },
    "/ise/credentials": {
      "put": {
        "tags": [
          "Configuration - Ise Server"
        ],
        "description": "update Ise server credentials",
        "operationId": "updateIseServerCredentials",
        "requestBody": {
          "description": "Ise Server with possibly new values for properties",
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "destinationVpn",
                  "iseServerIP",
                  "password",
                  "sgt",
                  "userAndUserGroup",
                  "userName",
                  "vpn",
                  "vpnIpSubnet"
                ],
                "type": "object",
                "properties": {
                  "activeDirectoryDomain": {
                    "type": "string",
                    "example": "SDWAN-IDENTITY.CISCO.COM"
                  },
                  "destinationVpn": {
                    "type": "string",
                    "example": "0"
                  },
                  "iseCertName": {
                    "type": "string",
                    "example": "iseCertificate"
                  },
                  "iseRootCert": {
                    "type": "string"
                  },
                  "iseServerIP": {
                    "type": "string",
                    "example": "172.27.216.141"
                  },
                  "joinPoint": {
                    "type": "string",
                    "example": "SDWAN-IDENTITY"
                  },
                  "password": {
                    "type": "string",
                    "example": "testPassword"
                  },
                  "pxGridCertName": {
                    "type": "string",
                    "example": "pxGridCertificate"
                  },
                  "pxGridRootCert": {
                    "type": "string"
                  },
                  "sgt": {
                    "type": "string",
                    "example": "false"
                  },
                  "userAndUserGroup": {
                    "type": "string",
                    "example": "true"
                  },
                  "userName": {
                    "type": "string",
                    "example": "admin"
                  },
                  "vpn": {
                    "type": "string",
                    "example": "0"
                  },
                  "vpnIpSubnet": {
                    "type": "string",
                    "example": "192.168.1.0/24"
                  }
                },
                "$$ref": "#/components/schemas/IseServer"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "boolean"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      },
      "post": {
        "tags": [
          "Configuration - Ise Server"
        ],
        "description": "Add Ise server credentials",
        "operationId": "addIseServerCredentials",
        "requestBody": {
          "description": "Ise Server",
          "content": {
            "application/json": {
              "schema": {
                "required": [
                  "destinationVpn",
                  "iseServerIP",
                  "password",
                  "sgt",
                  "userAndUserGroup",
                  "userName",
                  "vpn",
                  "vpnIpSubnet"
                ],
                "type": "object",
                "properties": {
                  "activeDirectoryDomain": {
                    "type": "string",
                    "example": "SDWAN-IDENTITY.CISCO.COM"
                  },
                  "destinationVpn": {
                    "type": "string",
                    "example": "0"
                  },
                  "iseCertName": {
                    "type": "string",
                    "example": "iseCertificate"
                  },
                  "iseRootCert": {
                    "type": "string"
                  },
                  "iseServerIP": {
                    "type": "string",
                    "example": "172.27.216.141"
                  },
                  "joinPoint": {
                    "type": "string",
                    "example": "SDWAN-IDENTITY"
                  },
                  "password": {
                    "type": "string",
                    "example": "testPassword"
                  },
                  "pxGridCertName": {
                    "type": "string",
                    "example": "pxGridCertificate"
                  },
                  "pxGridRootCert": {
                    "type": "string"
                  },
                  "sgt": {
                    "type": "string",
                    "example": "false"
                  },
                  "userAndUserGroup": {
                    "type": "string",
                    "example": "true"
                  },
                  "userName": {
                    "type": "string",
                    "example": "admin"
                  },
                  "vpn": {
                    "type": "string",
                    "example": "0"
                  },
                  "vpnIpSubnet": {
                    "type": "string",
                    "example": "192.168.1.0/24"
                  }
                },
                "$$ref": "#/components/schemas/IseServer"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "boolean"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      },
      "get": {
        "tags": [
          "Configuration - Ise Server"
        ],
        "description": "Get Ise server credentials",
        "operationId": "getIseServerCredentials",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "destinationVpn",
                    "iseServerIP",
                    "password",
                    "sgt",
                    "userAndUserGroup",
                    "userName",
                    "vpn",
                    "vpnIpSubnet"
                  ],
                  "type": "object",
                  "properties": {
                    "activeDirectoryDomain": {
                      "type": "string",
                      "example": "SDWAN-IDENTITY.CISCO.COM"
                    },
                    "destinationVpn": {
                      "type": "string",
                      "example": "0"
                    },
                    "iseCertName": {
                      "type": "string",
                      "example": "iseCertificate"
                    },
                    "iseRootCert": {
                      "type": "string"
                    },
                    "iseServerIP": {
                      "type": "string",
                      "example": "172.27.216.141"
                    },
                    "joinPoint": {
                      "type": "string",
                      "example": "SDWAN-IDENTITY"
                    },
                    "password": {
                      "type": "string",
                      "example": "testPassword"
                    },
                    "pxGridCertName": {
                      "type": "string",
                      "example": "pxGridCertificate"
                    },
                    "pxGridRootCert": {
                      "type": "string"
                    },
                    "sgt": {
                      "type": "string",
                      "example": "false"
                    },
                    "userAndUserGroup": {
                      "type": "string",
                      "example": "true"
                    },
                    "userName": {
                      "type": "string",
                      "example": "admin"
                    },
                    "vpn": {
                      "type": "string",
                      "example": "0"
                    },
                    "vpnIpSubnet": {
                      "type": "string",
                      "example": "192.168.1.0/24"
                    }
                  },
                  "$$ref": "#/components/schemas/IseServer"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    },
    "/ise/credentials/iseandpxgrid": {
      "delete": {
        "tags": [
          "Configuration - Ise Server"
        ],
        "description": "Delete PxGrid and Ise information on vManage. Also Deletes PxGrid Client on ISE",
        "operationId": "deleteIseAndPxGridAccount",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "boolean"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    },
    "/ise/credentials/pxgrid": {
      "get": {
        "tags": [
          "Configuration - Ise Server"
        ],
        "description": "Get PxGrid account",
        "operationId": "getPxGridAccount",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "pxGridPassword",
                    "pxGridServerIp",
                    "pxGridUserName",
                    "status"
                  ],
                  "type": "object",
                  "properties": {
                    "AccessSecret": {
                      "type": "string",
                      "example": "aB8rj1m1lp"
                    },
                    "description": {
                      "type": "string",
                      "example": "pxgrid infor"
                    },
                    "deviceType": {
                      "type": "string",
                      "example": "vsmart"
                    },
                    "nodeName": {
                      "type": "string",
                      "example": "~ise-admin-ise-1"
                    },
                    "pxGridHostName": {
                      "type": "string",
                      "example": "ISE-1.rtpaaa.net"
                    },
                    "pxGridPassword": {
                      "type": "string",
                      "example": "NJkl00jklkJk"
                    },
                    "pxGridServerIp": {
                      "type": "string",
                      "example": "172.27.16.141"
                    },
                    "pxGridUserName": {
                      "type": "string",
                      "example": "testName"
                    },
                    "restBaseURL": {
                      "type": "string",
                      "example": "https://ISE-1.rtpaaa.net:8910/pxgrid/ise/config/trustsec"
                    },
                    "status": {
                      "type": "string",
                      "example": "created"
                    }
                  },
                  "description": "pxgrid information for making pxgrid api calls",
                  "$$ref": "#/components/schemas/PxGridInfo"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      },
      "delete": {
        "tags": [
          "Configuration - Ise Server"
        ],
        "description": "Delete PxGrid account information",
        "operationId": "deletePxGrid",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "boolean"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    },
    "/ise/credentials/pxgrid/cert": {
      "get": {
        "tags": [
          "Configuration - Ise Server"
        ],
        "description": "Retrieves Pxgrid Certificate",
        "operationId": "getPxgridCert",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "Cert": {
                    "description": "Cert",
                    "value": "-----BEGIN CERTIFICATE-----\nMIIF7zCCA9egAwIBAgIQZiToABE+v71LjsuIg3EjqTANBgkqhkiG9w0BAQ0FADCB\niTELMAkGA1UEBhMCVVMxEzARBgNVBAgTCkNhbGlmb3JuaWExETAPBgNVBAcTCFNh\nbiBKb3v/3QMfoLFz004vv7vBf4VcpQQ8Bc\nTATYW0iy5jt+YNgvZj2HjYiOhwpMalGqlhBJMgljgNmupReAccQyw01hbPIG9vBK\nxWMSk/AFVb1Ctv7Q3MUV/1mZyTM14TUZbtDd1/lxIHBR7LKhMJqcjOOcNBFlkdXO\n6BaP2RPL6dw2x92ddnRtzpAPfx2c1R51rELPpenX0SNLoS0=\n-----END CERTIFICATE-----"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    },
    "/ise/credentials/vsmart/sync": {
      "post": {
        "tags": [
          "Configuration - Ise Server"
        ],
        "description": "Send pxGrid and ISE server configuration to vSmarts",
        "operationId": "syncVsmart",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "push_file_template_configuration-9101ae23-c48b-4c33-af3a-4444e4a63b02"
                    }
                  },
                  "description": "Response for a vsmart sync with the task id for the push from vManage to vSmarts",
                  "$$ref": "#/components/schemas/VsmartSyncResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    },
    "/ise/pxgrid/activate": {
      "post": {
        "tags": [
          "Configuration - Ise Server"
        ],
        "description": "Activate pxGrid account",
        "operationId": "accountActivate",
        "requestBody": {
          "description": "description for pxgrid node",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "description": {
                    "type": "string",
                    "example": "This is a description"
                  },
                  "pxGridPassword": {
                    "type": "string",
                    "example": "vjvR4vnzoLSAFPn9"
                  },
                  "pxGridUserName": {
                    "type": "string",
                    "example": "vIPtela_Inc_Regression_testUser123"
                  }
                },
                "description": "Body for PxGrid node activate on ISE",
                "$$ref": "#/components/schemas/ActivateBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "accountState": {
                      "type": "string",
                      "example": "PENDING"
                    },
                    "version": {
                      "type": "string",
                      "example": "2.0.3.24"
                    }
                  },
                  "description": "Response from PxGrid node activation on ISE, account PENDING on activated ENABLED after approve",
                  "$$ref": "#/components/schemas/ActivateResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    },
    "/ise/pxgrid/approve": {
      "put": {
        "tags": [
          "Configuration - Ise Server"
        ],
        "description": "Approve pxGrid account",
        "operationId": "approve",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "boolean"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    },
    "/ise/pxgrid/create": {
      "post": {
        "tags": [
          "Configuration - Ise Server"
        ],
        "description": "Create pxGrid account",
        "operationId": "accountCreate",
        "requestBody": {
          "description": "name for pxgrid node",
          "content": {
            "application/json": {
              "schema": {
                "type": "obje

# --- truncated at 32 KB (147 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-sdwan/refs/heads/main/openapi/cisco-catalyst-sdwan-partner-integrations-openapi.json