runners

Accessed as client.orgs.actions.runners; the async client mirrors it.

SyncAsync

OrgsActionsRunners

The orgs.actions.runners namespace.

delete

delete(org: str, runner_id: str) -> None

Delete a particular runner that belongs to the organization.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`runner_id`	`str`	ID of the runner	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: deleteOrgRunner

get

get(org: str, runner_id: str) -> ActionRunner

Get a particular runner that belongs to the organization.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`runner_id`	`str`	ID of the runner	required

Returns:

Type	Description
`ActionRunner`	ActionRunner represents a runner.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: getOrgRunner

jobs

jobs(org: str, *, labels: str | None = None) -> list[ActionRunJob]

Search for organization's action jobs according filter conditions.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`labels`	`str \| None`	a comma separated list of run job labels to search for	`None`

Returns:

Type	Description
`list[ActionRunJob]`	RunJobList is a list of action run jobs.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: orgSearchRunJobs

list

list(
    org: str, *, visible: bool | None = None, page: int | None = None, limit: int | None = None
) -> Paginated[ActionRunner]

Get the organization's runners.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`visible`	`bool \| None`	whether to include all visible runners (true) or only those that are directly owned by the organization (false)	`None`
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`Paginated[ActionRunner]`	ActionRunnerList is a list of Forgejo Action runners.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: getOrgRunners

register

register(
    org: str, *, description: str | None = None, ephemeral: bool | None = None, name: str
) -> RegisterRunnerResponse

Register a new organization-level runner.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`description`	`str \| None`	Description of the runner to register.	`None`
`ephemeral`	`bool \| None`	Register as ephemeral runner https://forgejo.org/docs/latest/admin/actions/security/#ephemeral-runner	`None`
`name`	`str`	Name of the runner to register. The name of the runner does not have to be unique.	required

Returns:

Type	Description
`RegisterRunnerResponse`	RegisterRunnerResponse contains the details of the just registered runner.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: registerOrgRunner

registration_token

registration_token(org: str) -> RegistrationToken

Get the organization's runner registration token.

This operation has been deprecated in Forgejo 15. Use the web UI or /orgs/{org}/actions/runners instead.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required

Returns:

Type	Description
`RegistrationToken`	RegistrationToken is a string used to register a runner with a server.

Deprecated

Deprecated in the vendored Spec; generated for compatibility.

Operation ID: orgGetRunnerRegistrationToken

AsyncOrgsActionsRunners

The orgs.actions.runners namespace.

delete

delete(org: str, runner_id: str) -> None

Delete a particular runner that belongs to the organization.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`runner_id`	`str`	ID of the runner	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: deleteOrgRunner

get

get(org: str, runner_id: str) -> ActionRunner

Get a particular runner that belongs to the organization.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`runner_id`	`str`	ID of the runner	required

Returns:

Type	Description
`ActionRunner`	ActionRunner represents a runner.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: getOrgRunner

jobs

jobs(org: str, *, labels: str | None = None) -> list[ActionRunJob]

Search for organization's action jobs according filter conditions.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`labels`	`str \| None`	a comma separated list of run job labels to search for	`None`

Returns:

Type	Description
`list[ActionRunJob]`	RunJobList is a list of action run jobs.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: orgSearchRunJobs

list

list(
    org: str, *, visible: bool | None = None, page: int | None = None, limit: int | None = None
) -> AsyncPaginated[ActionRunner]

Get the organization's runners.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`visible`	`bool \| None`	whether to include all visible runners (true) or only those that are directly owned by the organization (false)	`None`
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`AsyncPaginated[ActionRunner]`	ActionRunnerList is a list of Forgejo Action runners.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: getOrgRunners

register

register(
    org: str, *, description: str | None = None, ephemeral: bool | None = None, name: str
) -> RegisterRunnerResponse

Register a new organization-level runner.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`description`	`str \| None`	Description of the runner to register.	`None`
`ephemeral`	`bool \| None`	Register as ephemeral runner https://forgejo.org/docs/latest/admin/actions/security/#ephemeral-runner	`None`
`name`	`str`	Name of the runner to register. The name of the runner does not have to be unique.	required

Returns:

Type	Description
`RegisterRunnerResponse`	RegisterRunnerResponse contains the details of the just registered runner.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: registerOrgRunner

registration_token

registration_token(org: str) -> RegistrationToken

Get the organization's runner registration token.

This operation has been deprecated in Forgejo 15. Use the web UI or /orgs/{org}/actions/runners instead.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required

Returns:

Type	Description
`RegistrationToken`	RegistrationToken is a string used to register a runner with a server.

Deprecated

Deprecated in the vendored Spec; generated for compatibility.

Operation ID: orgGetRunnerRegistrationToken