Validate Network Objects - Cloud Security API

{"type":"api","title":"Validate Network Objects","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/b36b2683-243e-3edc-8c84-85b5f4140afd","info":{"version":"1.0.1","title":"Cisco Secure Access Network and Service Objects API","description":"Manage the Network and Service Objects in the organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Network Objects","description":"Manage the Network Objects in the organization."},{"name":"Network Object Groups","description":"Manage the Network Object Groups in the organization."},{"name":"Service Objects","description":"Manage the Service Objects in the organization."},{"name":"Service Object Groups","description":"Manage the Service Object Groups in the organization."},{"name":"Unified Objects","description":"List the Objects and Object Groups in the organization."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/network-and-service-objects-overview.md","uri":"secure-access-api-reference-network-and-service-objects-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"policies/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"Client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"policies.objects.networkObjects:read":"Read the Network Object resources","policies.objects.networkObjectGroups:read":"Read the Network Object Group resources","policies.objects.networkObjects:write":"Write the Network Object resources","policies.objects.networkObjectGroups:write":"Write the Network Object Group resources","policies.objects.serviceObjects:read":"Read the Service Object resources","policies.objects.serviceObjectGroups:read":"Read the Service Object Groups resources","policies.objects.serviceObjects:write":"Write the Service Object resources","policies.objects.serviceObjectGroups:write":"Write the Service Object Group resources"}}}}}},"spec":{"tags":["Network Objects","Secure Access"],"summary":"Validate Network Objects","operationId":"createValidateNetworkObjects","description":"Validate a CSV file that includes the properties for creating the Network Objects. The system validates the properties for each Network Object in the file and returns a list of the validation errors.","security":[{"oauthFlow":["policies.objects.networkObjects:write"]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"A CSV file that includes the objects."}},"$$ref":"#/components/schemas/CsvObject"}},"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Network Object.","example":"A network object","$$ref":"#/components/schemas/nameNetworkObject"},"description":{"type":"string","description":"The description of the Network Object.","example":"network object description","$$ref":"#/components/schemas/descriptionNetworkObject"},"value":{"type":"object","description":"The value of the Network Object, which is represented by the network properties.","oneOf":[{"type":"object","description":"The properties of the network.","required":["type","addresses"],"properties":{"type":{"type":"string","description":"The network type.","enum":["network","host","range"],"example":"range"},"addresses":{"type":"array","description":"The list of IP addresses or IP address ranges for the network.\nSeparate the range of IPv4 addresses with a hyphen (**-**).","maxItems":1,"minItems":1,"items":{"type":"string","example":"10.10.0.0-10.10.2.0"}}},"example":{"type":"network","addresses":["192.68.1.0/24"]},"$$ref":"#/components/schemas/NetworkValueType"},{"type":"object","description":"The properties of the fully-qualified domain name (FQDN).","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of the domain name.","enum":["fqdn"]},"addresses":{"type":"array","description":"The list of domains.","maxItems":1,"minItems":1,"items":{"type":"string","example":"www.cisco.com"},"example":["www.cisco.com"]}},"$$ref":"#/components/schemas/FqdnValueType"}],"example":{"type":"network","addresses":["192.68.1.0/24"]}}}}}}}},"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The metadata for the properties of the objects that were validated.","properties":{"message":{"type":"string","description":"The message that describes the status of the validation of the objects.","example":"valid CSV file"}}}}},"$$ref":"#/components/responses/ValidateResponse"},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"The CSV file was validated and had errors."},"errors":{"type":"array","description":"The row in the CSV file where the error occurred when validating the CSV file and the list of errors.","items":{"type":"object","description":"The properties of the error.","properties":{"row":{"type":"integer","example":2,"description":"The number of the row where the error occurred in the CSV file. The CSV file uses one-based indexing."},"errors":{"type":"array","description":"The list of errors.","items":{"type":"object","description":"The properties of the error.","properties":{"code":{"type":"string","example":"err310","description":"The error code for the missing name."},"field":{"type":"string","example":"value","description":"The name of the invalid column."},"reason":{"type":"string","example":"name is missing","description":"The reason why the field is invalid."}}}}}}}}}}},"$$ref":"#/components/responses/Validate400Response"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Authorization token is invalid."}},"$$ref":"#/components/schemas/401ErrorObject"}}},"$$ref":"#/components/responses/401Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the error message.","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"}},"$$ref":"#/components/schemas/500ErrorObject"}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"createValidateNetworkObjects","method":"post","path":"/objects/networkObjects/validate"}}