Skip to content

runners

Accessed as client.admin.runners; the async client mirrors it.

AdminRunners

The admin.runners namespace.

jobs

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

Search action jobs according to filter conditions.

This operation has been deprecated in Forgejo 15. Use /admin/actions/runners/jobs instead.

Parameters:

Name Type Description Default
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
  1. APIForbiddenError is a forbidden error response.
Deprecated

Deprecated in the vendored Spec; generated for compatibility.

Operation ID: adminSearchRunJobs

registration_token

registration_token() -> RegistrationToken

Get a runner registration token for registering global runners.

This operation has been deprecated in Forgejo 15. Use the web UI or /admin/actions/runners instead.

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: adminGetRegistrationToken

AsyncAdminRunners

The admin.runners namespace.

jobs

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

Search action jobs according to filter conditions.

This operation has been deprecated in Forgejo 15. Use /admin/actions/runners/jobs instead.

Parameters:

Name Type Description Default
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
  1. APIForbiddenError is a forbidden error response.
Deprecated

Deprecated in the vendored Spec; generated for compatibility.

Operation ID: adminSearchRunJobs

registration_token

registration_token() -> RegistrationToken

Get a runner registration token for registering global runners.

This operation has been deprecated in Forgejo 15. Use the web UI or /admin/actions/runners instead.

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: adminGetRegistrationToken