{"type":"api","title":"Get Internal Network","meta":{"id":"/apps/pubhub/media/legacy-umbrella-api/bf58de618cbb72dda8f39b0414ce94c0a15cd467/8e02e061-a337-3c9a-a76f-a51a8c21291c","swagger":"2.0","info":{"title":"Networks","version":"1.0.0","description":"Networks, Internal Networks, Roaming Computers,\nSites, Virtual Appliances, and Internal Domains","contact":{"name":"Cloud Security Developer Community"}},"host":"management.api.umbrella.com","basePath":"/v1","schemes":["https"],"securityDefinitions":{"http":{"type":"basic"}},"security":[{"http":[]}],"x-parser-conf":{"httpBasic":{"username":"","password":""},"overview":{"markdownPath":"legacy/management/networks-overview.md"},"meta":{"useProxy":true}}},"spec":{"tags":["Internal Networks"],"description":"Get an internal network","summary":"Get Internal Network","operationId":"getInternalNetwork","parameters":[{"name":"organizationId","type":"integer","description":"The organization ID","in":"path","required":true,"$$ref":"#/parameters/orgIdParam"},{"type":"integer","description":"The origin ID (originId) of the internal network","name":"internalNetworkId","in":"path","required":true}],"responses":{"200":{"description":"List an internal network","schema":{"type":"object","properties":{"originId":{"type":"integer","description":"origin id"},"name":{"type":"string","description":"internal network label"},"ipAddress":{"type":"string","description":"internal network ipv4 address"},"prefixLength":{"type":"integer","description":"prefix length","minimum":1,"maximum":32},"siteName":{"type":"string","description":"name of site associated with an internal network"},"siteId":{"type":"integer","description":"id of site associated with an internal network"},"networkName":{"type":"string","description":"name of network associated with an internal network"},"networkId":{"type":"integer","description":"id of network associated with an internal network"},"tunnelName":{"type":"string","description":"name of tunnel associated with an internal network"},"tunnelId":{"type":"integer","description":"id of tunnel associated with an internal network"},"createdAt":{"type":"string","format":"date-time","description":"created at"},"modifiedAt":{"type":"string","format":"date-time","description":"modified at"}},"required":["originId","name","ipAddress","prefixLength"],"example":{"originId":1234,"name":"internal network label","ipAddress":"An IPv4 address","prefixLength":24,"siteName":"Site name","siteId":2,"networkName":"Internal network name","networkId":2,"tunnelName":"Tunnel name","tunnelId":3,"createdAt":"2020-03-09T22:18:26.625Z","modifiedAt":"2020-03-09T22:18:26.625Z"},"$$ref":"#/definitions/InternalNetwork"}},"400":{"description":"Validation Error","schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":400,"description":"the http error code returned."},"error":{"type":"string","example":"Validation Error","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"},"validationErrors":{"type":"object","properties":{"someProperty":{"type":"string","example":"must not be empty","description":"the name of the property failing validation."}}}}},"$$ref":"#/responses/BadRequest"},"401":{"description":"Unauthorized- The authorization header is missing or the token is unauthorized","schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":401,"description":"the http error code returned"},"error":{"type":"string","example":"Unauthorized","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}},"$$ref":"#/responses/Unauthorized"},"403":{"description":"Forbidden- The token is invalid","schema":{"type":"object","minProperties":1,"required":["message"],"properties":{"statusCode":{"type":"integer","example":403,"description":"the http error code returned"},"error":{"type":"string","example":"Forbidden, Invalid authentication credentials","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}},"$$ref":"#/responses/Forbidden"},"404":{"description":"Not Found- A resource specified in the URL was not found","schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":404,"description":"the http error code returned"},"error":{"type":"string","example":"Not Found","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}},"$$ref":"#/responses/NotFound"},"500":{"description":"Error- This request could not be processed by the server","schema":{"type":"object","minProperties":3,"required":["statusCode","error","txId"],"properties":{"statusCode":{"type":"integer","example":500,"description":"the http error code returned."},"error":{"type":"string","example":"Internal Server Error","description":"a brief description of the error"},"txId":{"type":"string","example":"86e189a6-0124-47d3-a32c-25ff3f07deaf","description":"a unique hex number that can be used for debugging"}}},"$$ref":"#/responses/ServerError"}},"__originalOperationId":"getInternalNetwork","security":[{"http":[]}],"consumes":["application/json"],"produces":["application/json"],"method":"get","path":"/organizations/{organizationId}/internalnetworks/{internalNetworkId}"}}