Query all runner groups under the specified organization¶

GET /api/v8/orgs/{org}/actions/runner-groups

Query all runner groups under the specified organization.

Access token support¶

AtomGit user access tokens

Anonymous access¶

This endpoint does not allow anonymous access.

Request parameters¶

Parameter	Location	Type	Required	Description
`org`	path	string	Yes	Organization path
`access_token`	query	string	Yes	User authorization code
`keyword`	query	string	No	Keyword filter
`page`	query	integer	No	Current page number
`per_page`	query	integer	No	Number of items per page

Response parameters¶

Field	Type	Always returned	Nullable	Description
`total_count`	integer	Yes	No	Runner group total
`runner_groups`	object[]	Yes	Yes	Runner group list

`runner_groups` object¶

Field	Type	Always returned	Nullable	Description
`runner_groups.id`	string	Yes	No	Runner Group ID
`runner_groups.name`	string	Yes	No	Name
`runner_groups.runner_group_name`	string	Yes	No	Runner group name
`runner_groups.namespace_id`	string	Yes	No	Namespace ID
`runner_groups.creator`	string	Yes	No	Creator
`runner_groups.create_time`	integer	Yes	No	Creation time
`runner_groups.runner_count`	integer	Yes	No	Runner count
`runner_groups.namespace_type`	string	Yes	No	Namespace type
`runner_groups.share_all`	boolean	Yes	No	Whether shared with all repositories

Error responses¶

400 Invalid parameters

{
  "error": "invalid_request",
  "message": "The org parameter cannot be empty",
  "field": "org"
}

401 Unauthenticated

{
  "error": "unauthorized",
  "message": "Missing or invalid access token"
}

HTTP response status codes¶

Status code	Description
`200`	Success (OK)
`400`	Bad request
`401`	Requires authentication
`403`	Forbidden
`404`	Not found
`500`	Internal server error

Request example¶

Parameter notes¶

<org> is replaced with the organization path name (enterprise, organization, or personal address path); <token> is replaced with your AtomGit user access token.

cURL¶

curl -X GET 'https://api.atomgit.com/api/v8/orgs/<org>/actions/runner-groups?access_token=<token>' \
  -H 'Accept: application/json'

JavaScript¶

// Native fetch (Node.js 18+ / browser)
const response = await fetch("https://api.atomgit.com/api/v8/orgs/<org>/actions/runner-groups?access_token=<YOUR-TOKEN>", {
  headers: {
    "Accept": "application/json",
  },
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v8/orgs/<org>/actions/runner-groups",
    params={"access_token": "<YOUR-TOKEN>"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

Response example¶

Status code: 200

{
  "total_count": 2,
  "runner_groups": [
    {
      "id": "g1",
      "name": "Default",
      "runner_group_name": "Default",
      "namespace_id": "1001",
      "creator": "octocat",
      "create_time": 1600000000,
      "runner_count": 3,
      "namespace_type": "organization",
      "share_all": false
    },
    {
      "id": "g2",
      "name": "Linux Builders",
      "runner_group_name": "Linux Builders",
      "namespace_id": "1001",
      "creator": "octocat",
      "create_time": 1600000100,
      "runner_count": 5,
      "namespace_type": "organization",
      "share_all": true
    }
  ]
}

Error codes¶

Error code	Description
`401`	Unauthenticated or invalid credentials (missing or invalid access token)
`400`	Invalid parameters or the request could not be parsed
`404`	The request path does not exist
`405`	The request method is not supported
`429`	Too many requests; rate limit triggered
`500`	Internal server error

Markdown source: View on AtomGit·Content from the open-source project gitcode-dev/atomgit-api-doc