Create a GitHub-hosted runner for an organization

POST /orgs/{org}/actions/hosted-runners

Copy endpoint

https://api.github.com

Creates a GitHub-hosted runner for an organization. OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.

Parameters

path Path Parameters

Name	Type
`org` required The organization name. The name is not case sensitive.	string

Request Body

application/json required

{
name: string;
image: { id?: string;source?: "github" | "partner" | "custom";version?: string | null; };
size: string;
runner_group_id: number;
maximum_runners?: number;
enable_static_ip?: boolean;
image_gen?: boolean;
}

Responses

201 application/json

Response

interface ActionsHostedRunner {
id: number;
name: string;
runner_group_id?: number;
image_details:

ActionsHostedRunnerPoolImage

Provides details of a hosted runner image

interface ActionsHostedRunnerPoolImage {
id: string;
size_gb: number;
display_name: string;
source: "github" | "partner" | "custom";
version?: string;
}

| null;
machine_size_details:

ActionsHostedRunnerMachineSpec

Provides details of a particular machine spec.

interface ActionsHostedRunnerMachineSpec {
id: string;
cpu_cores: number;
memory_gb: number;
storage_gb: number;
}

;
status: "Ready" | "Provisioning" | "Shutdown" | "Deleting" | "Stuck";
platform: string;
maximum_runners?: number;
public_ip_enabled: boolean;
public_ips?:

PublicIp

Provides details of Public IP for a GitHub-hosted larger runners

interface PublicIp {
enabled?: boolean;
prefix?: string;
length?: number;
}

[];
last_active_on?: string | null;
image_gen?: boolean;
}