Docs

Get Builds

gethttps://app.fossa.com/api/builds

Retrieves a list of builds.

Query parameters

locatorstring

The revision locator to filter builds to

projectIdstring

The project locator to filter builds to

startDatestring <date-time>

The start date to filter builds to

endDatestring <date-time>

The end date to filter builds to

pageSizeinteger <int32>

The number of builds to return

pageinteger <int32>

The page number to return

sortstring

The sort order(s) to apply to the builds. Accepts a comma-separated list of one or more columns. Prefix a column with `-` to sort it in descending order (ascending is the default). Valid columns are: `cliVersionId`, `createdAt`, `id`, `locator`, `ownerId`, `taskId`, `updatedAt`. For example, `-createdAt,id` sorts by `createdAt` descending then `id` ascending.

Responses

200Build list

Array of:

idinteger

The ID for the build

locatorstring

The revision locator for the build

ownerIdinteger | null

The ID of the user who owns the build

errorstring | null

The error message for the build

warningsstring[]

The warning messages for the build

providedboolean

Is the build from a CLI upload

taskIdinteger | null

The ID of the task for the build

createdAtstring <date-time>

The date and time the build was created

updatedAtstring <date-time>

The date and time the build was last updated

cliVersionIdinteger

The ID of the CLI version for the build

revisionobject

The revision for the build

locatorstring

The revision locator for the build

projectIdstring

The project locator of the project for the build

messagestring

The message for the revision

taskobject

The task for the build

statusenum

The status of the task

CREATEDASSIGNEDRUNNINGSUCCEEDEDFAILED
startedstring <date-time>

The date and time the task was started

finishedstring <date-time>

The date and time the task was finished

createdAtstring <date-time>

The date and time the task was created

updatedAtstring <date-time>

The date and time the task was last updated

attempt_numberinteger

The number of attempts for the task

maxRetriesinteger

The maximum number of retries for the task

scheduledStartTimestring | null <date-time>

The date and time the task is scheduled to start

400Malformed Payload
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/builds
curl --request GET \  --url 'https://app.fossa.com/api/builds' \  --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

locatorstring

The revision locator to filter builds to

projectIdstring

The project locator to filter builds to

startDatestring

The start date to filter builds to

endDatestring

The end date to filter builds to

pageSizeinteger

The number of builds to return

pageinteger

The page number to return

sortstring

The sort order(s) to apply to the builds. Accepts a comma-separated list of one or more columns. Prefix a column with `-` to sort it in descending order (ascending is the default). Valid columns are: `cliVersionId`, `createdAt`, `id`, `locator`, `ownerId`, `taskId`, `updatedAt`. For example, `-createdAt,id` sorts by `createdAt` descending then `id` ascending.

← All Builds endpoints