Start an analysis
OpenAPI contract
- Method
- POST
- Path
/api/v1/analyses- Security
- jwtBearer (bearer)
- Response status
- 202 400 401 403 404 413 429 500
Request and response schemas
JSON
{
"requestBody": {
"multipart/form-data": {
"properties": {
"file": {
"format": "binary",
"type": "string"
}
},
"type": "object"
}
},
"responses": {
"202": {
"description": "Analysis accepted",
"content": {
"application/json": {
"$ref": "#/components/schemas/AnalysisResponse"
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"$ref": "#/components/schemas/RequestError"
}
}
},
"401": {
"description": "Authentication required",
"content": {
"application/json": {
"$ref": "#/components/schemas/SecurityError"
}
}
},
"403": {
"description": "Not permitted",
"content": {
"application/json": {
"$ref": "#/components/schemas/SecurityError"
}
}
},
"404": {
"description": "Analysis or input not found",
"content": {
"application/json": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"413": {
"description": "Upload or expanded archive exceeds its limit",
"content": {
"application/json": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"429": {
"description": "Request or concurrency limit exceeded",
"content": {
"application/json": {
"$ref": "#/components/schemas/RateLimitError"
}
}
},
"500": {
"description": "Unexpected server error",
"content": {
"application/json": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}Submit exactly one input source: a JAR file, an accessible buildId, or an analysisId whose original input you may read. Carry the complete current module configuration, including declarations prepared for several issues; reusing an analysis input does not reuse its old configuration implicitly. An optional project ID retains context. The returned analysis has a separate lifecycle from builds: it always costs 0 NCU and never holds credits. Upload, concurrent-task and resource limits still apply. Keep the submitted draft for evidence comparison; changing the input or configuration leaves earlier evidence unverified. Submission neither activates Object Localization nor saves a project configuration.