Create Network - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Create Network","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"createNetwork","tags":["Network Settings"],"deprecated":false,"summary":"Create Network","description":"API to create a network for DHCP, Syslog, SNMP, NTP, Network AAA, Client and EndPoint AAA, and/or DNS center server settings.","parameters":[{"name":"__persistbapioutput","description":"Persist bapi sync response","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"header"},{"name":"siteId","description":"Site id to which site details to associate with the network settings.","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","properties":{"dhcpServer":{"type":"array","items":{"type":"string"},"description":"DHCP Server IP (eg: 1.1.1.1)"},"dnsServer":{"type":"object","properties":{"domainName":{"type":"string","enum":["can only contain alphanumeric characters or hyphen"],"description":"Domain Name of DHCP (eg; cisco)"},"primaryIpAddress":{"type":"string","enum":["valid range : 1.0.0.0 - 223.255.255.255"],"description":"Primary IP Address for DHCP (eg: 2.2.2.2)"},"secondaryIpAddress":{"type":"string","enum":["valid range : 1.0.0.0 - 223.255.255.255"],"description":"Secondary IP Address for DHCP (eg: 3.3.3.3)"}},"description":"DNS Server detail"},"syslogServer":{"type":"object","properties":{"ipAddresses":{"type":"array","items":{"type":"string"},"description":"IP Address for syslog server (eg: 4.4.4.4)"},"configureDnacIP":{"type":"boolean","description":"Configuration DNAC IP for syslog server (eg: true)"}},"description":"Syslog Server detail"},"snmpServer":{"type":"object","properties":{"ipAddresses":{"type":"array","items":{"type":"string"},"description":"IP Address for SNMP Server (eg: 4.4.4.1)"},"configureDnacIP":{"type":"boolean","description":"Configuration DNAC IP for SNMP Server (eg: true)"}},"description":"Snmp Server details"},"netflowcollector":{"type":"object","properties":{"ipAddress":{"type":"string","description":"IP Address for NetFlow collector (eg: 3.3.3.1)"},"port":{"type":"number","description":"Port for NetFlow Collector (eg; 443)"}},"description":"NetFlow Collector details"},"ntpServer":{"type":"array","items":{"type":"string"},"description":"IP address for NTP server (eg: 1.1.1.2)"},"timezone":{"type":"string","description":"Input for time zone (eg: Africa/Abidjan)"},"messageOfTheday":{"type":"object","properties":{"bannerMessage":{"type":"string","description":"Massage for Banner message (eg; Good day)"},"retainExistingBanner":{"type":"string","description":"Retain existing Banner Message (eg: \"true\" or \"false\")"}},"description":"Message of the detail"},"network_aaa":{"type":"object","properties":{"servers":{"type":"string","enum":["Server type supported by ISE and AAA"],"description":"Server type for AAA Network (eg: AAA)"},"ipAddress":{"type":"string","enum":["Mandatory for ISE servers and for AAA consider this as additional IP."],"description":"IP address for AAA and ISE server (eg: 1.1.1.1)"},"network":{"type":"string","enum":["For AAA server consider it as primary IP and For ISE consider as Network"],"description":"IP Address for AAA or ISE server (eg: 2.2.2.2)"},"protocol":{"type":"string","description":"Protocol for AAA or ISE serve (eg: RADIUS)"},"sharedSecret":{"type":"string","enum":["Supported only by ISE Servers"],"description":"Shared secret for ISE Server"}},"description":"AAA Network Settings detail"},"clientAndEndpoint_aaa":{"type":"object","properties":{"servers":{"type":"string","description":"Server type AAA or ISE server (eg: AAA)"},"ipAddress":{"type":"string","enum":["Mandatory for ISE servers."],"description":"IP address for ISE serve (eg: 1.1.1.4)"},"network":{"type":"string","description":"IP address for AAA or ISE server (eg: 2.2.2.1)"},"protocol":{"type":"string","description":"Protocol for AAA or ISE serve (eg: RADIUS)"},"sharedSecret":{"type":"string","enum":["Supported only by ISE servers"],"description":"Shared secret for ISE server"}},"description":""}},"description":""}},"description":"","$$ref":"#/components/schemas/CreateNetworkRequest"}}},"required":true},"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"executionId":{"type":"string","description":""},"executionStatusUrl":{"type":"string","description":""},"message":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/CreateNetworkResponse"}}}},"202":{"description":"The request has been accepted for execution.","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}}},"x-rapi-id":"be89-2bd8-4a78-865a","x-rapi-overview":"API to create a network for DHCP, Syslog, SNMP, NTP, Network AAA, Client and EndPoint AAA, and/or DNS center server settings.","x-rapi-domain":"Site Management","x-rapi-subdomain":"Network Settings","x-rapi-version":"1.0.0","x-rapi-banner":["Sunset"],"x-rapi-rateLimiting":"100~1","__originalOperationId":"createNetwork","method":"post","path":"/dna/intent/api/v1/network/{siteId}"}}