{"type":"api","title":"Get Domain Status and Categorization","meta":{"id":"/apps/pubhub/media/legacy-umbrella-api/bf58de618cbb72dda8f39b0414ce94c0a15cd467/f963d12c-70c5-3340-bb7c-d5cff60c643a","info":{"title":"Investigate API","description":"Umbrella Investigate API","version":"1.1.4","contact":{"name":"Cloud Security Developer Community"}},"security":[{"bearerAuth":[]}],"tags":[{"name":"Domain Status and Categorization"},{"name":"Domain Volume"},{"name":"Co-occurrences for a Domain"},{"name":"Passive DNS"},{"name":"Tagging Timeline"},{"name":"Subdomains for a Domain"},{"name":"Related Domains for a Domain"},{"name":"Security Information for a Domain"},{"name":"AS Information for a Domain"},{"name":"WHOIS Information for a Domain"},{"name":"Umbrella Popularity List-Top Million Domains"},{"name":"Search Domain"},{"name":"Cisco Secure Malware Analytics Integration"}],"x-parser-conf":{"overview":{"markdownPath":"investigate/investigate-explorer-overview.md"}},"openapi":"3.0.0","servers":[{"url":"https://investigate.api.umbrella.com"}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"spec":{"summary":"Get Domain Status and Categorization","operationId":"getDomainsCategorization","tags":["Domain Status and Categorization"],"description":"Look up the status, and security and content category IDs for the domain.\nThe domain status is a numerical value determined by the Cisco Security Labs team.\nValid status values are: '-1' (malicious), '1' (safe), or '0' (undetermined status).\n","parameters":[{"name":"domain","in":"path","required":true,"description":"A domain name. For example, 'cisco.com'.","schema":{"type":"string"},"$$ref":"#/components/parameters/domainParam"},{"name":"showLabels","in":"query","required":false,"description":"Include the showLabels query parameter to display the human-readable\nor named category labels in the response.\nFor example: https://investigate.api.umbrella.com/domains/categorization/umbrella.com?showLabels","schema":{"type":"string"}}],"responses":{"200":{"description":"Everything worked as expected.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","format":"int64","description":"* If the domain is considered malicious, the status returned is `-1`.\n* If the domain is considered benign, the status returned is `1`.\n* If the domain is unclassified, the status returned is 0."},"security_categories":{"type":"array","items":{"properties":{"category":{"type":"string"}},"$$ref":"#/components/schemas/SecurityCategory"},"description":"The Umbrella security categories that match this domain.\nIf the domain does not match any security categories, the server returns an empty list."},"content_categories":{"type":"array","items":{"properties":{"category":{"type":"string"}},"description":"The Umbrella content categories, if any, that match the domain.","$$ref":"#/components/schemas/ContentCategory"},"description":"The Umbrella content categories that match this domain.\nIf the domain does not match any content categories, the server returns an empty list."}},"$$ref":"#/components/schemas/DomainCategorization"},"example":{"amazon.com":{"status":1,"security_categories":[],"content_categories":[8]}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getDomainsCategorization","security":[{"bearerAuth":[]}],"method":"get","path":"/domains/categorization/{domain}"}}