Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.
O GitHub AE está atualmente sob versão limitada. Entre em contato com nossa Equipe de Vendas para saber mais.
GitHub AE
Português do Brasil
 
REST API
GitHub AE
Português do Brasil

 

Grupos de runner auto-hospedados

A API dos Grupos de Runners auto-hospedados permite que você gerencie grupos de runners auto-hospedados.

Sobre a API de grupos de executores auto-hospedados

A API de grupos de executores auto-hospedados permite que você gerencie grupos de executores auto-hospedados. Para obter mais informações, consulte "Gerenciando acesso a runners auto-hospedados usando grupos".

Esta API está disponível para usuários autenticados, Aplicativos OAuth e Aplicativos do GitHub. Os tokens de acesso exigem o escopo repositório para repositórios privados e escopo public_repo para repositórios internos. Aplicativos do GitHub deve ter a permissão de administração `para repositórios ou a permissãoorganization_self_hosted_runnerspara as organizações. Os usuários autenticados devem ter acesso de administrador a repositórios ou organizações ou ao escopomanage_runners:corporativo` para que as empresas usem esta API.

List self-hosted runner groups for an enterprise

Lists all self-hosted runner groups for an enterprise.

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

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
enterprisestringObrigatório

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

Parâmetros de consulta
per_pageinteger

The number of results per page (max 100).

Padrão: 30

pageinteger

Page number of the results to fetch.

Padrão: 1

HTTP response status codes

Status codeDescrição
200

OK

Amostras de código

get/enterprises/{enterprise}/actions/runner-groups
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups

Response

Status: 200
{ "total_count": 3, "runner_groups": [ { "id": 1, "name": "Default", "visibility": "all", "default": true, "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners", "allows_public_repositories": false }, { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations", "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners", "allows_public_repositories": true }, { "id": 3, "name": "expensive-hardware", "visibility": "private", "default": false, "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners", "allows_public_repositories": true } ] }

Create a self-hosted runner group for an enterprise

Creates a new self-hosted runner group for an enterprise.

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

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
enterprisestringObrigatório

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

Body parameters
namestringObrigatório

Name of the runner group.

visibilitystring

Visibility of a runner group. You can select all organizations or select individual organization.

Pode ser uma das ações a seguir: selected, all

selected_organization_idsarray of integers

List of organization IDs that can access the runner group.

runnersarray of integers

List of runner IDs to add to the runner group.

allows_public_repositoriesboolean

Whether the runner group can be used by public repositories.

Padrão: false

HTTP response status codes

Status codeDescrição
201

Created

Amostras de código

post/enterprises/{enterprise}/actions/runner-groups
curl \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups \ -d '{"name":"Expensive hardware runners","visibility":"selected","selected_organization_ids":[32,91],"runners":[9,2]}'

Response

Status: 201
{ "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", "allows_public_repositories": false }

Get a self-hosted runner group for an enterprise

Gets a specific self-hosted runner group for an enterprise.

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

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
enterprisestringObrigatório

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

runner_group_idintegerObrigatório

Unique identifier of the self-hosted runner group.

HTTP response status codes

Status codeDescrição
200

OK

Amostras de código

get/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID

Response

Status: 200
{ "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", "allows_public_repositories": false }

Update a self-hosted runner group for an enterprise

Updates the name and visibility of a self-hosted runner group in an enterprise.

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

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
enterprisestringObrigatório

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

runner_group_idintegerObrigatório

Unique identifier of the self-hosted runner group.

Body parameters
namestring

Name of the runner group.

visibilitystring

Visibility of a runner group. You can select all organizations or select individual organizations.

Padrão: all

Pode ser uma das ações a seguir: selected, all

allows_public_repositoriesboolean

Whether the runner group can be used by public repositories.

Padrão: false

HTTP response status codes

Status codeDescrição
200

OK

Amostras de código

patch/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
curl \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID \ -d '{"name":"Expensive hardware runners","visibility":"selected"}'

Response

Status: 200
{ "id": 2, "name": "Expensive hardware runners", "visibility": "selected", "default": false, "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", "allows_public_repositories": true }

Delete a self-hosted runner group from an enterprise

Deletes a self-hosted runner group for an enterprise.

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

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
enterprisestringObrigatório

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

runner_group_idintegerObrigatório

Unique identifier of the self-hosted runner group.

HTTP response status codes

Status codeDescrição
204

No Content

Amostras de código

delete/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID

Response

Status: 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 manage_runners:enterprise scope to use this endpoint.

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
enterprisestringObrigatório

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

runner_group_idintegerObrigatório

Unique identifier of the self-hosted runner group.

Parâmetros de consulta
per_pageinteger

The number of results per page (max 100).

Padrão: 30

pageinteger

Page number of the results to fetch.

Padrão: 1

HTTP response status codes

Status codeDescrição
200

OK

Amostras de código

get/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID/runners

Response

Status: 200
{ "total_count": 2, "runners": [ { "id": 23, "name": "linux_runner", "os": "linux", "status": "online", "busy": true, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 11, "name": "Linux", "type": "read-only" } ] }, { "id": 24, "name": "mac_runner", "os": "macos", "status": "offline", "busy": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } ] }

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 manage_runners:enterprise scope to use this endpoint.

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
enterprisestringObrigatório

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

runner_group_idintegerObrigatório

Unique identifier of the self-hosted runner group.

Body parameters
runnersarray of integersObrigatório

List of runner IDs to add to the runner group.

HTTP response status codes

Status codeDescrição
204

No Content

Amostras de código

put/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners
curl \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID/runners \ -d '{"runners":[9,2]}'

Response

Status: 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 manage_runners:enterprise scope to use this endpoint.

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
enterprisestringObrigatório

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

runner_group_idintegerObrigatório

Unique identifier of the self-hosted runner group.

runner_idintegerObrigatório

Unique identifier of the self-hosted runner.

HTTP response status codes

Status codeDescrição
204

No Content

Amostras de código

put/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
curl \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID/runners/RUNNER_ID

Response

Status: 204

Remove a self-hosted runner from a group for an enterprise

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

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

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
enterprisestringObrigatório

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

runner_group_idintegerObrigatório

Unique identifier of the self-hosted runner group.

runner_idintegerObrigatório

Unique identifier of the self-hosted runner.

HTTP response status codes

Status codeDescrição
204

No Content

Amostras de código

delete/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID/runners/RUNNER_ID

Response

Status: 204

List self-hosted runner groups for an organization

Works with GitHub Apps

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. You must authenticate using an access token with the admin:org scope to use this endpoint.

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringObrigatório

The organization name. The name is not case sensitive.

Parâmetros de consulta
per_pageinteger

The number of results per page (max 100).

Padrão: 30

pageinteger

Page number of the results to fetch.

Padrão: 1

HTTP response status codes

Status codeDescrição
200

OK

Amostras de código

get/orgs/{org}/actions/runner-groups
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/actions/runner-groups

Response

Status: 200
{ "total_count": 3, "runner_groups": [ { "id": 1, "name": "Default", "visibility": "all", "default": true, "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", "inherited": false, "allows_public_repositories": true }, { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "inherited": true, "allows_public_repositories": true }, { "id": 3, "name": "expensive-hardware", "visibility": "private", "default": false, "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", "inherited": false, "allows_public_repositories": true } ] }

Create a self-hosted runner group for an organization

Works with GitHub Apps

The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "GitHub's products."

Creates a new self-hosted runner group for an organization.

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

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringObrigatório

The organization name. The name is not case sensitive.

Body parameters
namestringObrigatório

Name of the runner group.

visibilitystring

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.

Padrão: all

Pode ser uma das ações a seguir: selected, all, private

selected_repository_idsarray of integers

List of repository IDs that can access the runner group.

runnersarray of integers

List of runner IDs to add to the runner group.

allows_public_repositoriesboolean

Whether the runner group can be used by public repositories.

Padrão: false

HTTP response status codes

Status codeDescrição
201

Created

Amostras de código

post/orgs/{org}/actions/runner-groups
curl \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/actions/runner-groups \ -d '{"name":"Expensive hardware runners","visibility":"selected","selected_repository_ids":[32,91],"runners":[9,2]}'

Response

Status: 201
{ "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "inherited": false, "allows_public_repositories": true }

Get a self-hosted runner group for an organization

Works with GitHub Apps

Gets a specific self-hosted runner group for an organization. You must authenticate using an access token with the admin:org scope to use this endpoint.

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringObrigatório

The organization name. The name is not case sensitive.

runner_group_idintegerObrigatório

Unique identifier of the self-hosted runner group.

HTTP response status codes

Status codeDescrição
200

OK

Amostras de código

get/orgs/{org}/actions/runner-groups/{runner_group_id}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID

Response

Status: 200
{ "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "inherited": false, "allows_public_repositories": true }

Update a self-hosted runner group for an organization

Works with GitHub Apps

The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products."

Updates the name and visibility of a self-hosted runner group in an organization.

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

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringObrigatório

The organization name. The name is not case sensitive.

runner_group_idintegerObrigatório

Unique identifier of the self-hosted runner group.

Body parameters
namestringObrigatório

Name of the runner group.

visibilitystring

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

Pode ser uma das ações a seguir: selected, all, private

allows_public_repositoriesboolean

Whether the runner group can be used by public repositories.

Padrão: false

HTTP response status codes

Status codeDescrição
200

OK

Amostras de código

patch/orgs/{org}/actions/runner-groups/{runner_group_id}
curl \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID \ -d '{"name":"Expensive hardware runners","visibility":"selected"}'

Response

Status: 200
{ "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "inherited": false, "allows_public_repositories": true }

Delete a self-hosted runner group from an organization

Works with GitHub Apps

Deletes a self-hosted runner group for an organization. You must authenticate using an access token with the admin:org scope to use this endpoint.

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringObrigatório

The organization name. The name is not case sensitive.

runner_group_idintegerObrigatório

Unique identifier of the self-hosted runner group.

HTTP response status codes

Status codeDescrição
204

No Content

Amostras de código

delete/orgs/{org}/actions/runner-groups/{runner_group_id}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID

Response

Status: 204

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

Works with GitHub Apps

Adds a self-hosted runner to a runner group configured in an organization. You must authenticate using an access token with the admin:org scope to use this endpoint.

Parâmetros

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringObrigatório

The organization name. The name is not case sensitive.

runner_group_idintegerObrigatório

Unique identifier of the self-hosted runner group.

runner_idintegerObrigatório

Unique identifier of the self-hosted runner.

HTTP response status codes

Status codeDescrição
204

No Content

Amostras de código

put/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
curl \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID/runners/RUNNER_ID

Response

Status: 204