Get scan results by scan ID
curl --request POST \
--url https://app.chainpatrol.io/api/v2/scan/result \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"scanId": 123,
"workflowId": "<string>"
}
'import requests
url = "https://app.chainpatrol.io/api/v2/scan/result"
payload = {
"scanId": 123,
"workflowId": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({scanId: 123, workflowId: '<string>'})
};
fetch('https://app.chainpatrol.io/api/v2/scan/result', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.chainpatrol.io/api/v2/scan/result",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scanId' => 123,
'workflowId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.chainpatrol.io/api/v2/scan/result"
payload := strings.NewReader("{\n \"scanId\": 123,\n \"workflowId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.chainpatrol.io/api/v2/scan/result")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scanId\": 123,\n \"workflowId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chainpatrol.io/api/v2/scan/result")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scanId\": 123,\n \"workflowId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"scanId": 123,
"status": "PENDING",
"asset": {
"id": 123,
"type": "URL",
"content": "<string>"
},
"enrichments": [
{
"id": 123,
"type": "<string>",
"source": "<string>",
"status": "PENDING",
"createdAt": "<string>",
"updatedAt": "<string>",
"output": "<unknown>",
"error": "<unknown>"
}
],
"labels": [
{
"key": "<string>",
"value": "<string>",
"score": 123
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"result": {
"assetType": "URL",
"data": "<unknown>"
}
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Assets
Get Scan Result
Get detailed scan results including enrichments, rules/checks results, and labels for a specific asset scan.
POST
/
scan
/
result
Get scan results by scan ID
curl --request POST \
--url https://app.chainpatrol.io/api/v2/scan/result \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"scanId": 123,
"workflowId": "<string>"
}
'import requests
url = "https://app.chainpatrol.io/api/v2/scan/result"
payload = {
"scanId": 123,
"workflowId": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({scanId: 123, workflowId: '<string>'})
};
fetch('https://app.chainpatrol.io/api/v2/scan/result', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.chainpatrol.io/api/v2/scan/result",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scanId' => 123,
'workflowId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.chainpatrol.io/api/v2/scan/result"
payload := strings.NewReader("{\n \"scanId\": 123,\n \"workflowId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.chainpatrol.io/api/v2/scan/result")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"scanId\": 123,\n \"workflowId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chainpatrol.io/api/v2/scan/result")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scanId\": 123,\n \"workflowId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"scanId": 123,
"status": "PENDING",
"asset": {
"id": 123,
"type": "URL",
"content": "<string>"
},
"enrichments": [
{
"id": 123,
"type": "<string>",
"source": "<string>",
"status": "PENDING",
"createdAt": "<string>",
"updatedAt": "<string>",
"output": "<unknown>",
"error": "<unknown>"
}
],
"labels": [
{
"key": "<string>",
"value": "<string>",
"score": 123
}
],
"createdAt": "<string>",
"updatedAt": "<string>",
"result": {
"assetType": "URL",
"data": "<unknown>"
}
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Overview
Fetch the detailed results of an asset scan by scan ID, including enrichments, rules and checks results, and labels.Authorizations
Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.
Body
application/json
Response
Successful response
Was this page helpful?