FOSSology

FOSSology Upload API

Endpoints related to uploads

GitHub OpenAPI
Business capability
Open Source Stewardship BC-4200.60

Operations 40

GET /uploads/{id} Get single upload by id #
DELETE /uploads/{id} Delete upload by id #
PATCH /uploads/{id} Update upload by id #
PUT /uploads/{id} Copy/Move an upload #
GET /uploads Uploads #
POST /uploads Post new upload to FOSSology #
GET /uploads/{id}/download Download the file #
GET /uploads/{id}/summary Get single upload summary #
GET /uploads/{id}/item/{itemId}/info Get single file info #
GET /uploads/{id}/licenses Get licenses found by agent #
GET /uploads/{id}/copyrights Get copyrights found on the upload #
PUT /uploads/{id}/permissions Set permissions for a upload in a folder for different groups #
GET /uploads/{id}/perm-groups Get all the groups with their respective permissions for a upload #
GET /uploads/{id}/item/{itemId}/highlight Get highlight entries of the content #
GET /uploads/{id}/item/{itemId}/view Get the contents of the file #
PUT /uploads/{id}/item/{itemId}/clearing-decision Set the clearing decision for a particular upload tree item #
POST /uploads/{id}/item/{itemId}/bulk-scan Schedule the bulk scan for the item #
GET /uploads/{id}/item/{itemId}/bulk-history Get the bulk history #
GET /uploads/{id}/item/{itemId}/licenses Get the license decisions list #
PUT /uploads/{id}/item/{itemId}/licenses Add, update or delete a license decision #
GET /uploads/{id}/licenses/main Get main licenses on the upload #
POST /uploads/{id}/licenses/main Set the main license for the upload #
DELETE /uploads/{id}/licenses/{shortName}/main Delete a main license from an upload #
GET /uploads/{id}/item/{itemId}/prev-next Get previous and next item for an upload #
GET /uploads/{id}/item/{itemId}/clearing-history Get the clearing history #
GET /uploads/{id}/clearing-progress Get the clearing progress info #
GET /uploads/{id}/licenses/histogram Get the licenses histogram #
GET /uploads/{id}/agents Get agents for a upload #
GET /uploads/{id}/licenses/edited Get the edited licenses list #
GET /uploads/{id}/licenses/scanned Get the scanned licenses list #
GET /uploads/{id}/item/{itemId}/tree/view Get the tree view for the given upload and item id #
GET /uploads/{id}/topitem Get the top level item id for a given upload #
GET /uploads/{id}/licenses/reuse Get the overall licenses reuse summary #
GET /uploads/{id}/agents/revision Get revisions for successful agents #
POST /uploads/oneshot/nomos Run one-shot nomos analysis #
POST /uploads/oneshot/monk Run one-shot monk analysis #
POST /uploads/oneshot/ceu Run one-shot Copyright/Email/URL analysis #
POST /filesearch Get the information of files matching the provided hashes #
GET /uploads/{id}/conf Get the conf information of a particular upload #
PUT /uploads/{id}/conf Update the Conf page data #

Documentation

📖
Documentation
https://www.fossology.org/get-started/
📖
Documentation
https://www.fossology.org/get-started/basic-rest-api-calls/
📖
Documentation
https://github.com/fossology/fossology/wiki/FOSSology-REST-API

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/fossology/refs/heads/main/openapi/fossology-upload-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/fossology/refs/heads/main/json-schema/fossology-upload.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/fossology/refs/heads/main/json-schema/fossology-license.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/fossology/refs/heads/main/json-schema/fossology-job.json

Other Resources

🔗
Rules
https://raw.githubusercontent.com/api-evangelist/fossology/refs/heads/main/rules/fossology-rules.yml
🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/fossology/refs/heads/main/capabilities/fossology-capabilities.yml
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/fossology/refs/heads/main/json-ld/fossology-context.jsonld
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/fossology/refs/heads/main/vocabulary/fossology-vocabulary.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/fossology/refs/heads/main/examples/fossology-upload-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/fossology/refs/heads/main/examples/fossology-license-example.json
🔗
SourceCode
https://github.com/fossology/fossology

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/fossology-upload-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

fossology-upload-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: FOSSology Upload API
  description: Automate your fossology instance using REST API
  version: 1.6.2
  contact:
    email: fossology@fossology.org
  license:
    name: GPL-2.0-only
    url: https://github.com/fossology/fossology/blob/master/LICENSE
servers:
- url: http://localhost/repo/api/v1
  description: Localhost instance
- url: http://localhost/repo/api/v2
  description: Localhost instance (Version 2)
security:
- bearerAuth: []
- oauth: []
tags:


# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fossology/refs/heads/main/openapi/fossology-upload-api-openapi.yml