/accounts/{account_identifier}/brand-protection/url-info
get
Phishing URL Information
phishing-url-information-get-results-for-a-url-scan
nullnull[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "url_id_param",
"schema": {
"properties": {
"url_id": {
"description": "Submission ID(s) to filter submission results by.",
"type": "integer"
}
},
"type": "object"
}
},
{
"in": "query",
"name": "url",
"schema": {
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"categorizations": {
"description": "List of categorizations applied to this submission.",
"items": {
"properties": {
"category": {
"description": "Name of the category applied.",
"example": "PHISHING",
"type": "string"
},
"verification_status": {
"description": "Result of human review for this categorization.",
"example": "confirmed",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"model_results": {
"description": "List of model results for completed scans.",
"items": {
"properties": {
"model_name": {
"description": "Name of the model.",
"example": "MACHINE_LEARNING_v2",
"type": "string"
},
"model_score": {
"description": "Score output by the model for this submission.",
"example": 0.024,
"type": "number"
}
},
"type": "object"
},
"type": "array"
},
"rule_matches": {
"description": "List of signatures that matched against site content found when crawling the URL.",
"items": {
"properties": {
"banning": {
"description": "For internal use.",
"type": "boolean"
},
"blocking": {
"description": "For internal use.",
"type": "boolean"
},
"description": {
"description": "Description of the signature that matched.",
"example": "Match frequently used social followers phishing kit",
"type": "string"
},
"name": {
"description": "Name of the signature that matched.",
"example": "phishkit.social_followers",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"scan_status": {
"description": "Status of the most recent scan found.",
"properties": {
"last_processed": {
"description": "Timestamp of when the submission was processed.",
"example": "Wed, 26 Oct 2022 16:04:51 GMT",
"type": "string"
},
"scan_complete": {
"description": "For internal use.",
"type": "boolean"
},
"status_code": {
"description": "Status code that the crawler received when loading the submitted URL.",
"type": "integer"
},
"submission_id": {
"description": "ID of the most recent submission.",
"type": "integer"
}
},
"type": "object"
},
"screenshot_download_signature": {
"description": "For internal use.",
"type": "string"
},
"screenshot_path": {
"description": "For internal use.",
"type": "string"
},
"url": {
"description": "URL that was submitted.",
"example": "https://www.cloudflare.com",
"type": "string"
}
}
}
}
}
]
}
}
},
"description": "Get results for a URL scan response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"categorizations": {
"description": "List of categorizations applied to this submission.",
"items": {
"properties": {
"category": {
"description": "Name of the category applied.",
"example": "PHISHING",
"type": "string"
},
"verification_status": {
"description": "Result of human review for this categorization.",
"example": "confirmed",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"model_results": {
"description": "List of model results for completed scans.",
"items": {
"properties": {
"model_name": {
"description": "Name of the model.",
"example": "MACHINE_LEARNING_v2",
"type": "string"
},
"model_score": {
"description": "Score output by the model for this submission.",
"example": 0.024,
"type": "number"
}
},
"type": "object"
},
"type": "array"
},
"rule_matches": {
"description": "List of signatures that matched against site content found when crawling the URL.",
"items": {
"properties": {
"banning": {
"description": "For internal use.",
"type": "boolean"
},
"blocking": {
"description": "For internal use.",
"type": "boolean"
},
"description": {
"description": "Description of the signature that matched.",
"example": "Match frequently used social followers phishing kit",
"type": "string"
},
"name": {
"description": "Name of the signature that matched.",
"example": "phishkit.social_followers",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"scan_status": {
"description": "Status of the most recent scan found.",
"properties": {
"last_processed": {
"description": "Timestamp of when the submission was processed.",
"example": "Wed, 26 Oct 2022 16:04:51 GMT",
"type": "string"
},
"scan_complete": {
"description": "For internal use.",
"type": "boolean"
},
"status_code": {
"description": "Status code that the crawler received when loading the submitted URL.",
"type": "integer"
},
"submission_id": {
"description": "ID of the most recent submission.",
"type": "integer"
}
},
"type": "object"
},
"screenshot_download_signature": {
"description": "For internal use.",
"type": "string"
},
"screenshot_path": {
"description": "For internal use.",
"type": "string"
},
"url": {
"description": "URL that was submitted.",
"example": "https://www.cloudflare.com",
"type": "string"
}
}
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Get results for a URL scan response failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]