Get scan's screenshot by resolution (desktop/mobile/tablet).
/accounts/{accountId}/urlscanner/scan/{scanId}/screenshot
get
URL Scanner
urlscanner-get-scan-screenshot
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}{
"enum": [
"com.cloudflare.api.account.url-scanner.read"
]
}[
{
"in": "path",
"name": "scanId",
"required": true,
"schema": {
"description": "Scan uuid",
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "accountId",
"required": true,
"schema": {
"description": "Account Id",
"type": "string"
}
},
{
"in": "query",
"name": "resolution",
"schema": {
"default": "desktop",
"description": "Target device type",
"enum": [
"desktop",
"mobile",
"tablet"
],
"type": "string"
}
}
]null{
"200": {
"content": {
"image/png": {
"schema": {
"description": "PNG Image",
"type": "string"
}
}
},
"description": "Returns the scan's requested screenshot."
},
"202": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"items": {
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"messages": {
"items": {
"properties": {
"message": {
"example": "In Progress",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"result": {
"properties": {
"scan": {
"properties": {
"task": {
"properties": {
"effectiveUrl": {
"example": "http://example.com/",
"type": "string"
},
"errors": {
"items": {
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"location": {
"example": "PT",
"type": "string"
},
"region": {
"example": "enam",
"type": "string"
},
"status": {
"example": "InProgress",
"type": "string"
},
"success": {
"example": true,
"type": "boolean"
},
"time": {
"example": "2023-05-03T17:05:04.843Z",
"type": "string"
},
"url": {
"example": "http://example.com",
"type": "string"
},
"uuid": {
"example": "2ee568d0-bf70-4827-b922-b7088c0f056f",
"type": "string"
},
"visibility": {
"example": "Public",
"type": "string"
}
},
"required": [
"uuid",
"url",
"status",
"success",
"errors",
"time",
"visibility",
"location",
"region",
"effectiveUrl"
],
"type": "object"
}
},
"required": [
"task"
],
"type": "object"
}
},
"required": [
"scan"
],
"type": "object"
},
"success": {
"description": "Whether request was successful or not",
"type": "boolean"
}
},
"required": [
"messages",
"errors",
"success",
"result"
],
"type": "object"
}
}
},
"description": "Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`."
},
"400": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"items": {
"properties": {
"message": {
"example": "Scan ID is not a valid uuid.",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"messages": {
"items": {
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether request was successful or not",
"type": "boolean"
}
},
"required": [
"messages",
"errors",
"success"
],
"type": "object"
}
}
},
"description": "Invalid params."
},
"404": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"items": {
"properties": {
"message": {
"example": "Scan not found.",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"messages": {
"items": {
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether request was successful or not",
"type": "boolean"
}
},
"required": [
"messages",
"errors",
"success"
],
"type": "object"
}
}
},
"description": "Scan not found."
}
}[
{
"api_email": [],
"api_key": []
}
]