Docs

Get Fossabot Status

gethttps://app.fossa.com/api/fossabot/status

fossabot connection and credit status for the calling organization, optionally scoped to one project's repository.

Query parameters

projectLocatorstring

Scope the connection check to this project's repository.

Responses

200The fossabot connection status.
connectedbooleanrequired
appUrlstring | nullrequired
creditLevelenumrequired
availablelowexhaustednull
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 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.

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/status
curl --request GET \  --url 'https://app.fossa.com/api/fossabot/status' \  --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

projectLocatorstring

Scope the connection check to this project's repository.

← All Fossabot endpoints