Scan
POST
/api/v1/workspaces/{workspace}/scan
const url = 'https://example.com/api/v1/workspaces/example/scan';const options = {method: 'POST'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/workspaces/example/scanParameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspace
required
Workspace
string
Responses
Section titled “Responses”Successful Response
Media typeapplication/json
ScanResult
object
scanned
required
Scanned
integer
indexed
required
Indexed
integer
orphaned
required
Orphaned
integer
stale
required
Stale
integer
Examplegenerated
{ "scanned": 1, "indexed": 1, "orphaned": 1, "stale": 1}Validation Error
Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example", "input": "example", "ctx": {} } ]}