List Fossabot Dependency Upgrade PRs

gethttps://app.fossa.com/api/fossabot/dependency-upgrade-prs

One cursor-paginated slice of fossabot dependency-upgrade PRs for a project's repository. Provide either first (with optional after) or last (with optional before). A project that is not a fossabot-connected GitHub repository reads as an empty connection.

Query parameters

projectLocatorstringrequired

The project whose repository's PRs to list.

firstinteger

Number of PRs to return while traversing forward. Cannot be combined with last or before.

afterstring

Opaque end cursor from the preceding forward slice. Requires first.

lastinteger

Number of PRs to return while traversing backward. Cannot be combined with first or after.

beforestring

Opaque start cursor from the following backward slice. Requires last.

stateenum

Filter by VCS state.

opendraftclosedmerged

searchstring

Filter PRs by title.

sortenum

Sort order; newest first by default.

newestoldest

Responses

200One cursor-paginated slice of fossabot PRs.

nodesobject[]required

titlestringrequired

prNumberinteger | nullrequired

vcsUrlstring | nullrequired

fossabotUrlstring | nullrequired

PR detail page in the fossabot app. Null when fossabot did not give one.

stateenumrequired

opendraftclosedmerged

analysisBadgeenumrequired

scanninganalyzedneedsReviewnull

initiatedByUserIdinteger | nullrequired

FOSSA user id of the initiator; null for automated PRs.

initiatedByNamestring | nullrequired

Display name of the initiator; null for automated PRs and for ids with no user in the calling organization.

openedAtstring <date-time>required

closedAtstring | null <date-time>required

mergedAtstring | null <date-time>required

pageInfoobjectrequired

Cursor metadata for the requested traversal direction. Clients should retain cursors from visited slices to navigate back to them.

startCursorstring | nullrequired

endCursorstring | nullrequired

hasNextPagebooleanrequired

For forward requests, whether another forward slice exists. Always false for backward requests.

hasPreviousPagebooleanrequired

For backward requests, whether another backward slice exists. Always false for forward requests.

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

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 project 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

Try this endpoint

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

Language

Credentials

Bearer

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

GET https://app.fossa.com/api/fossabot/dependency-upgrade-prs

curl --request GET \  --url 'https://app.fossa.com/api/fossabot/dependency-upgrade-prs' \  --header 'accept: application/json' \  --header 'authorization: Bearer YOUR_API_TOKEN'

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.

Query params

projectLocatorstringrequired

The project whose repository's PRs to list.

firstinteger

Number of PRs to return while traversing forward. Cannot be combined with last or before.

afterstring

Opaque end cursor from the preceding forward slice. Requires first.

lastinteger

Number of PRs to return while traversing backward. Cannot be combined with first or after.

beforestring

Opaque start cursor from the following backward slice. Requires last.

stateenum

Filter by VCS state.

searchstring

Filter PRs by title.

sortenum

Sort order; newest first by default.

← All Fossabot endpoints