Create Internal Network - Cloud Security API

{"type":"api","title":"Create Internal Network","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/5e6927c3-23fb-31fe-be9f-008804f3d1af","info":{"title":"Cisco Secure Acces Internal Networks API","version":"2.0.0","description":"Manage the internal networks in your organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Internal Networks"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/deployments/internal-networks-overview.md","uri":"secure-access-api-reference-internal-networks-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"deployments.internalnetworks:write":"Write deployments internal networks","deployments.internalnetworks:read":"Read deployments internal networks"}}}}}},"spec":{"tags":["Internal Networks","Secure Access"],"description":"Create an internal network.","summary":"Create Internal Network","operationId":"createInternalNetwork","security":[{"oauthFlow":["deployments.internalnetworks:write"]}],"requestBody":{"description":"A JSON object that defines the internal network.","required":true,"content":{"application/json":{"schema":{"type":"object","description":"The properties of the internal network.\nSpecify one of: `tunnelId`, `siteId`, or `networkId`.\n**Note:** Provide the ID of a Network Tunnel Group for the value of `tunnelId`.","properties":{"name":{"type":"string","description":"The name of the internal network.","minLength":1,"maxLength":50,"example":"site one internal network","$$ref":"#/components/schemas/name"},"ipAddress":{"type":"string","description":"The IP (IPv4 or IPv6) address of the internal network.","minLength":7,"maxLength":15,"example":"198.2.2.4","$$ref":"#/components/schemas/ipAddress"},"prefixLength":{"type":"integer","description":"The length of the internal network's prefix. The prefix length is between 8 and 32.","minimum":8,"maximum":32,"example":31,"$$ref":"#/components/schemas/prefixLength"},"siteId":{"type":"integer","description":"The ID of the site, which is associated with the internal network.\nThe internal network is associated with either a `siteId`, `networkId`, or `tunnelId`.","example":1234,"$$ref":"#/components/schemas/siteId"},"networkId":{"type":"integer","description":"The ID of the network, which is associated with the internal network.\nThe internal network is associated with either a `siteId`, `networkId`, or `tunnelId`.","example":1234,"$$ref":"#/components/schemas/networkId"},"tunnelId":{"type":"integer","description":"The ID of the network tunnel group ID, which is associated with the internal network.\nThe internal network is associated with either a `siteId`, `networkId`, or `tunnelId`.","example":1234,"$$ref":"#/components/schemas/tunnelId"}},"required":["name","ipAddress","prefixLength"],"example":{"name":"internal network label","ipAddress":"198.2.2.8","prefixLength":12,"siteId":1}}}},"$$ref":"#/components/requestBodies/InternalNetworkRequestBody"},"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 properties of the internal network.","properties":{"originId":{"type":"integer","description":"The origin ID of the internal network."},"name":{"type":"string","description":"The name of the internal network.","minLength":1,"maxLength":50,"example":"site one internal network","$$ref":"#/components/schemas/name"},"ipAddress":{"type":"string","description":"The IP (IPv4 or IPv6) address of the internal network.","minLength":7,"maxLength":15,"example":"198.2.2.4","$$ref":"#/components/schemas/ipAddress"},"prefixLength":{"type":"integer","description":"The length of the internal network's prefix. The prefix length is between 8 and 32.","minimum":8,"maximum":32,"example":31,"$$ref":"#/components/schemas/prefixLength"},"siteName":{"type":"string","description":"The name of the site that is associated with the internal network."},"siteId":{"type":"integer","description":"The ID of the site, which is associated with the internal network.\nThe internal network is associated with either a `siteId`, `networkId`, or `tunnelId`.","example":1234,"$$ref":"#/components/schemas/siteId"},"networkName":{"type":"string","description":"The name of the network that is associated with the internal network."},"networkId":{"type":"integer","description":"The ID of the network, which is associated with the internal network.\nThe internal network is associated with either a `siteId`, `networkId`, or `tunnelId`.","example":1234,"$$ref":"#/components/schemas/networkId"},"tunnelName":{"type":"string","description":"The name of the network tunnel group that is associated with the internal network."},"tunnelId":{"type":"integer","description":"The ID of the network tunnel group ID, which is associated with the internal network.\nThe internal network is associated with either a `siteId`, `networkId`, or `tunnelId`.","example":1234,"$$ref":"#/components/schemas/tunnelId"},"createdAt":{"type":"string","format":"date-time","description":"The date and time (ISO8601 timestamp) when the internal network was created.","example":"2018-06-13T16:07:07.222Z"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time (ISO8601 timestamp) when the internal network was modified.","example":"2018-06-13T16:07:07.222Z"}},"required":["originId","name","ipAddress","prefixLength"],"example":{"originId":1234,"name":"internal network label","ipAddress":"192.2.3.4","prefixLength":24,"networkName":"Internal network name","networkId":2,"createdAt":"2020-03-09T22:18:26.625Z","modifiedAt":"2020-03-09T22:18:26.625Z"},"$$ref":"#/components/schemas/InternalNetworkObject"},"example":{"originId":1234,"name":"internal network label","ipAddress":"198.2.3.1","prefixLength":24,"siteName":"Site name","siteId":2,"createdAt":"2020-03-09T22:18:26.625Z","modifiedAt":"2020-03-09T22:18:26.625Z"}}}},"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":{"statusCode":{"type":"integer","example":400,"description":"HTTP status code"},"error":{"type":"string","example":"Validation Error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/400Error"},"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","properties":{"statusCode":{"type":"integer","example":401,"description":"HTTP status code"},"error":{"type":"string","example":"Validation error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","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":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"error":{"type":"string","example":"Forbidden","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","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":{"statusCode":{"type":"integer","example":404,"description":"HTTP status code"},"error":{"type":"string","example":"Not Found","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/404Error"},"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","properties":{"statusCode":{"type":"integer","example":500,"description":"HTTP status code"},"error":{"type":"string","example":"Internal Server Error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"createInternalNetwork","method":"post","path":"/internalnetworks"}}