Skip to main content

GitHub AE est actuellement en version limitée.

Groupes d’exécuteurs auto-hébergés

Utilisez l’API REST pour interagir avec les groupes d’exécuteurs auto-hébergés dans GitHub Actions.

À propos des groupes d’exécuteurs auto-hébergés pour GitHub Actions

Vous pouvez utiliser l’API REST pour gérer des groupes d’exécuteurs auto-hébergés dans GitHub Actions. Pour plus d’informations, consultez « Gestion de l’accès aux exécuteurs auto-hébergés à l’aide de groupes ».

Ces points de terminaison sont disponibles pour les utilisateurs authentifiés, les OAuth apps et les GitHub Apps. Les jetons d’accès nécessitent une étendue repo pour les dépôts privés et une étendue public_repo pour les dépôts internes. GitHub Apps doivent avoir l’autorisation administration pour des dépôts, ou l’autorisation organization_self_hosted_runners pour des organisations. Les utilisateurs authentifiés doivent disposer d’un accès administrateur aux référentiels ou aux organisations, ou à l’étendue manage_runners:enterprise pour que les entreprises puissent utiliser ces points de terminaison.

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.

Paramètres pour « List self-hosted runner groups for an enterprise »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
enterprise string Obligatoire

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

Paramètres de requête
Nom, Type, Description
per_page integer

The number of results per page (max 100).

Default: 30

page integer

Page number of the results to fetch.

Default: 1

visible_to_organization string

Only return runner groups that are allowed to be used by this organization.

Codes d’état de la réponse HTTP pour « List self-hosted runner groups for an enterprise »

Code d’étatDescription
200

OK

Exemples de code pour « List self-hosted runner groups for an enterprise »

get/enterprises/{enterprise}/actions/runner-groups
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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, "restricted_to_workflows": false, "selected_workflows": [], "workflow_restrictions_read_only": 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, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }, { "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, "restricted_to_workflows": false, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false } ] }

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.

Paramètres pour « Create a self-hosted runner group for an enterprise »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
enterprise string Obligatoire

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

Paramètres du corps
Nom, Type, Description
name string Obligatoire

Name of the runner group.

visibility string

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

Peut être: selected, all

selected_organization_ids array of integers

List of organization IDs that can access the runner group.

runners array of integers

List of runner IDs to add to the runner group.

allows_public_repositories boolean

Whether the runner group can be used by public repositories.

Default: false

Codes d’état de la réponse HTTP pour « Create a self-hosted runner group for an enterprise »

Code d’étatDescription
201

Created

Exemples de code pour « Create a self-hosted runner group for an enterprise »

post/enterprises/{enterprise}/actions/runner-groups
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": 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.

Paramètres pour « Get a self-hosted runner group for an enterprise »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
enterprise string Obligatoire

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

runner_group_id integer Obligatoire

Unique identifier of the self-hosted runner group.

Codes d’état de la réponse HTTP pour « Get a self-hosted runner group for an enterprise »

Code d’étatDescription
200

OK

Exemples de code pour « Get a self-hosted runner group for an enterprise »

get/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": 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.

Paramètres pour « Update a self-hosted runner group for an enterprise »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
enterprise string Obligatoire

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

runner_group_id integer Obligatoire

Unique identifier of the self-hosted runner group.

Paramètres du corps
Nom, Type, Description
name string

Name of the runner group.

visibility string

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

Default: all

Peut être: selected, all

allows_public_repositories boolean

Whether the runner group can be used by public repositories.

Default: false

Codes d’état de la réponse HTTP pour « Update a self-hosted runner group for an enterprise »

Code d’étatDescription
200

OK

Exemples de code pour « Update a self-hosted runner group for an enterprise »

patch/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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, "restricted_to_workflows": false, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }

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.

Paramètres pour « Delete a self-hosted runner group from an enterprise »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
enterprise string Obligatoire

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

runner_group_id integer Obligatoire

Unique identifier of the self-hosted runner group.

Codes d’état de la réponse HTTP pour « Delete a self-hosted runner group from an enterprise »

Code d’étatDescription
204

No Content

Exemples de code pour « Delete a self-hosted runner group from an enterprise »

delete/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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.

Paramètres pour « List self-hosted runners in a group for an enterprise »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
enterprise string Obligatoire

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

runner_group_id integer Obligatoire

Unique identifier of the self-hosted runner group.

Paramètres de requête
Nom, Type, Description
per_page integer

The number of results per page (max 100).

Default: 30

page integer

Page number of the results to fetch.

Default: 1

Codes d’état de la réponse HTTP pour « List self-hosted runners in a group for an enterprise »

Code d’étatDescription
200

OK

Exemples de code pour « List self-hosted runners in a group for an enterprise »

get/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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.

Paramètres pour « Set self-hosted runners in a group for an enterprise »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
enterprise string Obligatoire

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

runner_group_id integer Obligatoire

Unique identifier of the self-hosted runner group.

Paramètres du corps
Nom, Type, Description
runners array of integers Obligatoire

List of runner IDs to add to the runner group.

Codes d’état de la réponse HTTP pour « Set self-hosted runners in a group for an enterprise »

Code d’étatDescription
204

No Content

Exemples de code pour « Set self-hosted runners in a group for an enterprise »

put/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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.

Paramètres pour « Add a self-hosted runner to a group for an enterprise »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
enterprise string Obligatoire

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

runner_group_id integer Obligatoire

Unique identifier of the self-hosted runner group.

runner_id integer Obligatoire

Unique identifier of the self-hosted runner.

Codes d’état de la réponse HTTP pour « Add a self-hosted runner to a group for an enterprise »

Code d’étatDescription
204

No Content

Exemples de code pour « Add a self-hosted runner to a group for an enterprise »

put/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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.

Paramètres pour « Remove a self-hosted runner from a group for an enterprise »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
enterprise string Obligatoire

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

runner_group_id integer Obligatoire

Unique identifier of the self-hosted runner group.

runner_id integer Obligatoire

Unique identifier of the self-hosted runner.

Codes d’état de la réponse HTTP pour « Remove a self-hosted runner from a group for an enterprise »

Code d’étatDescription
204

No Content

Exemples de code pour « Remove a self-hosted runner from a group for an enterprise »

delete/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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

Compatible avec 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.

Paramètres pour « List self-hosted runner groups for an organization »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
org string Obligatoire

The organization name. The name is not case sensitive.

Paramètres de requête
Nom, Type, Description
per_page integer

The number of results per page (max 100).

Default: 30

page integer

Page number of the results to fetch.

Default: 1

Codes d’état de la réponse HTTP pour « List self-hosted runner groups for an organization »

Code d’étatDescription
200

OK

Exemples de code pour « List self-hosted runner groups for an organization »

get/orgs/{org}/actions/runner-groups
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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, "restricted_to_workflows": false, "selected_workflows": [], "workflow_restrictions_read_only": false }, { "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, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": 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, "restricted_to_workflows": false, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false } ] }

Create a self-hosted runner group for an organization

Compatible avec GitHub Apps

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.

Paramètres pour « Create a self-hosted runner group for an organization »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
org string Obligatoire

The organization name. The name is not case sensitive.

Paramètres du corps
Nom, Type, Description
name string Obligatoire

Name of the runner group.

visibility string

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

Default: all

Peut être: selected, all, private

selected_repository_ids array of integers

List of repository IDs that can access the runner group.

runners array of integers

List of runner IDs to add to the runner group.

allows_public_repositories boolean

Whether the runner group can be used by public repositories.

Default: false

restricted_to_workflows boolean

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

Default: false

selected_workflows array of strings

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

Codes d’état de la réponse HTTP pour « Create a self-hosted runner group for an organization »

Code d’étatDescription
201

Created

Exemples de code pour « Create a self-hosted runner group for an organization »

post/orgs/{org}/actions/runner-groups
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }

Get a self-hosted runner group for an organization

Compatible avec 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.

Paramètres pour « Get a self-hosted runner group for an organization »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
org string Obligatoire

The organization name. The name is not case sensitive.

runner_group_id integer Obligatoire

Unique identifier of the self-hosted runner group.

Codes d’état de la réponse HTTP pour « Get a self-hosted runner group for an organization »

Code d’étatDescription
200

OK

Exemples de code pour « Get a self-hosted runner group for an organization »

get/orgs/{org}/actions/runner-groups/{runner_group_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }

Update a self-hosted runner group for an organization

Compatible avec GitHub Apps

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.

Paramètres pour « Update a self-hosted runner group for an organization »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
org string Obligatoire

The organization name. The name is not case sensitive.

runner_group_id integer Obligatoire

Unique identifier of the self-hosted runner group.

Paramètres du corps
Nom, Type, Description
name string Obligatoire

Name of the runner group.

visibility string

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

Peut être: selected, all, private

allows_public_repositories boolean

Whether the runner group can be used by public repositories.

Default: false

restricted_to_workflows boolean

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

Default: false

selected_workflows array of strings

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

Codes d’état de la réponse HTTP pour « Update a self-hosted runner group for an organization »

Code d’étatDescription
200

OK

Exemples de code pour « Update a self-hosted runner group for an organization »

patch/orgs/{org}/actions/runner-groups/{runner_group_id}
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }

Delete a self-hosted runner group from an organization

Compatible avec 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.

Paramètres pour « Delete a self-hosted runner group from an organization »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
org string Obligatoire

The organization name. The name is not case sensitive.

runner_group_id integer Obligatoire

Unique identifier of the self-hosted runner group.

Codes d’état de la réponse HTTP pour « Delete a self-hosted runner group from an organization »

Code d’étatDescription
204

No Content

Exemples de code pour « Delete a self-hosted runner group from an organization »

delete/orgs/{org}/actions/runner-groups/{runner_group_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-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

Compatible avec 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.

Paramètres pour « Add a self-hosted runner to a group for an organization »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
org string Obligatoire

The organization name. The name is not case sensitive.

runner_group_id integer Obligatoire

Unique identifier of the self-hosted runner group.

runner_id integer Obligatoire

Unique identifier of the self-hosted runner.

Codes d’état de la réponse HTTP pour « Add a self-hosted runner to a group for an organization »

Code d’étatDescription
204

No Content

Exemples de code pour « Add a self-hosted runner to a group for an organization »

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

Response

Status: 204