List all upcoming jobs for a resource group

GET

/api/v4/projects/{id}/resource_groups/{key}/upcoming_jobs

Lists all upcoming jobs for a specified resource group.

Authorizations

http
oauth2

Parameters

Path Parameters

required

One of:

string
integer

string

The ID or URL-encoded path of the project owned by the authenticated user

key

required

string

The key of the resource group

Query Parameters

page

integer

default: 1 nullable

Current page number

Example

per_page

integer

default: 20 nullable

Number of items per page

Example

Responses

200

application/json

object

integer format: int64

status

string

stage

string

name

string

ref

string

tag

boolean

coverage

number format: float

allow_failure

boolean

created_at

string format: date-time

started_at

string format: date-time

finished_at

string format: date-time

erased_at

string format: date-time

duration

Time spent running

number format: float

queued_duration

Time spent enqueued

number format: float

user

object

integer format: int64

username

string

public_email

string

name

string

state

string

locked

boolean

avatar_url

string

avatar_path

string

custom_attributes

Array<object>

object

key

string

value

string

web_url

string

created_at

string

bio

string

location

string

linkedin

string

twitter

string

discord

string

website_url

string

github

string

job_title

string

pronouns

string

organization

string

bot

boolean

work_information

string

followers

string

following

string

is_followed

string

local_time

string

commit

object

string

short_id

string

created_at

string format: date-time

parent_ids

Array<string>

title

string

message

string

author_name

string

author_email

string

authored_date

string format: date-time

committer_name

string

committer_email

string

committed_date

string format: date-time

trailers

object

extended_trailers

object

web_url

string

pipeline

object

integer format: int64

iid

integer

project_id

integer format: int64

sha

string

ref

string

status

string

source

string

created_at

string format: date-time

updated_at

string format: date-time

web_url

string

failure_reason

string

web_url

string

project

string

Example

{
  "id": 1,
  "status": "waiting_for_resource",
  "stage": "deploy",
  "name": "deploy_to_production",
  "ref": "main",
  "coverage": 98.29,
  "created_at": "2015-12-24T15:51:21.880Z",
  "started_at": "2015-12-24T17:54:30.733Z",
  "finished_at": "2015-12-24T17:54:31.198Z",
  "erased_at": "2015-12-24T18:00:29.728Z",
  "duration": 0.465,
  "queued_duration": 0.123,
  "user": {
    "id": 1,
    "username": "admin",
    "public_email": "john@example.com",
    "name": "Administrator",
    "state": "active",
    "avatar_url": "https://gravatar.com/avatar/1",
    "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
    "custom_attributes": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "web_url": "https://gitlab.example.com/root"
  },
  "commit": {
    "id": "2695effb5807a22ff3d138d593fd856244e155e7",
    "short_id": "2695effb",
    "created_at": "2017-07-26T11:08:53.000+02:00",
    "parent_ids": [
      "2a4b78934375d7f53875269ffd4f45fd83a84ebe"
    ],
    "title": "Initial commit",
    "message": "Initial commit",
    "author_name": "John Smith",
    "author_email": "john@example.com",
    "authored_date": "2012-05-28T04:42:42-07:00",
    "committer_name": "Jack Smith",
    "committer_email": "jack@example.com",
    "committed_date": "2012-05-28T04:42:42-07:00",
    "trailers": {
      "Merged-By": "Jane Doe janedoe@gitlab.com"
    },
    "extended_trailers": {
      "Signed-off-by": [
        "John Doe <johndoe@gitlab.com>",
        "Jane Doe <janedoe@gitlab.com>"
      ]
    },
    "web_url": "https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746"
  },
  "pipeline": {
    "id": 1,
    "iid": 2,
    "project_id": 3,
    "sha": "0ec9e58fdfca6cdd6652c083c9edb53abc0bad52",
    "ref": "feature-branch",
    "status": "success",
    "source": "push",
    "created_at": "2022-10-21T16:49:48.000+02:00",
    "updated_at": "2022-10-21T16:49:48.000+02:00",
    "web_url": "https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61"
  },
  "failure_reason": "script_failure",
  "web_url": "https://example.com/foo/bar/-/jobs/1"
}

400

Bad Request

401

Unauthorized

404

Not found