List Network Devices - Cloud Security Gov

{"type":"api","title":"List Network Devices","meta":{"id":"/apps/pubhub/media/cloud-security-gov/cdd8786b84e1e4d80528d0eeb25987c136a18549/66220736-896b-3388-b606-4c1c459ca639","info":{"title":"Cisco Umbrella for Government Network Devices","version":"2.0.0","description":"Manage the network devices in your organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Network Devices","description":"Umbrella Network Device Management"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/network-devices-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrellagov.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrellagov.com/auth/v2/token","scopes":{"deployments.networkdevices:write":"Write deployments network devices","deployments.networkdevices:read":"Read deployments network devices"}}}}}},"spec":{"summary":"List Network Devices","operationId":"getAllNetworkDevices","tags":["Network Devices","Umbrella"],"description":"List the network devices.","security":[{"oauthFlow":["deployments.networkdevices:read"]}],"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":"array","description":"The list of networks devices.","items":{"type":"object","description":"The network device object.","minProperties":7,"required":["originId","deviceId","deviceKey","name","serialNumber","createdAt","organizationId"],"properties":{"originId":{"type":"integer","example":35872943,"minimum":1,"description":"The unique global identifier for this traffic source (origin). Use\nthe origin ID to manage the device. The origin ID is not used by the device."},"deviceId":{"type":"string","example":"0123456789abcdef","maxLength":16,"minLength":15,"description":"The unique identifier for the specific network device. Insert the identifier into the EDNS packets."},"deviceKey":{"type":"string","example":"ModelName-0123456789ab","description":"A descriptive unique identifier for the device. Not used by the\ndevice."},"name":{"type":"string","example":"APIDemoDevice","description":"The name of the device.","minLength":1},"serialNumber":{"type":"string","example":"12345a","description":"The serial number of the device."},"createdAt":{"type":"string","format":"date-time","example":"2017-09-22T04:18:51.000Z","description":"The time when the device was created. Specify an ISO 8601-formatted timestamp."},"organizationId":{"type":"integer","description":"The ID of the organization.","example":1234,"minimum":1}},"$$ref":"#/components/schemas/NetworkDeviceEntity"},"$$ref":"#/components/schemas/NetworkDeviceEntityList"},"example":[{"originId":35872943,"deviceId":"0123456789abcdef","deviceKey":"ModelName-0123456789ab","name":"APIDemoDevice","serialNumber":"12345a","createdAt":"2021-09-22T04:18:51.000Z","organizationId":1234}]}}},"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 error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getAllNetworkDevices","method":"get","path":"/networkdevices"}}