FOSSology

FOSSology Admin API

Administrator tasks

GitHub OpenAPI

Operations 28

GET /obligations/list Get the list of obligations #
GET /obligations/{id} Get details of a particular obligation #
DELETE /obligations/{id} Delete a particular obligation #
GET /obligations Get details of a all obligations #
POST /users Create a new user #
GET /users Get users #
GET /users/{id} Get user by id #
PUT /users/{id} Edit user details by id #
DELETE /users/{id} Delete user by id #
POST /users/tokens Create a new REST API Token #
GET /users/tokens/{type} Get all the REST API tokens (active | expired) #
GET /jobs/scheduler/operation/{operationName} get scheduler options by operation #
POST /jobs/scheduler/operation/run Run the scheduler #
POST /folders Create a new folder #
DELETE /folders/{id} Delete a folder #
GET /customise Get the Admin configuration data #
PUT /customise Update the Admin configuration data #
POST /groups Create a new group #
POST /groups/{id}/user/{userId} Add user to a group #
DELETE /license/admincandidates/{id} Delete license candidate by id #
PUT /license/verify/{shortname} Verify a license as new or variant #
PUT /license/merge/{shortname} Merge a license with another #
GET /overview/database/contents Get database contents #
GET /overview/info/php Get PHP info #
GET /overview/disk/usage Get disk usage #
POST /license/suggest Get suggested license by reference text #
GET /overview/database/metrics Get database metrics #
GET /overview/queries/active Get active queries #

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://artifacts.apis.io/fossology/openapi/fossology-admin-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/fossology/json-schema/fossology-upload.json
📊
JSONSchema
https://artifacts.apis.io/fossology/json-schema/fossology-license.json
📊
JSONSchema
https://artifacts.apis.io/fossology/json-schema/fossology-job.json

Other Resources

🔗
Rules
https://artifacts.apis.io/fossology/rules/fossology-rules.yml
🔗
Capabilities
https://artifacts.apis.io/fossology/capabilities/fossology-capabilities.yml
🔗
JSONLD
https://artifacts.apis.io/fossology/json-ld/fossology-context.jsonld
🔗
Vocabulary
https://artifacts.apis.io/fossology/vocabulary/fossology-vocabulary.yml
🔗
Examples
https://artifacts.apis.io/fossology/examples/fossology-upload-example.json
🔗
Examples
https://artifacts.apis.io/fossology/examples/fossology-license-example.json
🔗
SourceCode
https://github.com/fossology/fossology
🔗
APIsJSON
https://artifacts.apis.io/fossology/apis.yml

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:fossology-admin-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-admin-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: FOSSology Admin 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 (46 KB total) ---
# Full source: https://artifacts.apis.io/fossology/openapi/fossology-admin-api-openapi.yml