How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
FOSSology

FOSSology Upload API

Endpoints related to uploads

Documentation Provider Profile APIs.io OpenAPI GitHub

FOSSology Upload API is one of 15 APIs that FOSSology publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Upload. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 40 operations across 33 paths, and defines 39 schemas. It is described by OpenAPI 3.1.0, at version 1.6.2.

Requests are made against 2 base URLs: http://localhost/repo/api/v1, http://localhost/repo/api/v2.

40 operations 33 paths 39 schemas 2 DELETE25 GET1 PATCH7 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.6.2
Base URL
http://localhost/repo/api/v1
Authentication
HTTP Bearer, OAuth 2.0
Contact
fossology@fossology.org
License
GPL-2.0-only
Resource Areas
1

Authentication & Security 2

FOSSology Upload API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It supports OAuth 2.0 (oauth) using the clientCredentials flow. By default, every request must be authenticated.

  • bearerAuth — Token from FOSSology
  • oauth — Machine-2-Machine communication from oauth

Paths & Operations 40

Across 33 paths, the API surfaces 40 operations — 2 DELETE, 25 GET, 1 PATCH, 7 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Upload 40

Endpoints related to uploads

GET
/uploads/{id}
Get single upload by id
getUploadById 2 params → 200503default
DELETE
/uploads/{id}
Delete upload by id
deleteUploadById 2 params → 202default
PATCH
/uploads/{id}
Update an upload information
updateUploadById 4 params body → 202default
PUT
/uploads/{id}
Copy/Move an upload
moveUploadById 4 params → 202default
GET
/uploads
Uploads
getUploads 9 params → 200default
POST
/uploads
Post new upload to FOSSology
createUpload 7 params body → 201default
GET
/uploads/{id}/download
Download the file
getUploadFileById 1 param → 200403default
GET
/uploads/{id}/summary
Get single upload summary
getSummaryByUploadId 3 params → 200503default
GET
/uploads/{id}/item/{itemId}/info
Get single file info
getItemInfo 2 params → 200404default
GET
/uploads/{id}/licenses
Get licenses found by agent
getLicensesByUploadId 8 params → 200400503412default
GET
/uploads/{id}/copyrights
Get copyrights found on the upload
getCopyrightsByUploadId 1 param → 200503412default
PUT
/uploads/{id}/permissions
Set permissions for a upload in a folder for different groups
setUploadPermissions 1 param body → 202400404503default
GET
/uploads/{id}/perm-groups
Get all the groups with their respective permissions for a upload
getGroupsWithPermissions 1 param → 200404default
GET
/uploads/{id}/item/{itemId}/highlight
Get highlight entries of the content.
getHighlightEntries 6 params → 200400404500default
GET
/uploads/{id}/item/{itemId}/view
Get the contents of the file
viewTheContentOfTheFile 2 params → 200404500default
PUT
/uploads/{id}/item/{itemId}/clearing-decision
Set the clearing decision for a particular upload tree item.
setClearingDecision 2 params body → 200400500default
POST
/uploads/{id}/item/{itemId}/bulk-scan
Schedule the bulk scan for the item
scheduleBulkScan 2 params body → 200400404default
GET
/uploads/{id}/item/{itemId}/bulk-history
Get the bulk history
getBulkHistory 2 params → 200404500default
GET
/uploads/{id}/item/{itemId}/licenses
Get the license decisions list
getLicenseDecisions 2 params → 200404500default
PUT
/uploads/{id}/item/{itemId}/licenses
Add, update or delete a license decision.
addEditDeleteLicenseDecision 2 params body → 200400404500default
GET
/uploads/{id}/licenses/main
Get main licenses on the upload
getMainLicenses 1 param → 200404500default
POST
/uploads/{id}/licenses/main
Set the main license for the upload
setMainLicense 1 param body → 200400404500default
DELETE
/uploads/{id}/licenses/{shortName}/main
Delete a main license from an upload
deleteMainLicense 2 params → 200404500default
GET
/uploads/{id}/item/{itemId}/prev-next
Get previous and next item for an upload
getPreviousAndNextItem 3 params → 200404500default
GET
/uploads/{id}/item/{itemId}/clearing-history
Get the clearing history
getClearingHistory 2 params → 200404500default
GET
/uploads/{id}/clearing-progress
Get the clearing progress info
getClearingProgressInfo 1 param → 200404500default
GET
/uploads/{id}/licenses/histogram
Get the licenses histogram
getLicensesHistogram 2 params → 200404500default
GET
/uploads/{id}/agents
Get agents for a upload
getAgentsByUploadId 1 param → 200404500default
GET
/uploads/{id}/licenses/edited
Get the edited licenses list
getAllEditedLicenses 1 param → 200404500default
GET
/uploads/{id}/licenses/scanned
Get the scanned licenses list
getAllScannedLicenses 2 params → 200404500default
GET
/uploads/{id}/item/{itemId}/tree/view
Get the tree view for the given upload and item id
getItemTreeView 13 params → 200404500default
GET
/uploads/{id}/topitem
Get the top level item id for a given upload
getTopItemId 1 param → 200default
GET
/uploads/{id}/licenses/reuse
Get the overall licenses reuse summary
getLicensesReuseSummary 1 param → 200404500default
GET
/uploads/{id}/agents/revision
Get revisions for successful agents
getRevisionsForAgents 1 param → 200404500default
POST
/uploads/oneshot/nomos
Run one-shot nomos analysis
runOneShotNomos body → 200default
POST
/uploads/oneshot/monk
Run one-shot monk analysis
runOneShotMonk body → 200default
POST
/uploads/oneshot/ceu
Run one-shot Copyright/Email/URL analysis
runOneShotCEU body → 200default
POST
/filesearch
Get the information of files matching the provided hashes
getFiles 1 param body → 200default
GET
/uploads/{id}/conf
Get the conf information of a particular upload
getConfInfo 1 param → 200default
PUT
/uploads/{id}/conf
Update the Conf page data
updateConfData 1 param body → 200403default

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are ConfResponse (23 properties), Analysis (13 properties), UploadSummary (12 properties), Upload (10 properties). Each schema is shown below with its type and property counts.

Upload
object
10 properties
UploadPermGroups
object
Groups with their respective permissions for a upload
2 properties
File
object
Meta information about file in FOSSology
4 properties 1 required
ScannedLicense
object
5 properties
ScanOptions
object
4 properties
UploadCopyrights
array
LicenseDecision
object
Extended License model with additional fields
5 properties
Analysis
object
13 properties
ServerUpload
object
To create an upload from a server
2 properties 1 required
ClearingProgressInfo
object
2 properties
GetReuseReportSummary
object
Information required by Reuse Report Summary for an upload
4 properties
UploadSummary
object
12 properties
AgentsRevision
object
3 properties
GetBulkHistory
object
7 properties
Hash
object
Hash information of a file
4 properties
EditedLicense
object
4 properties
VcsUpload
object
To create an upload from a version control system
6 properties 2 required
OneShotInfo
object
2 properties
ConfResponse
object
23 properties
LicenseHistogram
object
4 properties
ScheduleBulkScan
object
7 properties
SetMainLicense
object
Set Main License information
1 property
Fileinfo
object
5 properties
License
object
License from the database
6 properties
LicenseDecider
object
7 properties
UrlUpload
object
To create an upload from a URL
5 properties 1 required
Info
object
3 properties
UploadLicenses
array
AddEditDeleteLicenseDecision
object
5 properties
HighlightInfo
object
8 properties
SetConfInfo
object
2 properties
ClearingDecision
object
Clearing decision information
2 properties
GetClearingHistory
object
6 properties
Findings
object
License findings and conclusions of file
3 properties
GetPrevNextItem
object
2 properties
Scancode
object
4 properties
TreeViewModel
object
5 properties
Reuser
object
6 properties 2 required
AgentOfUpload
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fossology-upload-api-openapi.yml Raw ↑

Other APIs FOSSology publishes across the network.

FOSSology Admin API
AE Profile APIs.io
FOSSology auth API
AE Profile APIs.io
FOSSology Copyrights API
AE Profile APIs.io
FOSSology Folders API
AE Profile APIs.io
FOSSology Groups API
AE Profile APIs.io
FOSSology info API
AE Profile APIs.io
FOSSology Job API
AE Profile APIs.io
FOSSology License API
AE Profile APIs.io
FOSSology Maintenance API
AE Profile APIs.io
FOSSology Organize API
AE Profile APIs.io
FOSSology Overview API
AE Profile APIs.io
FOSSology Report API
AE Profile APIs.io
#Upload
← Back to F APIs
API Details
ID
fossology:fossology-upload-api
Base URL
http://localhost/repo/api/v1
Docs
https://www.fossology.org/get-started/
Provider
FOSSology
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=fossology-upload-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/fossology-upload-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of FOSSology Upload API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.