Docs

Create Fossabot Dependency Upgrade PR

posthttps://app.fossa.com/api/fossabot/issues/{issueId}/dependency-upgrade-pr

Ask fossabot to open a dependency-upgrade pull request for the issue. Asynchronous: the response is usually 'creating'; poll the GET endpoint with the returned jobId to watch it progress. Re-invoking after a failure starts a fresh attempt; invoking while a PR is already in flight returns the existing state.

Path parameters

issueIdintegerrequired

The FOSSA issue id.

Request body · application/json

fixenum

Which remediation target to use. Defaults to complete.

partialcomplete
projectLocatorstring

Required only when the issue affects more than one project.

Responses

200The freshly created (or already existing) PR state.
statusenumrequired
nonecreatingqueuedanalyzinganalysisNotRunneedsReviewreadyToMergemergedclosedfailed
vcsUrlstring | nullrequired

PR URL on the VCS provider. Null until the PR exists.

fossabotUrlstring | nullrequired

PR URL in the fossabot UI. Null until the PR exists.

isAnalysisDelayedbooleanrequired

True while analysis is taking longer than expected or should be retried.

jobIdstring | nullrequired

Creation-job id to pass back on the status endpoint.

400Bad Request
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

401Unauthorized
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

403The fossabot feature is not enabled or the caller lacks permission.
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

404The issue does not exist in the calling organization.
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

500Server Error
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

503The fossabot integration is not configured.
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

Try this endpoint

Build a request and run it against app.fossa.com.

Bearer

Stored in this browser for 24 hours. Try It uses a docs proxy for CORS and does not store tokens server-side.

POST https://app.fossa.com/api/fossabot/issues/1/dependency-upgrade-pr
curl --request POST \  --url 'https://app.fossa.com/api/fossabot/issues/1/dependency-upgrade-pr' \  --header 'accept: application/json' \  --header 'authorization: Bearer YOUR_API_TOKEN' \  --header 'content-type: application/json' \  --data '{  "fix": "partial",  "projectLocator": "string"}'

Real request. Mutating methods can change data.

Click Try It to run a request and see the response here.
Enter a Bearer token before running this request.

Path params

issueIdintegerrequired

The FOSSA issue id.

application/json
← All Fossabot endpoints