{"type":"api","title":"List Categories","meta":{"id":"/apps/pubhub/media/legacy-umbrella-api/bf58de618cbb72dda8f39b0414ce94c0a15cd467/ca1cb6ac-c651-3cb6-9746-527b35467f3c","info":{"title":"Reporting API","description":"The Reporting API provides the data to generate the reports as seen on the Umbrella dashboard.","version":"1.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Activity"},{"name":"Top Identities"},{"name":"Identity Distribution"},{"name":"Top Destinations"},{"name":"Top Categories"},{"name":"Top Event Types"},{"name":"Top DNS query types"},{"name":"Organization Requests by Hour"},{"name":"Organization Requests by Timerange"},{"name":"Organization Requests by Hour and Category"},{"name":"Organization Requests by Timerange and Category"},{"name":"Deployment Status"},{"name":"MSP Deployment Status"},{"name":"MSP Requests by Hour"},{"name":"MSP Requests by Timerange"},{"name":"MSP Requests by Organization"},{"name":"MSP Requests by Category"},{"name":"MSP Requests by Destination"},{"name":"MSP Category Requests by Organization"},{"name":"Bandwidth by Hour"},{"name":"Bandwidth by Timerange"},{"name":"Top Files"},{"name":"Total Requests"},{"name":"Top Threats"},{"name":"Top Threat Types"},{"name":"Utility"},{"name":"Top IPs"},{"name":"Summary"},{"name":"Summaries by Category"},{"name":"Summaries by Destination"},{"name":"Summaries by Rule (Intrusion)"},{"name":"Remote Access"}],"x-parser-conf":{"oAuth2":{"clientId":"","clientSecret":"","proxyEnabled":true},"meta":{"useProxy":true}},"openapi":"3.0.1","servers":[{"url":"https://reports.api.umbrella.com/{basePath}","variables":{"basePath":{"default":"v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://management.api.umbrella.com/auth/v2/oauth2/token","scopes":{}}}}}},"spec":{"tags":["Utility"],"summary":"List Categories","description":"List categories.","operationId":"getCategories","parameters":[{"name":"organizationid","in":"path","description":"The organization ID","required":true,"schema":{"type":"number"},"example":1234567,"$$ref":"#/components/parameters/organizationIdParam"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"id of category"},"legacyid":{"type":"number","description":"legacy id used by older APIs in umbrella"},"label":{"type":"string","description":"the human readable label of the category"},"type":{"type":"string","description":"the type of category"},"integration":{"type":"boolean","description":"if the category is an integration"},"deprecated":{"type":"boolean","description":"if the category is a legacy category"}},"required":["id","integration","label","legacyid","type","deprecated"],"example":{"id":66,"legacyid":94,"label":"Malware","type":"security","integration":true,"deprecated":false},"$$ref":"#/components/schemas/CategoryWithLegacyId"}},"meta":{"type":"object","example":{},"$$ref":"#/components/schemas/Meta"}},"required":["data","meta"]},"example":{"data":[{"id":66,"legacyid":94,"label":"Malware","type":"security","integration":true,"deprecated":true},{"id":110,"legacyid":176,"label":"DNS Tunneling VPN","type":"security","integration":true,"deprecated":false}],"meta":{}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Invalid request"}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Unauthorized request"}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Forbidden"}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Not Found"}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Server error"}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getCategories","security":[{"oauthFlow":[]}],"method":"get","path":"/organizations/{organizationid}/categories"}}