Create custom network device validation - Cisco Catalyst Center API 3.1.3

{"type":"api","title":"Create custom network device validation","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-3-1-3/9b7bce247bccb0311419e593770ef07f9552d9e1/d41c7da7-f399-330a-bd19-886309e55849","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 3.1.3","version":"3.1.3"},"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.3","servers":[{"url":"/"}]},"spec":{"operationId":"createCustomNetworkDeviceValidation","tags":["Software Image Management (SWIM)"],"deprecated":false,"summary":"Create custom network device validation","description":"Custom network device validation refers to the tailored process of verifying and assessing the configurations of network devices based on specific organizational requirements and unique network environments. Unlike standard validations, custom network device validations are designed to address the distinctive needs and challenges of a particular network infrastructure, ensuring that devices operate optimally within the defined parameters. Upon task completion, the task API response's `resultLocation` attribute will provide the URL to retrieve the validation id.","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the network device validation."},"type":{"type":"string","enum":["PRE_VALIDATION","POST_VALIDATION"],"description":"The type of network device validation determines whether this validation runs before or after the operation."},"operationType":{"type":"string","enum":["DISTRIBUTION","ACTIVATION"],"description":"The operation type, as part of which this validation will get triggered."},"description":{"type":"string","description":"Details of the network device validation."},"cli":{"type":"string","description":"Show commands that will be executed. Validate the CLI - Cisco DevNet [ https://developer.cisco.com/docs/dna-center/2-3-7/run-read-only-commands-on-devices-to-get-their-real-time-configuration/ ]"},"productSeriesOrdinals":{"type":"array","items":{"type":"number"},"description":"The custom check will be mapped to the product series and devices that belong to this series. These devices will consume this check when triggered. Fetch productSeriesOrdinal from API `/dna/intent/api/v1/productSeries`."}},"required":["name","type","operationType","cli","productSeriesOrdinals"],"description":"Create a custom network validation that can be used to run validation before and after an operation. This validation result can be used to check the difference between the pre and post results.","$$ref":"#/components/schemas/createCustomNetworkDeviceValidationRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"string","description":"The UUID of the task"},"url":{"type":"string","description":"The path to the API endpoint to GET for information on the task"}},"description":"Contains information about a task to track the status of an asynchronous operation."},"version":{"type":"string","description":"The version of the response"}},"description":"","$$ref":"#/components/schemas/createCustomNetworkDeviceValidationResponse"}}}},"202":{"description":"Accepted","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":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"502":{"description":"The server is (temporarily) unavailable.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}}},"x-rapi-id":"df9d-0902-4199-a2b2","x-rapi-overview":"Custom network device validation refers to the tailored process of verifying and assessing the configurations of network devices based on specific organizational requirements and unique network environments. Unlike standard validations, custom network device validations are designed to address the distinctive needs and challenges of a particular network infrastructure, ensuring that devices operate optimally within the defined parameters. Upon task completion, the task API response's `resultLocation` attribute will provide the URL to retrieve the validation id.","x-rapi-domain":"Site Management","x-rapi-subdomain":"Software Image Management (SWIM)","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/networkDeviceImages/validations","x-rapi-publicPath":"/dna/intent/api/v1/networkDeviceImages/validations","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-deprecationMessage":"","x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"createCustomNetworkDeviceValidation","method":"post","path":"/dna/intent/api/v1/networkDeviceImages/validations"}}