{"type":"api","title":"List Networks","meta":{"id":"/apps/pubhub/media/legacy-umbrella-api/1f4bc296b06b13bab942ef791a49deeed880a9de/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":["Networks"],"description":"List the networks in the organization","summary":"List Networks","operationId":"listNetworks","parameters":[{"name":"organizationId","type":"integer","description":"The organization ID","in":"path","required":true,"$$ref":"#/parameters/orgIdParam"},{"name":"page","in":"query","description":"Specifies a page number in the collection.\nUse along with the limit parameter to implement pagination.","required":false,"default":1,"type":"integer","format":"int32","minimum":1,"$$ref":"#/parameters/paginationPageParam"},{"name":"limit","in":"query","description":"Specifies the number of records to return per page.\nUse along with the page parameter to implement pagination.","required":false,"default":100,"type":"integer","format":"int32","minimum":1,"maximum":100,"$$ref":"#/parameters/paginationLimitParam"}],"responses":{"200":{"description":"List networks","schema":{"type":"array","items":{"properties":{"originId":{"type":"integer","description":"origin id"},"name":{"type":"string","description":"The name of the network"},"ipAddress":{"type":["string","null"],"description":"The IP address for the network"},"prefixLength":{"type":["integer","null"],"description":"The prefix length. The prefix length must be greater than 28.","minimum":16,"maximum":128},"isDynamic":{"type":["boolean","null"],"description":"Specifies whether the IP address is dynamic"},"isVerified":{"type":["boolean","null"],"description":"Specifies whether the network is verified"},"status":{"type":["string","null"],"description":"status","pattern":"^(OPEN|CLOSED)$"},"createdAt":{"type":["string","null"],"format":"date-time","description":"created at"}},"type":"object","required":["originId","name","ipAddress","prefixLength","isDynamic","isVerified","status","createdAt"],"example":{"originId":1234,"name":"network name","ipAddress":"network ip address","prefixLength":32,"isDynamic":true,"isVerified":true,"status":"OPEN","createdAt":"2020-03-09T22:18:26.625Z"},"$$ref":"#/definitions/Network"},"example":[{"originId":1234,"name":"network name","ipAddress":"network ip address","prefixLength":32,"isDynamic":true,"isVerified":true,"status":"OPEN","createdAt":"2020-03-09T22:18:26.625Z"}]}},"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":"listNetworks","security":[{"http":[]}],"consumes":["application/json"],"produces":["application/json"],"method":"get","path":"/organizations/{organizationId}/networks"}}