Register a new repository-level runner

POST

/repos/{owner}/{repo}/actions/runners

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

Request Body

Media typeapplication/json

RegisterRunnerOptions declares the accepted options for registering runners.

object

description

Description of the runner to register.

string

ephemeral

Register as ephemeral runner https://forgejo.org/docs/latest/admin/actions/security/#ephemeral-runner

boolean

name

required

Name of the runner to register. The name of the runner does not have to be unique.

string

Example^generated

{
  "description": "example",
  "ephemeral": true,
  "name": "example"
}

Responses

201

RegisterRunnerResponse contains the details of the just registered runner.

Media typeapplication/json

RegisterRunnerResponse contains the details of the just registered runner.

object

id

integer format: int64

token

string

uuid

string

Example^generated

{
  "id": 1,
  "token": "example",
  "uuid": "example"
}

400

APIError is error format response

Media typeapplication/json

APIError is an api error with a message

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}

401

APIUnauthorizedError is a unauthorized error response

Media typeapplication/json

object

message

string

url

string

Example^generated

{
  "message": "example",
  "url": "example"
}

404

APINotFound is a not found error response

Media typeapplication/json

object

errors

Array<string>

message

string

url

string

Example^generated

{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}