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 Admin API

Administrator tasks

Documentation Provider Profile APIs.io OpenAPI GitHub

FOSSology Admin 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 Admin. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 28 operations across 23 paths, and defines 19 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.

28 operations 23 paths 19 schemas 4 DELETE13 GET7 POST4 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 Admin 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 28

Across 23 paths, the API surfaces 28 operations — 4 DELETE, 13 GET, 7 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Admin 28

Administrator tasks

GET
/obligations/list
Get the list of obligations
getObligationsList → 200default
GET
/obligations/{id}
Get details of a particular obligation
getObligationsData 1 param → 200default
DELETE
/obligations/{id}
Delete a particular obligation
deleteObligationsData 1 param → 200default
GET
/obligations
Get details of a all obligations
getAllObligationsData → 200default
POST
/users
Create a new user
createUser body → 201409500default
GET
/users
Get the registered users
getUsers → 200default
GET
/users/{id}
Get user by id
getUserById 1 param → 200default
PUT
/users/{id}
Edit user details by id
modifyUserById 1 param body → 200400403404default
DELETE
/users/{id}
Delete user by id
deleteUserById 1 param → 202default
POST
/users/tokens
Create a new REST API Token
createRestApiToken body → 201400default
GET
/users/tokens/{type}
Get all the REST API tokens (active | expired)
getTokensByType 1 param → 200400default
GET
/jobs/scheduler/operation/{operationName}
get scheduler options by operation
getSchedulerOptionsByOperation 1 param → 200403default
POST
/jobs/scheduler/operation/run
Run the scheduler
handleSchedulerRun 3 params body → 200400403default
POST
/folders
Create a new folder
createFolder 4 params → 200201default
DELETE
/folders/{id}
Delete a folder
deleteFolderById 2 params → 202default
GET
/customise
Get the Admin configuration data
getCustomiseData → 200403default
PUT
/customise
Update the Admin configuration data
updateCustomiseData body → 200403default
POST
/groups
Create a new group
createGroup 1 param → 200400500default
POST
/groups/{id}/user/{userId}
Add user to a group
addMember 2 params body → 200400500default
DELETE
/license/admincandidates/{id}
Delete license candidate by id.
deleteByLicenseCandidateId 1 param → 202403500default
PUT
/license/verify/{shortname}
Verify a license as new or variant
verifyLicense 1 param body → 200400404500default
PUT
/license/merge/{shortname}
Merge a license with another
mergeLicense 1 param body → 200400404500default
GET
/overview/database/contents
Get database contents
getDatabaseContents → 200403500default
GET
/overview/info/php
Get PHP info
getPhpInfo → 200403500default
GET
/overview/disk/usage
Get disk usage
getDiskUsage → 200403500default
POST
/license/suggest
Get suggested license by reference text.
getSuggestedLicense body → 200403500default
GET
/overview/database/metrics
Get database metrics
getDatabaseMetrics → 200403500default
GET
/overview/queries/active
Get active queries
getActiveQueries → 200403500default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Analysis (13 properties), User (10 properties), GetSuggestedLicense (9 properties), HighlightInfo (8 properties). Each schema is shown below with its type and property counts.

SetCustomiseInfo
object
2 properties
AddMember
object
UserMember options
1 property
Analysis
object
13 properties
User
object
10 properties 1 required
Obligation
object
Obligation information
6 properties
TokenRequest
object
3 properties 5 required
Token
object
6 properties
GetDatabaseMetric
object
2 properties
GetPHPInfo
object
2 properties
ObligationsList
array
GetSuggestedLicense
object
9 properties
DiskUsage
object
2 properties
ObligationExtended
object
6 properties
Info
object
3 properties
GetSchedulerOption
object
4 properties
HighlightInfo
object
8 properties
GetDatabaseContent
object
4 properties
Customise
object
Admin customise data object
7 properties
GetActiveQuery
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fossology-admin-api-openapi.yml Raw ↑

Other APIs FOSSology publishes across the network.

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
FOSSology Search API
AE Profile APIs.io
#Admin
← Back to F APIs
API Details
ID
fossology:fossology-admin-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-admin-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/fossology-admin-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 Admin 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.