/accounts/{account_identifier}/brand-protection/submit
post
Phishing URL Scanner
phishing-url-scanner-submit-suspicious-url-for-scanning
nullnull[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"url": {
"description": "URL(s) to filter submissions results by",
"example": "https://www.cloudflare.com",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"type": "object"
}
}
},
"required": true
}{
"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": {
"excluded_urls": {
"description": "URLs that were excluded from scanning because their domain is in our no-scan list.",
"items": {
"properties": {
"url": {
"description": "URL that was excluded.",
"example": "https://developers.cloudflare.com",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"skipped_urls": {
"description": "URLs that were skipped because the same URL is currently being scanned",
"items": {
"properties": {
"url": {
"description": "URL that was skipped.",
"example": "https://www.cloudflare.com/developer-week/",
"type": "string"
},
"url_id": {
"description": "ID of the submission of that URL that is currently scanning.",
"example": 2,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"submitted_urls": {
"description": "URLs that were successfully submitted for scanning.",
"items": {
"properties": {
"url": {
"description": "URL that was submitted.",
"example": "https://www.cloudflare.com",
"type": "string"
},
"url_id": {
"description": "ID assigned to this URL submission. Used to retrieve scanning results.",
"example": 1,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
}
}
}
}
]
}
}
},
"description": "Submit suspicious URL for scanning 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": {
"excluded_urls": {
"description": "URLs that were excluded from scanning because their domain is in our no-scan list.",
"items": {
"properties": {
"url": {
"description": "URL that was excluded.",
"example": "https://developers.cloudflare.com",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"skipped_urls": {
"description": "URLs that were skipped because the same URL is currently being scanned",
"items": {
"properties": {
"url": {
"description": "URL that was skipped.",
"example": "https://www.cloudflare.com/developer-week/",
"type": "string"
},
"url_id": {
"description": "ID of the submission of that URL that is currently scanning.",
"example": 2,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"submitted_urls": {
"description": "URLs that were successfully submitted for scanning.",
"items": {
"properties": {
"url": {
"description": "URL that was submitted.",
"example": "https://www.cloudflare.com",
"type": "string"
},
"url_id": {
"description": "ID assigned to this URL submission. Used to retrieve scanning results.",
"example": 1,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
}
}
}
}
]
},
{
"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": "Submit suspicious URL for scanning response failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]