Get Steps

JFrog REST APIs

ft:sourceType
Paligo

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

Security: Requires a valid user

Usage: GET api/v1/steps

Consumes: application/json

Query Parameters:

Parameter

Data Type

Description

limit

integer

Optional. A limit on the number of steps returned.

skip

integer

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

pipelineIds

string

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

stepIds

string

Optional. Comma separated list of step ids for filtering

projectIds

string

Optional. Comma separated list of project ids for filtering

runIds

string

Optional. Comma separated list of run ids for filtering

pipelineSourceIds

string

Optional. Comma separated list of pipeline source ids for filtering

pipelineStepIds

string

Optional. Comma separated list of pipeline step ids for filtering

names

string

Optional. Comma separated list of name properties for filtering

statusCodes

string

Optional. Comma separated list of step status codes for filtering

affinityGroups

string

Optional. Comma separated list of step affinity groups for filtering

groupInProgress

boolean

Optional. Default is false. Filter based on the groupInProgress property of the resource

timeoutBefore

string

Optional. Selects steps with timeoutAt before the given date-time.

startedBefore

string

Optional. Selects steps with startedAt before the given date-time.

startedAfter

string

Optional. Selects steps with startedAt after the given date-time.

endedBefore

string

Optional. Selects steps with endedAt before the given date-time.

endedAfter

string

Optional. Selects steps with endedAt after the given date-time.

Produces: application/json

Sample Usage:

GET api/v1/steps?typeCode=2007&limit=1
[
    {
        "configPropertyBag": {
            "inputSteps": [
                {
                    "name": "step_3"
                },
                {
                    "name": "step_4"
                }
            ],
            "environmentVariables": [
                {
                    "key": "myReadEnvVariable",
                    "value": "hello",
                    "isReadOnly": true
                }
            ],
            "nodePool": "u16",
            "timeoutSeconds": 3600,
            "runtime": {
                "type": "image",
                "image": {
                    "imageName": "docker.bintray.io/jfrog/pipelines-u16node",
                    "imageTag": "10.18.0"
                }
            }
        },
        "execPropertyBag": {
            "onExecute": [
                "echo \"step 5\""
            ]
        },
        "id": 508,
        "pipelineId": 97,
        "pipelineSourceId": 129,
        "pipelineStepId": 192,
        "projectId": 1,
        "name": "step_5",
        "runId": 232,
        "statusCode": 4008,
        "typeCode": 2007,
        "affinityGroup": "step_5",
        "groupInProgress": false,
        "pendingLogsComplete": true,
        "isConsoleArchived": true,
        "fileStoreProvider": null,
        "pipelineStateArtifactName": null,
        "triggeredByResourceVersionId": null,
        "triggeredByStepId": null,
        "triggeredByIdentityId": 3,
        "triggeredAt": "2020-01-17T19:12:22.387Z",
        "timeoutAt": null,
        "readyAt": null,
        "queuedAt": null,
        "endedAt": "2020-01-17T19:12:49.800Z",
        "startedAt": null,
        "externalBuildId": null,
        "externalBuildUrl": null,
        "staticPropertyBag": null,
        "createdAt": "2020-01-17T19:12:22.419Z",
        "updatedAt": "2020-01-17T19:13:04.535Z"
    }
]

Response Codes:

200: Success