Get detailed information of the specified runner group¶

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

Call this endpoint to get detailed information of the specified runner group.

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
`runner_group_id`	path	string	Yes	Runner Group ID
`access_token`	query	string	Yes	User authorization code

Response parameters¶

Field	Type	Always returned	Nullable	Description
`runner_group_id`	string	Yes	—	Runner Group ID
`runner_group_name`	string	Yes	—	Runner group name
`share_all`	boolean	Yes	—	Whether shared with all repositories
`share_all_public_repos`	boolean	Yes	—	Whether shared with all public repositories
`explicit_shared_repo_count`	integer	Yes	—	Number of explicitly shared repositories
`created_at`	integer	Yes	—	Creation time
`updated_at`	integer	Yes	—	Update time

Error responses¶

401 Unauthenticated

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

The error field names returned by the backend take precedence.

HTTP response status codes¶

Status code	Description
`200`	Success (OK)
`401`	Requires authentication
`403`	Forbidden
`404`	Not found

Request example¶

Parameter notes¶

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

cURL¶

curl -X GET 'https://api.atomgit.com/api/v8/orgs/<org>/actions/runner-groups/<runner_group_id>?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/<runner_group_id>?access_token=<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/<runner_group_id>",
    params={"access_token": "<token>"},
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

Response example¶

Status code: 200

{
  "runner_group_id": "string",
  "runner_group_name": "string",
  "share_all": true,
  "share_all_public_repos": true,
  "explicit_shared_repo_count": 0,
  "created_at": 0,
  "updated_at": 0
}

Error codes¶

Error code	Description
`401`	Unauthenticated or invalid credentials (missing or invalid access token)
`403`	Forbidden
`404`	Resource not found
`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