/components/build

post https://app.fossa.com/api/components/build

Upload a component and start asynchronously building it. Only SBOM imports are supported for non-premium accounts.

Query Params

packageSpec

string

required

The unresolved spec (i.e. a URL) that can be passed to a fetcher and resolved to a package id. For example:, underscore (npm), https://github.com/fossas/fossa (git), nokogiri (gem),

revision

string

required

The branch or revision of the component project being built.

dependency

boolean

description

string

The project description for the archive

fileType

string

The kind of component file to be built., If 'archive', the signed URL is for uplaoding a directory of source code., If 'sbom', the signed URL is for uploading an SBOM file (CycloneDX or SPDX).,

branch

string

jiraProjectKey

string

The corresponding Jira project for this component

link

string

A link to attach to this revision

projectURL

string

The URL of the project being uploaded

policy

string

The name of the policy for this build.

policyId

number

The ID of the policy for this build.

team

string

The name of the team connected to the project.

title

string

The title of the component.

releaseGroup

string

The title of release group to add the project to.

releaseGroupRelease

string

The title of release to add the project to.

labels

array of strings

Set of labels to apply to a project. If the org or the project have too many labels, then the labels will be applied in order until limits are hit.

labels

Body Params

archives

object

File upload metadata

selectedTeams

array

selectedTeams

forceRebuild

boolean

Force a rebuild no matter what

Responses

201

Created

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request POST \
2
     --url https://app.fossa.com/api/components/build \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

403Forbidden

500Server Error