Request a job

POST

/api/v4/jobs/request

• GitLab REST API

Authorizations

• http
• oauth2

Request Body ^required

Media type application/json

object

token

required

Runner’s authentication token

string

nullable

system_id

Runner’s system identifier

string

nullable

last_update

Runner’s queue last_update token

string

nullable

info

Runner’s metadata

object

name

Runner’s name

string

nullable

version

Runner’s version

string

nullable

revision

Runner’s revision

string

nullable

platform

Runner’s platform

string

nullable

architecture

Runner’s architecture

string

nullable

executor

Runner’s executor

string

nullable

features

Runner’s features

object

config

Runner’s config

object

gpus

GPUs enabled

string

nullable

labels

Runner’s labels

object

session

Runner’s session data

object

url

Session’s url

string

nullable

certificate

Session’s certificate

string

nullable

authorization

Session’s authorization

string

nullable

Example ^generated

{
  "token": "example",
  "system_id": "example",
  "last_update": "example",
  "info": {
    "name": "example",
    "version": "example",
    "revision": "example",
    "platform": "example",
    "architecture": "example",
    "executor": "example",
    "features": {},
    "config": {
      "gpus": "example"
    },
    "labels": {}
  },
  "session": {
    "url": "example",
    "certificate": "example",
    "authorization": "example"
  }
}

Responses

201

Job was scheduled

Media type application/json

object

id

string

token

string

allow_git_fetch

string

job_info

object

id

string

name

string

stage

string

pipeline_id

string

project_id

string

project_name

string

project_full_path

string

namespace_id

string

root_namespace_id

string

organization_id

string

instance_id

string

instance_uuid

string

user_id

string

scoped_user_id

string

time_in_queue_seconds

string

project_jobs_running_on_instance_runners_count

string

queue_size

string

queue_depth

string

git_info

object

repo_url

string

ref

string

sha

string

before_sha

string

ref_type

string

refspecs

string

depth

string

repo_object_format

string

protected

string

runner_info

object

uuid

string

timeout

string

runner_session_url

string

inputs

string

variables

string

steps

object

name

string

script

string

timeout

string

when

string

allow_failure

string

hooks

object

name

string

script

string

image

object

name

string

entrypoint

string

ports

object

number

string

protocol

string

name

string

executor_opts

string

pull_policy

string

services

object

name

string

entrypoint

string

ports

object

number

string

protocol

string

name

string

executor_opts

string

pull_policy

string

alias

string

command

string

variables

string

artifacts

object

name

string

untracked

string

paths

string

exclude

string

when

string

expire_in

string

artifact_type

string

artifact_format

string

cache

object

key

string

untracked

string

paths

string

policy

string

when

string

fallback_keys

string

credentials

object

type

string

url

string

username

string

password

string

features

string

dependencies

string

run

string

suspend_options

string

secrets

string

policy_options

string

Example ^generated

{
  "id": "example",
  "token": "example",
  "allow_git_fetch": "example",
  "job_info": {
    "id": "example",
    "name": "example",
    "stage": "example",
    "pipeline_id": "example",
    "project_id": "example",
    "project_name": "example",
    "project_full_path": "example",
    "namespace_id": "example",
    "root_namespace_id": "example",
    "organization_id": "example",
    "instance_id": "example",
    "instance_uuid": "example",
    "user_id": "example",
    "scoped_user_id": "example",
    "time_in_queue_seconds": "example",
    "project_jobs_running_on_instance_runners_count": "example",
    "queue_size": "example",
    "queue_depth": "example"
  },
  "git_info": {
    "repo_url": "example",
    "ref": "example",
    "sha": "example",
    "before_sha": "example",
    "ref_type": "example",
    "refspecs": "example",
    "depth": "example",
    "repo_object_format": "example",
    "protected": "example"
  },
  "runner_info": {
    "uuid": "example",
    "timeout": "example",
    "runner_session_url": "example"
  },
  "inputs": "example",
  "variables": "example",
  "steps": {
    "name": "example",
    "script": "example",
    "timeout": "example",
    "when": "example",
    "allow_failure": "example"
  },
  "hooks": {
    "name": "example",
    "script": "example"
  },
  "image": {
    "name": "example",
    "entrypoint": "example",
    "ports": {
      "number": "example",
      "protocol": "example",
      "name": "example"
    },
    "executor_opts": "example",
    "pull_policy": "example"
  },
  "services": {
    "name": "example",
    "entrypoint": "example",
    "ports": {
      "number": "example",
      "protocol": "example",
      "name": "example"
    },
    "executor_opts": "example",
    "pull_policy": "example",
    "alias": "example",
    "command": "example",
    "variables": "example"
  },
  "artifacts": {
    "name": "example",
    "untracked": "example",
    "paths": "example",
    "exclude": "example",
    "when": "example",
    "expire_in": "example",
    "artifact_type": "example",
    "artifact_format": "example"
  },
  "cache": {
    "key": "example",
    "untracked": "example",
    "paths": "example",
    "policy": "example",
    "when": "example",
    "fallback_keys": "example"
  },
  "credentials": {
    "type": "example",
    "url": "example",
    "username": "example",
    "password": "example"
  },
  "features": "example",
  "dependencies": "example",
  "run": "example",
  "suspend_options": "example",
  "secrets": "example",
  "policy_options": "example"
}

204

No job for Runner

400

Bad Request

403

Forbidden

409

Conflict

422

Runner is orphaned

429

Too Many Requests