Docs

Retry Fossabot Dependency Upgrade PRAnalysis

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

Re-run fossabot's analysis on the issue's dependency-upgrade PR (the "analysis delayed" retry action). Analysis consumes fossabot credits.

Path parameters

issueIdintegerrequired

The FOSSA issue id.

Request body · application/json

projectLocatorstring

Required only when the issue affects more than one project.

Responses

200The refreshed 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

402The organization is out of fossabot credits.
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 or its fossabot PR does not exist.
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

409The analysis is already running and cannot be retried yet.
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/retry
curl --request POST \  --url 'https://app.fossa.com/api/fossabot/issues/1/dependency-upgrade-pr/retry' \  --header 'accept: application/json' \  --header 'authorization: Bearer YOUR_API_TOKEN' \  --header 'content-type: application/json' \  --data '{  "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