Search
K
GitHub v3 REST API

Add organization access to a self-hosted runner group in an enterprise

Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see “Create a self-hosted runner group for an enterprise.”

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

put
{protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}

Path Parameters

enterprisestringrequired

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

runner_group_idintegerrequired

Unique identifier of the self-hosted runner group.

org_idintegerrequired

Unique identifier of an organization.

Response

204

Response

put/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}
 
204

Remove organization access to a self-hosted runner group in an enterprise

Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see “Create a self-hosted runner group for an enterprise.”

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

delete
{protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}

Path Parameters

enterprisestringrequired

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

runner_group_idintegerrequired

Unique identifier of the self-hosted runner group.

org_idintegerrequired

Unique identifier of an organization.

Response

204

Response

delete/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}
 
204

List self-hosted runners in a group for an enterprise

Lists the self-hosted runners that are in a specific enterprise group.

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

get
{protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

enterprisestringrequired

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

runner_group_idintegerrequired

Unique identifier of the self-hosted runner group.

Response

200 application/json

Response

total_countnumberrequired
runnersarray[object]required

A self hosted runner

Show Child Parameters
get/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners
 
200 application/json

Set self-hosted runners in a group for an enterprise

Replaces the list of self-hosted runners that are part of an enterprise runner group.

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

put
{protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners

Path Parameters

enterprisestringrequired

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

runner_group_idintegerrequired

Unique identifier of the self-hosted runner group.

Body

application/json
runnersarray[integer]required

Unique identifier of the runner.

Response

204

Response

put/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners

Body

{ "runners": [ 9, 2 ] }
 
204

Add a self-hosted runner to a group for an enterprise

Adds a self-hosted runner to a runner group configured in an enterprise.

You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.

put
{protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}

Path Parameters

enterprisestringrequired

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

runner_group_idintegerrequired

Unique identifier of the self-hosted runner group.

runner_idintegerrequired

Unique identifier of the self-hosted runner.

Response

204

Response

put/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
 
204