Get Runs

JFrog REST APIs
Content Type
REST API

Description: Gets a collection of runs. Filter criteria can be supplied via query string parameters.

Security: Requires a valid user

Usage: GET api/v1/runs

Query Parameters:

Parameter

Data Type

Description

limit

integer

Optional. A limit on the number of runs returned.

skip

integer

Optional. A cursor for use in pagination. skip defines the number of runs skipped.

light

boolean

Optional. Default is false. If set to true only part of the data is returned

runIds

string

Optional. A filter on the list based on the id property of the run. Expects a comma separated string of runIds.

projectIds

string

Optional. A filter on the list based on the projectId property of the run. Expects a comma separated string of projectIds.

pipelineIds

string

Optional. Comma separated list of pipeline ids for which runs are being retrieved

pipelineSourceIds

string

Optional. Comma separated list of pipeline source ids for which runs are being retrieved

runNumbers

string

Optional. Comma separated list of run numbers

createdAfter

string

Optional. Runs created before the date

createdBefore

string

Optional. Runs created after the date

statusCodes

string

Optional. Comma separated string of status codes

sortBy

string

Optional. Comma separated list of sort attributes

sortOrder

integer

Optional. 1 for ascending and -1 for descending based onsortBy

Produces: application/json

Sample Usage:

Example: Get the successful (statusCode: 4002) runs created after a certain date for a specific pipeline (id: 375)

GET api/v1/runs?pipelineIds=375&statusCode=4002&createdAfter=2020-02-02T13:37:19.290Z
[
    {
        "staticPropertyBag": {
            "triggeredByUserName": "admin"
        },
        "id": 717,
        "pipelineId": 375,
        "pipelineSourceId": 544,
        "projectId": 1,
        "runNumber": 3,
        "statusCode": 4002,
        "endedAt": "2020-02-13T17:58:07.042Z",
        "startedAt": "2020-02-13T17:57:16.575Z",
        "createdAt": "2020-02-13T17:57:05.834Z",
        "updatedAt": "2020-02-13T17:58:16.438Z"
    },
    {
        "staticPropertyBag": {
            "triggeredByUserName": "admin"
        },
        "id": 528,
        "pipelineId": 375,
        "pipelineSourceId": 544,
        "projectId": 1,
        "runNumber": 1,
        "statusCode": 4002,
        "endedAt": "2020-02-04T13:38:20.958Z",
        "startedAt": "2020-02-04T13:37:26.666Z",
        "createdAt": "2020-02-04T13:37:19.290Z",
        "updatedAt": "2020-02-04T13:38:25.536Z"
    },
    {
        "staticPropertyBag": {
            "triggeredByUserName": "admin"
        },
        "id": 654,
        "pipelineId": 375,
        "pipelineSourceId": 544,
        "projectId": 1,
        "runNumber": 2,
        "statusCode": 4002,
        "endedAt": "2020-02-10T12:25:57.600Z",
        "startedAt": "2020-02-10T12:25:00.630Z",
        "createdAt": "2020-02-10T12:22:22.134Z",
        "updatedAt": "2020-02-10T12:26:06.832Z"
    }
]

Response Codes:

200: Success