Check Status and Categorization of Domains - Cloud Security API

{"type":"api","title":"Check Status and Categorization of Domains","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/570121d2-76a9-3f3f-bf01-6671496640c5","info":{"title":"Cisco Secure Access Investigate API","description":"The Secure Access Investigate API provides a complete view of domains in relation to IP and autonomous system number (ASN) information.\nYou can get the following domain information:\n\n* Domain status, risk score, and geolocation\n* Number of domain searches\n* Co-occurring domains\n* Subdomains of a domain\n* Tagged timeline of a domain, IP, or URL\n* Security reputation of a domain\n* Top accessed domains\n* WHOIS information for the domain\n* Threat intelligence data for domains, IPs, and URLs\n* Threat intelligence samples by file hash","version":"2.0.0","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"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":"Popularity List-Top Million Domains"},{"name":"Search Domain"},{"name":"Cisco Secure Malware Analytics Integration"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/investigate/investigate-overview.md","uri":"secure-access-api-reference-investigate-api-overview"}},"openapi":"3.0.0","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"investigate/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"scopes":{"investigate.investigate:read":"Investigate read access","investigate.bulk:read":"Investigate bulk read access"},"tokenUrl":"https://api.sse.cisco.com/auth/v2/token"}}}}},"spec":{"summary":"Check Status and Categorization of Domains","operationId":"postDomainsCategorization","tags":["Domain Status and Categorization","Secure Access"],"description":"Provide a list of domains and look up the status, and security and content category IDs for each 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":"showLabels","in":"query","required":false,"description":"Include the `showLabels` query parameter to display the security and content category labels in the response.\nFor example: https://api.sse.cisco.com/investigate/v2/domains/categorization/umbrella.com?showLabels.","schema":{"type":"string"},"example":"https://api.sse.cisco.com/investigate/v2/domains/categorization/umbrella.com?showLabels","$$ref":"#/components/parameters/showLabels"}],"security":[{"oauthFlow":["investigate.bulk:read"]}],"requestBody":{"required":true,"description":"In a single request, the payload must not exceed 100KB and contain no more\nthan 1000 domains.","content":{"application/json":{"schema":{"type":"array","description":"The list of domains.","items":{"type":"string","description":"A domain name.","example":"yahoo.com"}},"example":["google.com","yahoo.com"]}}},"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","items":{"type":"object","description":"The information about the domain's content and security categories.\nUse the `showLabels` query parameter to display the security and content category labels\ninstead of the IDs.","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.","example":0},"security_categories":{"type":"array","items":{"type":"string","description":"A Secure Access security category.","example":"Cryptomining","$$ref":"#/components/schemas/SecurityCategory"},"description":"The security categories that match this domain.\nIf the domain does not match any security categories, the server returns an empty list.","example":["Cryptomining"]},"content_categories":{"type":"array","items":{"type":"string","description":"A Secure Access content category.","example":"Astrology","$$ref":"#/components/schemas/ContentCategory"},"description":"The content categories that match this domain.\nIf the domain does not match any content categories, the server returns an empty list.","example":["Astrology"]}},"example":{"status":1,"security_categories":["Malware","Phishing Attacks"],"content_categories":["Auctions","Chat and Instant Messaging"]},"$$ref":"#/components/schemas/DomainCategorization"}},"example":[{"google.com":null,"status":1,"security_categories":[],"content_categories":["23","25","190"]},{"yahoo.com":null,"status":1,"security_categories":[],"content_categories":["23","167"]}]}}},"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":{"message":{"type":"string"}}}}},"$$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":{"message":{"type":"string"}}}}},"$$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":{"message":{"type":"string"}}}}},"$$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":{"message":{"type":"string"}}}}},"$$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":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"postDomainsCategorization","method":"post","path":"/domains/categorization"}}