Scans
Trigger Scan
Start a scan job and poll for completion
POST
/
api
/
v1
/
scan
/
trigger
Trigger Scan
curl --request POST \
--url http://localhost:8000/api/v1/scan/trigger \
--header 'Content-Type: application/json' \
--data '
{
"workspace_path": "<string>",
"profile": "<string>"
}
'import requests
url = "http://localhost:8000/api/v1/scan/trigger"
payload = {
"workspace_path": "<string>",
"profile": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({workspace_path: '<string>', profile: '<string>'})
};
fetch('http://localhost:8000/api/v1/scan/trigger', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/api/v1/scan/trigger",
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([
'workspace_path' => '<string>',
'profile' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "http://localhost:8000/api/v1/scan/trigger"
payload := strings.NewReader("{\n \"workspace_path\": \"<string>\",\n \"profile\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:8000/api/v1/scan/trigger")
.header("Content-Type", "application/json")
.body("{\n \"workspace_path\": \"<string>\",\n \"profile\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/scan/trigger")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspace_path\": \"<string>\",\n \"profile\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"scan_id": "<string>",
"status": "<string>",
"started_at": "<string>"
}Triggers a scan from the UI. The endpoint returns immediately; clients should poll Request body —
/scan/status/{scan_id} for completion.
Only one scan can run at a time. A second concurrent trigger returns 409 A scan is already running. Stale job records (>30 min old) are pruned on each trigger.
Request body — ScanTriggerPayload
string
required
Absolute path to the OpenClaw workspace (must contain
openclaw.json).string
default:"L1"
Benchmark profile.
Errors
400— Path is not a valid OpenClaw workspace409— A scan is already running
Response
string
Job ID for status polling (12-char hex)
string
Always
running on a successful triggerstring
ISO-8601 timestamp
⌘I
Trigger Scan
curl --request POST \
--url http://localhost:8000/api/v1/scan/trigger \
--header 'Content-Type: application/json' \
--data '
{
"workspace_path": "<string>",
"profile": "<string>"
}
'import requests
url = "http://localhost:8000/api/v1/scan/trigger"
payload = {
"workspace_path": "<string>",
"profile": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({workspace_path: '<string>', profile: '<string>'})
};
fetch('http://localhost:8000/api/v1/scan/trigger', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/api/v1/scan/trigger",
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([
'workspace_path' => '<string>',
'profile' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "http://localhost:8000/api/v1/scan/trigger"
payload := strings.NewReader("{\n \"workspace_path\": \"<string>\",\n \"profile\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:8000/api/v1/scan/trigger")
.header("Content-Type", "application/json")
.body("{\n \"workspace_path\": \"<string>\",\n \"profile\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/scan/trigger")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspace_path\": \"<string>\",\n \"profile\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"scan_id": "<string>",
"status": "<string>",
"started_at": "<string>"
}
