Skip to content
forgit api docs

Update a runner controller

PUT
/api/v4/runner_controllers/{id}

Updates the details of an existing runner controller by its ID.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer

ID of the runner controller

Request Body

Section titled “Request Body”
Media typeapplication/json
object
description

Description of the runner controller

string
nullable
Example
Controller for managing runner
state

State of the runner controller (disabled, enabled, dry_run)

string
nullable
Allowed values: disabled enabled dry_run

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
id
integer format: int64
description
string
state
string
created_at
string format: date-time
updated_at
string format: date-time
Example
{
  "id": 1,
  "description": "Controller for managing runner",
  "state": "enabled"
}

400

Section titled “400”

Bad Request

403

Section titled “403”

Forbidden

404

Section titled “404”

Not found