GIgitlab
runners
projects

Assign a runner to a project

Assigns an available project runner to a project.

post/api/v4/projects/{id}/runners

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

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

Request body

runner_idinteger required

The ID of a runner

Response

Assign a runner to a project

idinteger required
descriptionstring required
ip_addressstring required
activeboolean required
pausedboolean required
is_sharedboolean required
runner_type'instance_type' | 'group_type' | 'project_type' required
namestring required
onlineboolean required
created_atstring date-time required
statusstring required
job_execution_status'active' | 'idle' required

Example response

{
  "id": 8,
  "description": "test-1-20150125",
  "ip_address": "127.0.0.1",
  "active": true,
  "is_shared": true,
  "runner_type": "instance_type",
  "name": "test",
  "online": true,
  "created_by": {
    "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"
  },
  "created_at": "2025-05-03T00:00:00.000Z",
  "status": "online",
  "job_execution_status": "idle"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.