Plan a folder scan — keep engine then 202 receiving
curl --request POST \
--url https://{tenant}.earnie.dev/v1/scans:plan-folder \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"files": [
{
"path": "<string>",
"size": 1,
"is_dir": false,
"deleted": false
}
],
"name": "<string>",
"archive_filename": "<string>",
"enrichments": [],
"scanners": [],
"scan_context": {
"provider": "<string>",
"repository": {
"external_id": "<string>",
"full_name": "<string>"
},
"change_request": {
"number": 123,
"url": "<string>",
"base_sha": "<string>",
"head_sha": "<string>",
"base_ref": "<string>",
"head_ref": "<string>"
},
"commit_sha": "<string>",
"branch": "<string>",
"run": {
"ci_system": "<string>",
"url": "<string>",
"external_id": "<string>"
}
},
"gitignore": "aSDinaTvuI8gbWludGxpZnk=",
"settings": "aSDinaTvuI8gbWludGxpZnk="
}
'import requests
url = "https://{tenant}.earnie.dev/v1/scans:plan-folder"
payload = {
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"files": [
{
"path": "<string>",
"size": 1,
"is_dir": False,
"deleted": False
}
],
"name": "<string>",
"archive_filename": "<string>",
"enrichments": [],
"scanners": [],
"scan_context": {
"provider": "<string>",
"repository": {
"external_id": "<string>",
"full_name": "<string>"
},
"change_request": {
"number": 123,
"url": "<string>",
"base_sha": "<string>",
"head_sha": "<string>",
"base_ref": "<string>",
"head_ref": "<string>"
},
"commit_sha": "<string>",
"branch": "<string>",
"run": {
"ci_system": "<string>",
"url": "<string>",
"external_id": "<string>"
}
},
"gitignore": "aSDinaTvuI8gbWludGxpZnk=",
"settings": "aSDinaTvuI8gbWludGxpZnk="
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
files: [{path: '<string>', size: 1, is_dir: false, deleted: false}],
name: '<string>',
archive_filename: '<string>',
enrichments: [],
scanners: [],
scan_context: {
provider: '<string>',
repository: {external_id: '<string>', full_name: '<string>'},
change_request: {
number: 123,
url: '<string>',
base_sha: '<string>',
head_sha: '<string>',
base_ref: '<string>',
head_ref: '<string>'
},
commit_sha: '<string>',
branch: '<string>',
run: {ci_system: '<string>', url: '<string>', external_id: '<string>'}
},
gitignore: 'aSDinaTvuI8gbWludGxpZnk=',
settings: 'aSDinaTvuI8gbWludGxpZnk='
})
};
fetch('https://{tenant}.earnie.dev/v1/scans:plan-folder', 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://{tenant}.earnie.dev/v1/scans:plan-folder",
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([
'project_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'files' => [
[
'path' => '<string>',
'size' => 1,
'is_dir' => false,
'deleted' => false
]
],
'name' => '<string>',
'archive_filename' => '<string>',
'enrichments' => [
],
'scanners' => [
],
'scan_context' => [
'provider' => '<string>',
'repository' => [
'external_id' => '<string>',
'full_name' => '<string>'
],
'change_request' => [
'number' => 123,
'url' => '<string>',
'base_sha' => '<string>',
'head_sha' => '<string>',
'base_ref' => '<string>',
'head_ref' => '<string>'
],
'commit_sha' => '<string>',
'branch' => '<string>',
'run' => [
'ci_system' => '<string>',
'url' => '<string>',
'external_id' => '<string>'
]
],
'gitignore' => 'aSDinaTvuI8gbWludGxpZnk=',
'settings' => 'aSDinaTvuI8gbWludGxpZnk='
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://{tenant}.earnie.dev/v1/scans:plan-folder"
payload := strings.NewReader("{\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"files\": [\n {\n \"path\": \"<string>\",\n \"size\": 1,\n \"is_dir\": false,\n \"deleted\": false\n }\n ],\n \"name\": \"<string>\",\n \"archive_filename\": \"<string>\",\n \"enrichments\": [],\n \"scanners\": [],\n \"scan_context\": {\n \"provider\": \"<string>\",\n \"repository\": {\n \"external_id\": \"<string>\",\n \"full_name\": \"<string>\"\n },\n \"change_request\": {\n \"number\": 123,\n \"url\": \"<string>\",\n \"base_sha\": \"<string>\",\n \"head_sha\": \"<string>\",\n \"base_ref\": \"<string>\",\n \"head_ref\": \"<string>\"\n },\n \"commit_sha\": \"<string>\",\n \"branch\": \"<string>\",\n \"run\": {\n \"ci_system\": \"<string>\",\n \"url\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n },\n \"gitignore\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"settings\": \"aSDinaTvuI8gbWludGxpZnk=\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{tenant}.earnie.dev/v1/scans:plan-folder")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"files\": [\n {\n \"path\": \"<string>\",\n \"size\": 1,\n \"is_dir\": false,\n \"deleted\": false\n }\n ],\n \"name\": \"<string>\",\n \"archive_filename\": \"<string>\",\n \"enrichments\": [],\n \"scanners\": [],\n \"scan_context\": {\n \"provider\": \"<string>\",\n \"repository\": {\n \"external_id\": \"<string>\",\n \"full_name\": \"<string>\"\n },\n \"change_request\": {\n \"number\": 123,\n \"url\": \"<string>\",\n \"base_sha\": \"<string>\",\n \"head_sha\": \"<string>\",\n \"base_ref\": \"<string>\",\n \"head_ref\": \"<string>\"\n },\n \"commit_sha\": \"<string>\",\n \"branch\": \"<string>\",\n \"run\": {\n \"ci_system\": \"<string>\",\n \"url\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n },\n \"gitignore\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"settings\": \"aSDinaTvuI8gbWludGxpZnk=\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.earnie.dev/v1/scans:plan-folder")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"files\": [\n {\n \"path\": \"<string>\",\n \"size\": 1,\n \"is_dir\": false,\n \"deleted\": false\n }\n ],\n \"name\": \"<string>\",\n \"archive_filename\": \"<string>\",\n \"enrichments\": [],\n \"scanners\": [],\n \"scan_context\": {\n \"provider\": \"<string>\",\n \"repository\": {\n \"external_id\": \"<string>\",\n \"full_name\": \"<string>\"\n },\n \"change_request\": {\n \"number\": 123,\n \"url\": \"<string>\",\n \"base_sha\": \"<string>\",\n \"head_sha\": \"<string>\",\n \"base_ref\": \"<string>\",\n \"head_ref\": \"<string>\"\n },\n \"commit_sha\": \"<string>\",\n \"branch\": \"<string>\",\n \"run\": {\n \"ci_system\": \"<string>\",\n \"url\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n },\n \"gitignore\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"settings\": \"aSDinaTvuI8gbWludGxpZnk=\"\n}"
response = http.request(request)
puts response.read_body{
"scan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>"
},
"name": "<string>",
"status": "pending",
"archive_filename": "<string>",
"archive_sha256": "<string>",
"archive_size_bytes": 123,
"source_ref": "<string>",
"files_total": 123,
"files_scanned": 123,
"matches_total": 123,
"crypto_observations_available": true,
"created_by": {
"kind": "user",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"created_at": "2023-11-07T05:31:56Z",
"intent_hash": "<string>",
"reused": true,
"rerun_of": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cancellation_reason": "superseded",
"superseded_by_scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"triggers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "created",
"producer": "ui_upload",
"created_at": "2023-11-07T05:31:56Z"
}
],
"error_code": "<string>",
"error_message": "<string>",
"source_type": "upload",
"repo_full_name": "<string>",
"git_ref": "<string>",
"commit_sha": "<string>",
"result_ref": "<string>",
"crypto_diff_baseline": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"scanner_version": "<string>",
"scanner_api_url": "<string>",
"scanner_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"enrichments": [
"vulnerabilities"
],
"stages": [
{
"name": "<string>",
"state": "pending",
"items_processed": 123,
"items_total": 123,
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"warnings": [
"<string>"
]
}
],
"added_count": 123,
"persisted_count": 123,
"absent_count": 123,
"coverage": "full",
"result_scope": "project",
"scan_context": {
"producer": "ui_upload",
"coverage": "full",
"provider": "<string>",
"repository": {
"external_id": "<string>",
"full_name": "<string>"
},
"change_request": {
"number": 123,
"url": "<string>",
"base_sha": "<string>",
"head_sha": "<string>",
"base_ref": "<string>",
"head_ref": "<string>"
},
"commit_sha": "<string>",
"branch": "<string>",
"run": {
"ci_system": "<string>",
"url": "<string>",
"external_id": "<string>"
}
},
"effective": {
"scanners": [
"oss"
],
"enrichments": [
"vulnerabilities"
],
"coverage": "full",
"policy_snapshot": {
"policies": [
{
"policy_id": 123,
"revision": "<string>"
}
]
},
"fetch_lfs_models": true
},
"narrowed_from_request": [
{
"field": "coverage",
"requested": "<string>",
"effective": "<string>",
"reason": "<string>"
}
],
"gate": "pass",
"gate_reason": "no_policy_applies",
"evaluation": {
"status": "pending",
"policies_evaluated": 1,
"evaluated_at": "2023-11-07T05:31:56Z"
},
"codebase_divergence": {
"is_divergent": true,
"overlap_pct": 0.5,
"prior_components": 123
},
"publication": {
"state": "pending",
"targets": [
{
"revision": 123,
"target": "check",
"state": "pending",
"attempts": 123,
"provider_ref": "<string>",
"error_class": "retryable",
"last_error": "<string>",
"next_attempt_at": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
}
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}scans
Plan a folder scan — keep engine then 202 receiving
Submits a directory inventory plus optional root .gitignore and settings-file bytes. A diff producer lists removed paths as inventory entries with deleted: true and size: 0; those deletion markers are retained with the receiving plan but never enter the keep set or ingest. The server runs the keep engine (SDK scanning built-ins, gitignore, settings, org/project skip_patterns) and returns 202 with the scan (status=receiving) and the keep set.
The keep-set transfer is NOT complete: the client streams kept file bytes via PUT /v1/scans/{scanId}/ingest, then POST /v1/scans/{scanId}:commit-ingest. Caps apply to keep-set bytes and entry count (keep_set_too_large).
POST
/
v1
/
scans:plan-folder
Plan a folder scan — keep engine then 202 receiving
curl --request POST \
--url https://{tenant}.earnie.dev/v1/scans:plan-folder \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"files": [
{
"path": "<string>",
"size": 1,
"is_dir": false,
"deleted": false
}
],
"name": "<string>",
"archive_filename": "<string>",
"enrichments": [],
"scanners": [],
"scan_context": {
"provider": "<string>",
"repository": {
"external_id": "<string>",
"full_name": "<string>"
},
"change_request": {
"number": 123,
"url": "<string>",
"base_sha": "<string>",
"head_sha": "<string>",
"base_ref": "<string>",
"head_ref": "<string>"
},
"commit_sha": "<string>",
"branch": "<string>",
"run": {
"ci_system": "<string>",
"url": "<string>",
"external_id": "<string>"
}
},
"gitignore": "aSDinaTvuI8gbWludGxpZnk=",
"settings": "aSDinaTvuI8gbWludGxpZnk="
}
'import requests
url = "https://{tenant}.earnie.dev/v1/scans:plan-folder"
payload = {
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"files": [
{
"path": "<string>",
"size": 1,
"is_dir": False,
"deleted": False
}
],
"name": "<string>",
"archive_filename": "<string>",
"enrichments": [],
"scanners": [],
"scan_context": {
"provider": "<string>",
"repository": {
"external_id": "<string>",
"full_name": "<string>"
},
"change_request": {
"number": 123,
"url": "<string>",
"base_sha": "<string>",
"head_sha": "<string>",
"base_ref": "<string>",
"head_ref": "<string>"
},
"commit_sha": "<string>",
"branch": "<string>",
"run": {
"ci_system": "<string>",
"url": "<string>",
"external_id": "<string>"
}
},
"gitignore": "aSDinaTvuI8gbWludGxpZnk=",
"settings": "aSDinaTvuI8gbWludGxpZnk="
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
files: [{path: '<string>', size: 1, is_dir: false, deleted: false}],
name: '<string>',
archive_filename: '<string>',
enrichments: [],
scanners: [],
scan_context: {
provider: '<string>',
repository: {external_id: '<string>', full_name: '<string>'},
change_request: {
number: 123,
url: '<string>',
base_sha: '<string>',
head_sha: '<string>',
base_ref: '<string>',
head_ref: '<string>'
},
commit_sha: '<string>',
branch: '<string>',
run: {ci_system: '<string>', url: '<string>', external_id: '<string>'}
},
gitignore: 'aSDinaTvuI8gbWludGxpZnk=',
settings: 'aSDinaTvuI8gbWludGxpZnk='
})
};
fetch('https://{tenant}.earnie.dev/v1/scans:plan-folder', 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://{tenant}.earnie.dev/v1/scans:plan-folder",
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([
'project_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'files' => [
[
'path' => '<string>',
'size' => 1,
'is_dir' => false,
'deleted' => false
]
],
'name' => '<string>',
'archive_filename' => '<string>',
'enrichments' => [
],
'scanners' => [
],
'scan_context' => [
'provider' => '<string>',
'repository' => [
'external_id' => '<string>',
'full_name' => '<string>'
],
'change_request' => [
'number' => 123,
'url' => '<string>',
'base_sha' => '<string>',
'head_sha' => '<string>',
'base_ref' => '<string>',
'head_ref' => '<string>'
],
'commit_sha' => '<string>',
'branch' => '<string>',
'run' => [
'ci_system' => '<string>',
'url' => '<string>',
'external_id' => '<string>'
]
],
'gitignore' => 'aSDinaTvuI8gbWludGxpZnk=',
'settings' => 'aSDinaTvuI8gbWludGxpZnk='
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://{tenant}.earnie.dev/v1/scans:plan-folder"
payload := strings.NewReader("{\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"files\": [\n {\n \"path\": \"<string>\",\n \"size\": 1,\n \"is_dir\": false,\n \"deleted\": false\n }\n ],\n \"name\": \"<string>\",\n \"archive_filename\": \"<string>\",\n \"enrichments\": [],\n \"scanners\": [],\n \"scan_context\": {\n \"provider\": \"<string>\",\n \"repository\": {\n \"external_id\": \"<string>\",\n \"full_name\": \"<string>\"\n },\n \"change_request\": {\n \"number\": 123,\n \"url\": \"<string>\",\n \"base_sha\": \"<string>\",\n \"head_sha\": \"<string>\",\n \"base_ref\": \"<string>\",\n \"head_ref\": \"<string>\"\n },\n \"commit_sha\": \"<string>\",\n \"branch\": \"<string>\",\n \"run\": {\n \"ci_system\": \"<string>\",\n \"url\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n },\n \"gitignore\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"settings\": \"aSDinaTvuI8gbWludGxpZnk=\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://{tenant}.earnie.dev/v1/scans:plan-folder")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"files\": [\n {\n \"path\": \"<string>\",\n \"size\": 1,\n \"is_dir\": false,\n \"deleted\": false\n }\n ],\n \"name\": \"<string>\",\n \"archive_filename\": \"<string>\",\n \"enrichments\": [],\n \"scanners\": [],\n \"scan_context\": {\n \"provider\": \"<string>\",\n \"repository\": {\n \"external_id\": \"<string>\",\n \"full_name\": \"<string>\"\n },\n \"change_request\": {\n \"number\": 123,\n \"url\": \"<string>\",\n \"base_sha\": \"<string>\",\n \"head_sha\": \"<string>\",\n \"base_ref\": \"<string>\",\n \"head_ref\": \"<string>\"\n },\n \"commit_sha\": \"<string>\",\n \"branch\": \"<string>\",\n \"run\": {\n \"ci_system\": \"<string>\",\n \"url\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n },\n \"gitignore\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"settings\": \"aSDinaTvuI8gbWludGxpZnk=\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.earnie.dev/v1/scans:plan-folder")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"files\": [\n {\n \"path\": \"<string>\",\n \"size\": 1,\n \"is_dir\": false,\n \"deleted\": false\n }\n ],\n \"name\": \"<string>\",\n \"archive_filename\": \"<string>\",\n \"enrichments\": [],\n \"scanners\": [],\n \"scan_context\": {\n \"provider\": \"<string>\",\n \"repository\": {\n \"external_id\": \"<string>\",\n \"full_name\": \"<string>\"\n },\n \"change_request\": {\n \"number\": 123,\n \"url\": \"<string>\",\n \"base_sha\": \"<string>\",\n \"head_sha\": \"<string>\",\n \"base_ref\": \"<string>\",\n \"head_ref\": \"<string>\"\n },\n \"commit_sha\": \"<string>\",\n \"branch\": \"<string>\",\n \"run\": {\n \"ci_system\": \"<string>\",\n \"url\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n },\n \"gitignore\": \"aSDinaTvuI8gbWludGxpZnk=\",\n \"settings\": \"aSDinaTvuI8gbWludGxpZnk=\"\n}"
response = http.request(request)
puts response.read_body{
"scan": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>"
},
"name": "<string>",
"status": "pending",
"archive_filename": "<string>",
"archive_sha256": "<string>",
"archive_size_bytes": 123,
"source_ref": "<string>",
"files_total": 123,
"files_scanned": 123,
"matches_total": 123,
"crypto_observations_available": true,
"created_by": {
"kind": "user",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"created_at": "2023-11-07T05:31:56Z",
"intent_hash": "<string>",
"reused": true,
"rerun_of": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cancellation_reason": "superseded",
"superseded_by_scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"triggers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "created",
"producer": "ui_upload",
"created_at": "2023-11-07T05:31:56Z"
}
],
"error_code": "<string>",
"error_message": "<string>",
"source_type": "upload",
"repo_full_name": "<string>",
"git_ref": "<string>",
"commit_sha": "<string>",
"result_ref": "<string>",
"crypto_diff_baseline": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"scanner_version": "<string>",
"scanner_api_url": "<string>",
"scanner_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"enrichments": [
"vulnerabilities"
],
"stages": [
{
"name": "<string>",
"state": "pending",
"items_processed": 123,
"items_total": 123,
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"warnings": [
"<string>"
]
}
],
"added_count": 123,
"persisted_count": 123,
"absent_count": 123,
"coverage": "full",
"result_scope": "project",
"scan_context": {
"producer": "ui_upload",
"coverage": "full",
"provider": "<string>",
"repository": {
"external_id": "<string>",
"full_name": "<string>"
},
"change_request": {
"number": 123,
"url": "<string>",
"base_sha": "<string>",
"head_sha": "<string>",
"base_ref": "<string>",
"head_ref": "<string>"
},
"commit_sha": "<string>",
"branch": "<string>",
"run": {
"ci_system": "<string>",
"url": "<string>",
"external_id": "<string>"
}
},
"effective": {
"scanners": [
"oss"
],
"enrichments": [
"vulnerabilities"
],
"coverage": "full",
"policy_snapshot": {
"policies": [
{
"policy_id": 123,
"revision": "<string>"
}
]
},
"fetch_lfs_models": true
},
"narrowed_from_request": [
{
"field": "coverage",
"requested": "<string>",
"effective": "<string>",
"reason": "<string>"
}
],
"gate": "pass",
"gate_reason": "no_policy_applies",
"evaluation": {
"status": "pending",
"policies_evaluated": 1,
"evaluated_at": "2023-11-07T05:31:56Z"
},
"codebase_divergence": {
"is_divergent": true,
"overlap_pct": 0.5,
"prior_components": 123
},
"publication": {
"state": "pending",
"targets": [
{
"revision": 123,
"target": "check",
"state": "pending",
"attempts": 123,
"provider_ref": "<string>",
"error_class": "retryable",
"last_error": "<string>",
"next_attempt_at": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}
}
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
An Earnie API key, sent as Authorization: Bearer sk_earnie_.... Create one under Settings > API keys. The key's scopes decide which operations it may call.
Headers
Opaque client-generated key. Repeating the same request with the same key and actor returns the original receiving scan; reusing the key for a different request returns 409 idempotency_conflict.
Required string length:
1 - 255Body
application/json
Directory inventory (path, size, file vs directory). Bytes of file contents are not included.
Show child attributes
Show child attributes
Optional display name. Defaults to the folder name when supplied as archive_filename.
Display filename for the scan (e.g. the selected folder name).
Identifiers for optional PURL-driven enrichments. matching is the always-on core engine and is not an enrichment key. Dependency inventory is produced by the always-on dependency stage. Omitting enrichments defaults to ["vulnerabilities","licenses"].
Available options:
vulnerabilities, licenses Minimum array length:
1A scanner phase selected for source-code scan compute. ai is AI provenance. A Self-check does not run it, and an explicit request for it on a Self-check answers 400 invalid_scanners.
Available options:
oss, crypto, ai Optional submission provenance. The server derives or overwrites producer from the authenticated actor and validates coverage; everything else is persisted as supplied.
Show child attributes
Show child attributes
Optional root .gitignore bytes (base64). Same scope as the SDK: project root only.
Optional scanoss.json or settings.json bytes (base64).
Response
Scan created in receiving; keep set listed for transfer.
Show child attributes
Show child attributes