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

FOSSology Job API

FOSSology jobs

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

This API exposes 12 operations across 11 paths, and defines 12 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.

12 operations 11 paths 12 schemas 1 DELETE9 GET2 POST

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
Resource Areas
1

Authentication & Security 2

FOSSology Job 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 12

Across 11 paths, the API surfaces 12 operations — 1 DELETE, 9 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Job 12

FOSSology jobs

GET
/jobs
Gets all jobs created by the logged in user
getJobs 6 params → 200default
POST
/jobs
Schedule an Analysis
startJobs 3 params body → 201default
GET
/jobs/all
Gets all jobs created by all users
getAllJobs 4 params → 200403default
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
GET
/jobs/{id}
Gets single job by id
getJobById 1 param → 200default
GET
/jobs/history
Get the history of all the jobs queued based on an upload
getJobsHistoryPerUpload 1 param → 200400403404default
GET
/jobs/dashboard/statistics
Get the statistics of all the jobs
getJobStatistics → 200403default
GET
/jobs/dashboard
Gets all jobs server jobs with scheduler status
getAllServerJobs → 200403default
DELETE
/jobs/{id}/{queue}
Deletes a job using its Id and Queue
deleteJob 2 params → 200403404500default
GET
/report
Get the reports for a given upload
getReportsByUpload 3 params → 201default
GET
/report/{id}
Download the report
getReportById 2 params → 200503default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are JobQueue (13 properties), Analysis (13 properties), Job (8 properties), LicenseDecider (7 properties). Each schema is shown below with its type and property counts.

GetSchedulerOption
object
4 properties
GetJobStatistics
object
3 properties
ShowJob
object
History of all the jobs and the job queue info
4 properties
JobQueue
object
Structure of jobs queue
13 properties
Job
object
8 properties
ScanOptions
object
4 properties
AllServerJobs
object
2 properties
LicenseDecider
object
7 properties
Scancode
object
4 properties
Analysis
object
13 properties
Info
object
3 properties
Reuser
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fossology-job-api-openapi.yml Raw ↑

Other APIs FOSSology publishes across the network.

FOSSology Admin API
FOSSology auth API
FOSSology Copyrights API
FOSSology Folders API
FOSSology Groups API
FOSSology info API
FOSSology License API
FOSSology Maintenance API
FOSSology Organize API
FOSSology Overview API
FOSSology Report API
FOSSology Search API
Where this information came from

This is an independent, third-party profile of FOSSology Job 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.