GitHub: Actions schemas

← Actions operations · All schemas

Create a remove token for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root	Authentication Token
expires_at	string	Required within parent	The time this token expires Format: date-time
permissions	object	Optional
repositories	array	Optional	The repositories this token has access to
repositories[]	Model	Each item	Expand List repositories for the authenticated user — response body — item
repository_selection	string	Optional	Describe whether all repositories have been selected or there's a selection involved Known values: all, selected
single_file	JSON	Optional
single_file (anyOf 1)	string	Alternative
single_file (anyOf 2)	null	Alternative
token	string	Required within parent	The token used for authentication

Referenced models: List repositories for the authenticated user — response body — item

Create a repository Actions policy — request body — body conditions

Field	Type	Presence	Description and constraints
$	object	Root	Conditions for a repository Actions policy. The object may be empty to preserve or use the default workflow targeting, or contain only `workflow_path`.
$ (oneOf 1)	object	Alternative	Maximum fields: 0
$ (oneOf 2)	JSON	Alternative	Maximum fields: 1
$ (oneOf 2) (allOf 1)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition

Referenced models: Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition

Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition

Field	Type	Presence	Description and constraints
$	object	Root	Parameters for an Actions policy workflow path condition. Omitting `workflow_path` when creating a policy targets all workflows without storing an explicit condition. Omitting it when updating a policy preserves the existing workflow targeting. For new or changed workflow conditions, the API requires at least one included or excluded pattern. This is validated server-side rather than by this schema, which can also describe existing stored conditions.
workflow_path	object	Optional
workflow_path.exclude	array	Required within parent	Array of workflow file paths or glob patterns to exclude. The condition will not pass if any of these patterns match. `~ALL` is not allowed in this array.
workflow_path.exclude[]	string	Each item
workflow_path.include	array	Required within parent	Array of workflow file paths or glob patterns to include. An empty array includes all workflows not matched by an excluded pattern. Use `~ALL` by itself to include all workflows. `~ALL` cannot be combined with other included patterns.
workflow_path.include[]	string	Each item

Create a repository Actions policy — request body — body rules item

Field	Type	Presence	Description and constraints
$	object	Root	An actions rule.
$ (oneOf 1)	Model	Alternative	Expand Create a repository Actions policy — request body — body rules item restrict actions actors
$ (oneOf 2)	Model	Alternative	Expand Create a repository Actions policy — request body — body rules item restrict action events

Referenced models: Create a repository Actions policy — request body — body rules item restrict action events, Create a repository Actions policy — request body — body rules item restrict actions actors

Create a repository Actions policy — request body — body rules item restrict action events

Field	Type	Presence	Description and constraints
$	object	Root	Choose specific GitHub events that will trigger Actions workflows.
parameters	object	Optional
parameters.allowed_events	array	Required within parent	Select the events that can trigger Actions workflows.
parameters.allowed_events[]	string	Each item	One of: branch_protection_rule, check_run, check_suite, create, delete, deployment, deployment_status, discussion, discussion_comment, fork, gollum, image_version, issue_comment, issues, label, merge_group, milestone, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, pull_request_target, push, registry_package, release, repository_dispatch, schedule, status, watch, workflow_call, workflow_dispatch, workflow_run
type	string	Required within parent	One of: restrict_action_events

Create a repository Actions policy — request body — body rules item restrict actions actors

Field	Type	Presence	Description and constraints
$	object	Root	Choose specific actors that are authorized to trigger Actions workflows.
parameters	object	Optional
parameters.allowed_actors	array	Required within parent	Select the actors who can run Actions workflows.
parameters.allowed_actors[]	Model	Each item	Expand Create a repository Actions policy — request body — body rules item restrict actions actors parameters allowed actors item
type	string	Required within parent	One of: restrict_actions_actors

Referenced models: Create a repository Actions policy — request body — body rules item restrict actions actors parameters allowed actors item

Create a repository Actions policy — request body — body rules item restrict actions actors parameters allowed actors item

Field	Type	Presence	Description and constraints
$	object	Root	An actor authorized to trigger Actions workflows
id	integer	Required within parent	ID of the actor authorized to trigger Actions workflows.
type	string	Required within parent	The type of the actor One of: User, Bot, Team, BusinessTeam, EnterpriseTeam, IntegrationInstallation, App, RepositoryRole

Create a workflow dispatch event — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response containing the workflow run ID and URLs.
html_url	string	Required within parent	Format: uri
run_url	string	Required within parent	The URL to the workflow run. Format: uri
workflow_run_id	Model	Required within parent	Expand Create a workflow dispatch event — response body — workflow run id

Referenced models: Create a workflow dispatch event — response body — workflow run id

Create a workflow dispatch event — response body — workflow run id

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	integer	Alternative	The ID of the workflow run. Format: int64
$ (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create an organization Actions policy — request body — body conditions

Field	Type	Presence	Description and constraints
$	object	Root	Conditions for an organization Actions policy. The conditions object should contain one of `repository_name`, `repository_id`, or `repository_property`, and may also contain `workflow_path`.
$ (oneOf 1)	JSON	Alternative
$ (oneOf 1) (allOf 1)	Model	All variants apply	Expand Create an organization Actions policy — request body — body conditions repository name, workflow path Repository ruleset conditions for repository names
$ (oneOf 1) (allOf 2)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition
$ (oneOf 2)	JSON	Alternative
$ (oneOf 2) (allOf 1)	Model	All variants apply	Expand Create an organization Actions policy — request body — body conditions repository id, workflow path Repository ruleset conditions for repository I Ds
$ (oneOf 2) (allOf 2)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition
$ (oneOf 3)	JSON	Alternative
$ (oneOf 3) (allOf 1)	Model	All variants apply	Expand Create an organization Actions policy — request body — body conditions repository property, workflow path Repository ruleset conditions for repository properties
$ (oneOf 3) (allOf 2)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition

Referenced models: Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition, Create an organization Actions policy — request body — body conditions repository name, workflow path Repository ruleset conditions for repository names, Create an organization Actions policy — request body — body conditions repository id, workflow path Repository ruleset conditions for repository I Ds, Create an organization Actions policy — request body — body conditions repository property, workflow path Repository ruleset conditions for repository properties

Create an organization Actions policy — request body — body conditions repository id, workflow path Repository ruleset conditions for repository I Ds

Field	Type	Presence	Description and constraints
$	object	Root	Parameters for a repository ID condition
repository_id	object	Required within parent
repository_id.repository_ids	array	Optional	The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.
repository_id.repository_ids[]	integer	Each item

Create an organization Actions policy — request body — body conditions repository name, workflow path Repository ruleset conditions for repository names

Field	Type	Presence	Description and constraints
$	object	Root	Parameters for a repository name condition
repository_name	object	Required within parent
repository_name.exclude	array	Optional	Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
repository_name.exclude[]	string	Each item
repository_name.include	array	Optional	Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
repository_name.include[]	string	Each item
repository_name.protected	boolean	Optional	Whether renaming of target repositories is prevented.

Create an organization Actions policy — request body — body conditions repository property, workflow path Repository ruleset conditions for repository properties

Field	Type	Presence	Description and constraints
$	object	Root	Parameters for a repository property condition
repository_property	object	Required within parent
repository_property.exclude	array	Optional	The repository properties and values to exclude. The condition will not pass if any of these properties match.
repository_property.exclude[]	Model	Each item	Expand Create an organization Actions policy — request body — body conditions repository property, workflow path Repository ruleset conditions for repository properties repository property exclude item
repository_property.include	array	Optional	The repository properties and values to include. All of these properties must match for the condition to pass.
repository_property.include[]	Model	Each item	Expand Create an organization Actions policy — request body — body conditions repository property, workflow path Repository ruleset conditions for repository properties repository property exclude item

Referenced models: Create an organization Actions policy — request body — body conditions repository property, workflow path Repository ruleset conditions for repository properties repository property exclude item

Create an organization Actions policy — request body — body conditions repository property, workflow path Repository ruleset conditions for repository properties repository property exclude item

Field	Type	Presence	Description and constraints
$	object	Root	Parameters for a targeting a repository property
name	string	Required within parent	The name of the repository property to target
property_values	array	Required within parent	The values to match for the repository property
property_values[]	string	Each item
source	string	Optional	The source of the repository property. Defaults to 'custom' if not specified. One of: custom, system

Create configuration for a just-in-time runner for a repository — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
labels	array	Required within parent	The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. Maximum items: 100 Minimum items: 1
labels[]	string	Each item
name	string	Required within parent	The name of the new runner.
runner_group_id	integer	Required within parent	The ID of the runner group to register the runner to.
work_folder	string	Optional	The working directory to be used for job execution, relative to the runner install directory. Default: _work

Get Git Hub Actions cache retention limit for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions cache retention policy for a repository.
max_cache_retention_days	JSON	Optional
max_cache_retention_days (anyOf 1)	integer	Alternative	The maximum number of days to keep caches in this repository.
max_cache_retention_days (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Git Hub Actions cache retention limit for an enterprise — response body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions cache retention policy for an enterprise.
max_cache_retention_days	JSON	Optional
max_cache_retention_days (anyOf 1)	integer	Alternative	For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.
max_cache_retention_days (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Git Hub Actions cache retention limit for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions cache retention policy for an organization.
max_cache_retention_days	JSON	Optional
max_cache_retention_days (anyOf 1)	integer	Alternative	For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.
max_cache_retention_days (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Git Hub Actions cache storage limit for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions cache storage policy for a repository.
max_cache_size_gb	JSON	Optional
max_cache_size_gb (anyOf 1)	integer	Alternative	The maximum total cache size for this repository, in gigabytes.
max_cache_size_gb (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Git Hub Actions cache storage limit for an enterprise — response body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions cache storage policy for an enterprise.
max_cache_size_gb	JSON	Optional
max_cache_size_gb (anyOf 1)	integer	Alternative	For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.
max_cache_size_gb (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Git Hub Actions cache storage limit for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions cache storage policy for an organization.
max_cache_size_gb	JSON	Optional
max_cache_size_gb (anyOf 1)	integer	Alternative	For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.
max_cache_size_gb (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Git Hub Actions cache usage for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions Cache Usage by repository.
active_caches_count	JSON	Required within parent
active_caches_count (anyOf 1)	integer	Alternative	The number of active caches in the repository.
active_caches_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
active_caches_size_in_bytes	JSON	Required within parent
active_caches_size_in_bytes (anyOf 1)	integer	Alternative	The sum of the size in bytes of all the active cache items in the repository.
active_caches_size_in_bytes (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
full_name	string	Required within parent	The repository owner and name for the cache usage being shown.

Get Git Hub Actions cache usage for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root
total_active_caches_count	JSON	Required within parent
total_active_caches_count (anyOf 1)	integer	Alternative	The count of active caches across all repositories of an enterprise or an organization.
total_active_caches_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_active_caches_size_in_bytes	JSON	Required within parent
total_active_caches_size_in_bytes (anyOf 1)	integer	Alternative	The total size in bytes of all active cache items across all repositories of an enterprise or an organization.
total_active_caches_size_in_bytes (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Git Hub Actions permissions for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root
allowed_actions	string	Optional	The permissions policy that controls the actions and reusable workflows that are allowed to run. Known values: all, local_only, selected
enabled	boolean	Required within parent	Whether GitHub Actions is enabled on the repository.
selected_actions_url	string	Optional	The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`.
sha_pinning_required	boolean	Optional	Whether actions must be pinned to a full-length commit SHA.

Get Git Hub Actions permissions for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root
allowed_actions	string	Optional	The permissions policy that controls the actions and reusable workflows that are allowed to run. Known values: all, local_only, selected
enabled_repositories	string	Required within parent	The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Known values: all, none, selected
selected_actions_url	string	Optional	The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`.
selected_repositories_url	string	Optional	The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`.
sha_pinning_required	boolean	Optional	Whether actions must be pinned to a full-length commit SHA.

Get a Git Hub-hosted runner for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root	A Github-hosted hosted runner.
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The unique identifier of the hosted runner.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
image_details	Model	Required within parent	Expand Get a Git Hub-hosted runner for an organization — response body — image details
image_gen	boolean	Optional	Whether custom image generation is enabled for the hosted runners.
last_active_on	JSON	Optional
last_active_on (anyOf 1)	string	Alternative	The time at which the runner was last used, in ISO 8601 format. Format: date-time
last_active_on (anyOf 2)	null	Alternative
machine_size_details	Model	Required within parent	Expand Get a Git Hub-hosted runner for an organization — response body — machine size details
maximum_runners	JSON	Optional
maximum_runners (anyOf 1)	integer	Alternative	The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. Default: 10
maximum_runners (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	The name of the hosted runner.
platform	string	Required within parent	The operating system of the image.
public_ip_enabled	boolean	Required within parent	Whether public IP is enabled for the hosted runners.
public_ips	array	Optional	The public IP ranges when public IP is enabled for the hosted runners.
public_ips[]	Model	Each item	Expand Get a Git Hub-hosted runner for an organization — response body — public ips item
runner_group_id	JSON	Optional
runner_group_id (anyOf 1)	integer	Alternative	The unique identifier of the group that the hosted runner belongs to.
runner_group_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
status	string	Required within parent	The status of the runner. Known values: Ready, Provisioning, Shutdown, Deleting, Stuck

Referenced models: Get a Git Hub-hosted runner for an organization — response body — machine size details, Get a Git Hub-hosted runner for an organization — response body — image details, Get a Git Hub-hosted runner for an organization — response body — public ips item

Get a Git Hub-hosted runner for an organization — response body — image details

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Provides details of a hosted runner image
$ (anyOf 1).display_name	string	Required within parent	Display name for this image.
$ (anyOf 1).id	string	Required within parent	The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.
$ (anyOf 1).size_gb	JSON	Required within parent
$ (anyOf 1).size_gb (anyOf 1)	integer	Alternative	Image size in GB.
$ (anyOf 1).size_gb (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).source	string	Required within parent	The image provider. Known values: github, partner, custom
$ (anyOf 1).version	string	Optional	The image version of the hosted runner pool.
$ (anyOf 2)	null	Alternative

Get a Git Hub-hosted runner for an organization — response body — machine size details

Field	Type	Presence	Description and constraints
$	object	Root	Provides details of a particular machine spec.
cpu_cores	JSON	Required within parent
cpu_cores (anyOf 1)	integer	Alternative	The number of cores.
cpu_cores (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	The ID used for the `size` parameter when creating a new runner.
memory_gb	JSON	Required within parent
memory_gb (anyOf 1)	integer	Alternative	The available RAM for the machine spec.
memory_gb (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
storage_gb	JSON	Required within parent
storage_gb (anyOf 1)	integer	Alternative	The available SSD storage for the machine spec.
storage_gb (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a Git Hub-hosted runner for an organization — response body — public ips item

Field	Type	Presence	Description and constraints
$	object	Root	Provides details of Public IP for a GitHub-hosted larger runners
enabled	boolean	Optional	Whether public IP is enabled.
length	JSON	Optional
length (anyOf 1)	integer	Alternative	The length of the IP prefix.
length (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
prefix	string	Optional	The prefix for the public IP.

Get a concurrency group for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root	A concurrency group with the workflow runs and jobs that are either currently holding or waiting for the concurrency group lease.
group_members	array	Required within parent
group_members[]	object	Each item
group_members[].job_html_url	JSON	Optional
group_members[].job_html_url (anyOf 1)	string	Alternative	Web URL for the job. Format: uri
group_members[].job_html_url (anyOf 2)	null	Alternative
group_members[].job_id	JSON	Optional
group_members[].job_id (anyOf 1)	integer	Alternative	The ID of the job, when the item represents a job-level or reusable-workflow-level lease.
group_members[].job_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
group_members[].job_name	string	Optional	The display name of the job, when the item represents a job-level or reusable-workflow-level lease.
group_members[].job_url	JSON	Optional
group_members[].job_url (anyOf 1)	string	Alternative	API URL for the job. Format: uri
group_members[].job_url (anyOf 2)	null	Alternative
group_members[].run_html_url	JSON	Required within parent
group_members[].run_html_url (anyOf 1)	string	Alternative	Web URL for the workflow run. Format: uri
group_members[].run_html_url (anyOf 2)	null	Alternative
group_members[].run_id	JSON	Required within parent
group_members[].run_id (anyOf 1)	integer	Alternative	The ID of the workflow run.
group_members[].run_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
group_members[].run_name	string	Required within parent	The name of the workflow run.
group_members[].run_url	JSON	Required within parent
group_members[].run_url (anyOf 1)	string	Alternative	API URL for the workflow run. Format: uri
group_members[].run_url (anyOf 2)	null	Alternative
group_members[].status	string	Required within parent	Known values: in_progress, pending
group_name	string	Required within parent	The name of the concurrency group.
group_url	string	Required within parent	API URL for this concurrency group. Format: uri
total_count	JSON	Required within parent
total_count (anyOf 1)	integer	Alternative
total_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a custom image definition for Git Hub Actions Hosted Runners — response body

Field	Type	Presence	Description and constraints
$	object	Root	Provides details of a custom runner image
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
latest_version	string	Required within parent	The latest image version associated with the image.
name	string	Required within parent	Display name for this image.
platform	string	Required within parent	The operating system of the image.
source	string	Required within parent	The image provider.
state	string	Required within parent	The number of image versions associated with the image.
total_versions_size	JSON	Required within parent
total_versions_size (anyOf 1)	integer	Alternative	Total size of all the image versions in GB.
total_versions_size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
versions_count	JSON	Required within parent
versions_count (anyOf 1)	integer	Alternative	The number of image versions associated with the image.
versions_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a job for a workflow run — response body

Field	Type	Presence	Description and constraints
$	object	Root	Information of a job execution in a workflow run
check_run_url	string	Required within parent
completed_at	JSON	Required within parent
completed_at (anyOf 1)	string	Alternative	The time that the job finished, in ISO 8601 format. Format: date-time
completed_at (anyOf 2)	null	Alternative
conclusion	JSON	Required within parent
conclusion (anyOf 1)	string	Alternative	The outcome of the job. Known values: success, failure, neutral, cancelled, skipped, timed_out, action_required
conclusion (anyOf 2)	null	Alternative
created_at	string	Required within parent	The time that the job created, in ISO 8601 format. Format: date-time
head_branch	JSON	Required within parent
head_branch (anyOf 1)	string	Alternative	The name of the current branch.
head_branch (anyOf 2)	null	Alternative
head_sha	string	Required within parent	The SHA of the commit that is being run.
html_url	JSON	Required within parent
html_url (anyOf 1)	string	Alternative
html_url (anyOf 2)	null	Alternative
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The id of the job. Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
labels	array	Required within parent	Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file.
labels[]	string	Each item
name	string	Required within parent	The name of the job.
node_id	string	Required within parent
run_attempt	JSON	Optional
run_attempt (anyOf 1)	integer	Alternative	Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.
run_attempt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
run_id	JSON	Required within parent
run_id (anyOf 1)	integer	Alternative	The id of the associated workflow run. Format: int64
run_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
run_url	string	Required within parent
runner_group_id	JSON	Required within parent
runner_group_id (anyOf 1)	JSON	Alternative
runner_group_id (anyOf 1) (anyOf 1)	integer	Alternative	The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
runner_group_id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
runner_group_id (anyOf 2)	null	Alternative
runner_group_name	JSON	Required within parent
runner_group_name (anyOf 1)	string	Alternative	The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
runner_group_name (anyOf 2)	null	Alternative
runner_id	JSON	Required within parent
runner_id (anyOf 1)	JSON	Alternative
runner_id (anyOf 1) (anyOf 1)	integer	Alternative	The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
runner_id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
runner_id (anyOf 2)	null	Alternative
runner_name	JSON	Required within parent
runner_name (anyOf 1)	string	Alternative	The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
runner_name (anyOf 2)	null	Alternative
started_at	string	Required within parent	The time that the job started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The phase of the lifecycle that the job is currently in. Known values: queued, in_progress, completed, waiting, requested, pending
steps	array	Optional	Steps in this job.
steps[]	object	Each item
steps[].completed_at	JSON	Optional
steps[].completed_at (anyOf 1)	string	Alternative	The time that the job finished, in ISO 8601 format. Format: date-time
steps[].completed_at (anyOf 2)	null	Alternative
steps[].conclusion	JSON	Required within parent
steps[].conclusion (anyOf 1)	string	Alternative	The outcome of the job.
steps[].conclusion (anyOf 2)	null	Alternative
steps[].name	string	Required within parent	The name of the job.
steps[].number	JSON	Required within parent
steps[].number (anyOf 1)	integer	Alternative
steps[].number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
steps[].started_at	JSON	Optional
steps[].started_at (anyOf 1)	string	Alternative	The time that the step started, in ISO 8601 format. Format: date-time
steps[].started_at (anyOf 2)	null	Alternative
steps[].status	string	Required within parent	The phase of the lifecycle that the job is currently in. Known values: queued, in_progress, completed
url	string	Required within parent
workflow_name	JSON	Required within parent
workflow_name (anyOf 1)	string	Alternative	The name of the workflow.
workflow_name (anyOf 2)	null	Alternative

Get a repository Actions policy — response body

Field	Type	Presence	Description and constraints
$	object	Root	An Actions policy defines rules for workflow execution protection.
_links	object	Optional
_links.html	object	Optional
_links.html.href	string	Optional	The html URL of the policy
_links.self	object	Optional
_links.self.href	string	Optional	The URL of the policy
conditions	JSON	Optional
conditions (anyOf 1)	JSON	Alternative	When workflow path targeting is available, detailed responses represent an omitted stored workflow condition as `workflow_path` with `include` set to `["~ALL"]` and `exclude` set to `[]`. When workflow path targeting is unavailable, an omitted stored condition remains omitted.
conditions (anyOf 1) (anyOf 1)	Model	Alternative	Expand Get a repository Actions policy — response body — conditions value Repository Actions policy conditions
conditions (anyOf 1) (anyOf 2)	Model	Alternative	Expand Get a repository Actions policy — response body — conditions value Organization Actions policy conditions
conditions (anyOf 1) (anyOf 3)	Model	Alternative	Expand Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions
conditions (anyOf 2)	null	Alternative
created_at	string	Optional	Format: date-time
enforcement	string	Required within parent	The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). Known values: disabled, active, evaluate
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The ID of the policy
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	The name of the policy
node_id	string	Optional
rules	array	Optional	An array of rules within the policy
rules[]	Model	Each item	Expand Get a repository Actions policy — response body — rules item
source	string	Required within parent	The name of the source
source_type	string	Required within parent	The type of the source of the policy Known values: Repository, Organization, Enterprise
target	string	Required within parent	The target of the policy Known values: actions
updated_at	string	Optional	Format: date-time

Referenced models: Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions, Get a repository Actions policy — response body — conditions value Organization Actions policy conditions, Get a repository Actions policy — response body — conditions value Repository Actions policy conditions, Get a repository Actions policy — response body — rules item

Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions

Field	Type	Presence	Description and constraints
$	object	Root	Conditions for an enterprise Actions policy. The conditions object supports one organization target (`organization_name`, `organization_id`, or `organization_property`) combined with one repository target (`repository_name` or `repository_property`), and may also contain `workflow_path`.
$ (anyOf 1)	object	Alternative	Conditions to target organizations by name and repositories by name
$ (anyOf 1) (allOf 1)	Model	All variants apply	Expand Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization name, repository name, workflow path Repository ruleset conditions for organization names
$ (anyOf 1) (allOf 2)	Model	All variants apply	Expand Create an organization Actions policy — request body — body conditions repository name, workflow path Repository ruleset conditions for repository names
$ (anyOf 1) (allOf 3)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition
$ (anyOf 2)	object	Alternative	Conditions to target organizations by name and repositories by property
$ (anyOf 2) (allOf 1)	Model	All variants apply	Expand Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization name, repository name, workflow path Repository ruleset conditions for organization names
$ (anyOf 2) (allOf 2)	Model	All variants apply	Expand Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository property, workflow path Repository ruleset conditions for repository properties
$ (anyOf 2) (allOf 3)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition
$ (anyOf 3)	object	Alternative	Conditions to target organizations by id and repositories by name
$ (anyOf 3) (allOf 1)	Model	All variants apply	Expand Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization id, repository name, workflow path Repository ruleset conditions for organization I Ds
$ (anyOf 3) (allOf 2)	Model	All variants apply	Expand Create an organization Actions policy — request body — body conditions repository name, workflow path Repository ruleset conditions for repository names
$ (anyOf 3) (allOf 3)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition
$ (anyOf 4)	object	Alternative	Conditions to target organizations by id and repositories by property
$ (anyOf 4) (allOf 1)	Model	All variants apply	Expand Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization id, repository name, workflow path Repository ruleset conditions for organization I Ds
$ (anyOf 4) (allOf 2)	Model	All variants apply	Expand Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository property, workflow path Repository ruleset conditions for repository properties
$ (anyOf 4) (allOf 3)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition
$ (anyOf 5)	object	Alternative	Conditions to target organizations by property and repositories by name
$ (anyOf 5) (allOf 1)	Model	All variants apply	Expand Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization property, repository name, workflow path Repository ruleset conditions for organization properties
$ (anyOf 5) (allOf 2)	Model	All variants apply	Expand Create an organization Actions policy — request body — body conditions repository name, workflow path Repository ruleset conditions for repository names
$ (anyOf 5) (allOf 3)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition
$ (anyOf 6)	object	Alternative	Conditions to target organizations by property and repositories by property
$ (anyOf 6) (allOf 1)	Model	All variants apply	Expand Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization property, repository name, workflow path Repository ruleset conditions for organization properties
$ (anyOf 6) (allOf 2)	Model	All variants apply	Expand Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository property, workflow path Repository ruleset conditions for repository properties
$ (anyOf 6) (allOf 3)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition

Referenced models: Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition, Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization id, repository name, workflow path Repository ruleset conditions for organization I Ds, Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization name, repository name, workflow path Repository ruleset conditions for organization names, Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization property, repository name, workflow path Repository ruleset conditions for organization properties, Create an organization Actions policy — request body — body conditions repository name, workflow path Repository ruleset conditions for repository names, Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository property, workflow path Repository ruleset conditions for repository properties

Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization id, repository name, workflow path Repository ruleset conditions for organization I Ds

Field	Type	Presence	Description and constraints
$	object	Root	Parameters for an organization ID condition
organization_id	object	Required within parent
organization_id.organization_ids	array	Optional	The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.
organization_id.organization_ids[]	JSON	Each item
organization_id.organization_ids[] (anyOf 1)	integer	Alternative
organization_id.organization_ids[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization name, repository name, workflow path Repository ruleset conditions for organization names

Field	Type	Presence	Description and constraints
$	object	Root	Parameters for an organization name condition
organization_name	object	Required within parent
organization_name.exclude	array	Optional	Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.
organization_name.exclude[]	string	Each item
organization_name.include	array	Optional	Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.
organization_name.include[]	string	Each item

Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization property, repository name, workflow path Repository ruleset conditions for organization properties

Field	Type	Presence	Description and constraints
$	object	Root	Parameters for a organization property condition
organization_property	object	Required within parent
organization_property.exclude	array	Optional	The organization properties and values to exclude. The condition will not pass if any of these properties match.
organization_property.exclude[]	Model	Each item	Expand Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization property, repository name, workflow path Repository ruleset conditions for organization properties organization property exclude item
organization_property.include	array	Optional	The organization properties and values to include. All of these properties must match for the condition to pass.
organization_property.include[]	Model	Each item	Expand Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization property, repository name, workflow path Repository ruleset conditions for organization properties organization property exclude item

Referenced models: Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization property, repository name, workflow path Repository ruleset conditions for organization properties organization property exclude item

Get a repository Actions policy — response body — conditions value Enterprise Actions policy conditions organization property, repository name, workflow path Repository ruleset conditions for organization properties organization property exclude item

Field	Type	Presence	Description and constraints
$	object	Root	Parameters for a targeting a organization property
name	string	Required within parent	The name of the organization property to target
property_values	array	Required within parent	The values to match for the organization property
property_values[]	string	Each item

Get a repository Actions policy — response body — conditions value Organization Actions policy conditions

Field	Type	Presence	Description and constraints
$	object	Root	Conditions for an organization Actions policy. The conditions object should contain one of `repository_name`, `repository_id`, or `repository_property`, and may also contain `workflow_path`.
$ (anyOf 1)	JSON	Alternative
$ (anyOf 1) (allOf 1)	Model	All variants apply	Expand Create an organization Actions policy — request body — body conditions repository name, workflow path Repository ruleset conditions for repository names
$ (anyOf 1) (allOf 2)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition
$ (anyOf 2)	JSON	Alternative
$ (anyOf 2) (allOf 1)	Model	All variants apply	Expand Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository id, workflow path Repository ruleset conditions for repository I Ds
$ (anyOf 2) (allOf 2)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition
$ (anyOf 3)	JSON	Alternative
$ (anyOf 3) (allOf 1)	Model	All variants apply	Expand Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository property, workflow path Repository ruleset conditions for repository properties
$ (anyOf 3) (allOf 2)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition

Referenced models: Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition, Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository id, workflow path Repository ruleset conditions for repository I Ds, Create an organization Actions policy — request body — body conditions repository name, workflow path Repository ruleset conditions for repository names, Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository property, workflow path Repository ruleset conditions for repository properties

Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository id, workflow path Repository ruleset conditions for repository I Ds

Field	Type	Presence	Description and constraints
$	object	Root	Parameters for a repository ID condition
repository_id	object	Required within parent
repository_id.repository_ids	array	Optional	The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.
repository_id.repository_ids[]	JSON	Each item
repository_id.repository_ids[] (anyOf 1)	integer	Alternative
repository_id.repository_ids[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository property, workflow path Repository ruleset conditions for repository properties

Field	Type	Presence	Description and constraints
$	object	Root	Parameters for a repository property condition
repository_property	object	Required within parent
repository_property.exclude	array	Optional	The repository properties and values to exclude. The condition will not pass if any of these properties match.
repository_property.exclude[]	Model	Each item	Expand Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository property, workflow path Repository ruleset conditions for repository properties repository property exclude item
repository_property.include	array	Optional	The repository properties and values to include. All of these properties must match for the condition to pass.
repository_property.include[]	Model	Each item	Expand Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository property, workflow path Repository ruleset conditions for repository properties repository property exclude item

Referenced models: Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository property, workflow path Repository ruleset conditions for repository properties repository property exclude item

Get a repository Actions policy — response body — conditions value Organization Actions policy conditions repository property, workflow path Repository ruleset conditions for repository properties repository property exclude item

Field	Type	Presence	Description and constraints
$	object	Root	Parameters for a targeting a repository property
name	string	Required within parent	The name of the repository property to target
property_values	array	Required within parent	The values to match for the repository property
property_values[]	string	Each item
source	string	Optional	The source of the repository property. Defaults to 'custom' if not specified. Known values: custom, system

Get a repository Actions policy — response body — conditions value Repository Actions policy conditions

Field	Type	Presence	Description and constraints
$	object	Root	Conditions for a repository Actions policy. The object may be empty to preserve or use the default workflow targeting, or contain only `workflow_path`.
$ (anyOf 1)	object	Alternative	Maximum fields: 0
$ (anyOf 2)	JSON	Alternative	Maximum fields: 1
$ (anyOf 2) (allOf 1)	Model	All variants apply	Expand Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition

Referenced models: Create a repository Actions policy — request body — body conditions workflow path Actions policy workflow path condition

Get a repository Actions policy — response body — rules item

Field	Type	Presence	Description and constraints
$	object	Root	An actions rule.
$ (anyOf 1)	Model	Alternative	Expand Get a repository Actions policy — response body — rules item restrict actions actors
$ (anyOf 2)	Model	Alternative	Expand Get a repository Actions policy — response body — rules item restrict action events

Referenced models: Get a repository Actions policy — response body — rules item restrict action events, Get a repository Actions policy — response body — rules item restrict actions actors

Get a repository Actions policy — response body — rules item restrict action events

Field	Type	Presence	Description and constraints
$	object	Root	Choose specific GitHub events that will trigger Actions workflows.
parameters	object	Optional
parameters.allowed_events	array	Required within parent	Select the events that can trigger Actions workflows.
parameters.allowed_events[]	string	Each item	Known values: branch_protection_rule, check_run, check_suite, create, delete, deployment, deployment_status, discussion, discussion_comment, fork, gollum, image_version, issue_comment, issues, label, merge_group, milestone, page_build, project, project_card, project_column, public, pull_request, pull_request_review, pull_request_review_comment, pull_request_target, push, registry_package, release, repository_dispatch, schedule, status, watch, workflow_call, workflow_dispatch, workflow_run
type	string	Required within parent	Known values: restrict_action_events

Get a repository Actions policy — response body — rules item restrict actions actors

Field	Type	Presence	Description and constraints
$	object	Root	Choose specific actors that are authorized to trigger Actions workflows.
parameters	object	Optional
parameters.allowed_actors	array	Required within parent	Select the actors who can run Actions workflows.
parameters.allowed_actors[]	Model	Each item	Expand Get a repository Actions policy — response body — rules item restrict actions actors parameters allowed actors item
type	string	Required within parent	Known values: restrict_actions_actors

Referenced models: Get a repository Actions policy — response body — rules item restrict actions actors parameters allowed actors item

Get a repository Actions policy — response body — rules item restrict actions actors parameters allowed actors item

Field	Type	Presence	Description and constraints
$	object	Root	An actor authorized to trigger Actions workflows
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	ID of the actor authorized to trigger Actions workflows.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	The type of the actor Known values: User, Bot, Team, BusinessTeam, EnterpriseTeam, IntegrationInstallation, App, RepositoryRole

Get a self-hosted runner for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root	A self hosted runner
busy	boolean	Required within parent
ephemeral	boolean	Optional
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The ID of the runner.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
labels	array	Required within parent
labels[]	Model	Each item	Expand Get a self-hosted runner for a repository — response body — labels item
name	string	Required within parent	The name of the runner.
os	string	Required within parent	The Operating System of the runner.
runner_group_id	JSON	Optional
runner_group_id (anyOf 1)	integer	Alternative	The ID of the runner group.
runner_group_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
status	string	Required within parent	The status of the runner.
version	JSON	Optional
version (anyOf 1)	string	Alternative	The version of the GitHub Actions Runner software. This is only set if the runner has connected to the service at least once.
version (anyOf 2)	null	Alternative

Referenced models: Get a self-hosted runner for a repository — response body — labels item

Get a self-hosted runner for a repository — response body — labels item

Field	Type	Presence	Description and constraints
$	object	Root	A label for a self hosted runner
id	JSON	Optional
id (anyOf 1)	integer	Alternative	Unique identifier of the label.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	Name of the label.
type	string	Optional	The type of label. Read-only labels are applied automatically when the runner is configured. Known values: read-only, custom

Get a self-hosted runner group for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root
allows_public_repositories	boolean	Required within parent
default	boolean	Required within parent
hosted_runners_url	string	Optional
id	JSON	Required within parent
id (anyOf 1)	number	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
inherited	boolean	Required within parent
inherited_allows_public_repositories	boolean	Optional
name	string	Required within parent
network_configuration_id	string	Optional	The identifier of a hosted compute network configuration.
restricted_to_workflows	boolean	Optional	If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. Default: false
runners_url	string	Required within parent
selected_repositories_url	string	Optional	Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`
selected_workflows	array	Optional	List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.
selected_workflows[]	string	Each item	Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
visibility	string	Required within parent
workflow_restrictions_read_only	boolean	Optional	If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. Default: false

Get a workflow run — response body

Field	Type	Presence	Description and constraints
$	object	Root	An invocation of a workflow
actor	Model	Optional	Expand List users — response body — item
artifacts_url	string	Required within parent	The URL to the artifacts for the workflow run.
cancel_url	string	Required within parent	The URL to cancel the workflow run.
check_suite_id	JSON	Optional
check_suite_id (anyOf 1)	integer	Alternative	The ID of the associated check suite. Format: int64
check_suite_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
check_suite_node_id	string	Optional	The node ID of the associated check suite.
check_suite_url	string	Required within parent	The URL to the associated check suite.
conclusion	JSON	Required within parent
conclusion (anyOf 1)	string	Alternative
conclusion (anyOf 2)	null	Alternative
created_at	string	Required within parent	Format: date-time
display_title	string	Required within parent	The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow.
event	string	Required within parent
head_branch	JSON	Required within parent
head_branch (anyOf 1)	string	Alternative
head_branch (anyOf 2)	null	Alternative
head_commit	Model	Required within parent	Expand Get a workflow run — response body — head commit
head_repository	Model	Required within parent	Expand Transfer a repository — response body
head_repository_id	JSON	Optional
head_repository_id (anyOf 1)	integer	Alternative
head_repository_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
head_sha	string	Required within parent	The SHA of the head commit that points to the version of the workflow being run.
html_url	string	Required within parent
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The ID of the workflow run. Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
jobs_url	string	Required within parent	The URL to the jobs for the workflow run.
logs_url	string	Required within parent	The URL to download the logs for the workflow run.
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the workflow run.
name (anyOf 2)	null	Alternative
node_id	string	Required within parent
path	string	Required within parent	The full path of the workflow
previous_attempt_url	JSON	Optional
previous_attempt_url (anyOf 1)	string	Alternative	The URL to the previous attempted run of this workflow, if one exists.
previous_attempt_url (anyOf 2)	null	Alternative
pull_requests	JSON	Required within parent
pull_requests (anyOf 1)	array	Alternative	Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.
pull_requests (anyOf 1)[]	Model	Each item	Expand Get a check run — response body — pull requests item
pull_requests (anyOf 2)	null	Alternative
referenced_workflows	JSON	Optional
referenced_workflows (anyOf 1)	array	Alternative
referenced_workflows (anyOf 1)[]	Model	Each item	Expand Get a workflow run — response body — referenced workflows array item
referenced_workflows (anyOf 2)	null	Alternative
repository	Model	Required within parent	Expand Transfer a repository — response body
rerun_url	string	Required within parent	The URL to rerun the workflow run.
run_attempt	JSON	Optional
run_attempt (anyOf 1)	integer	Alternative	Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.
run_attempt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
run_number	JSON	Required within parent
run_number (anyOf 1)	integer	Alternative	The auto incrementing run number for the workflow run.
run_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
run_started_at	string	Optional	The start time of the latest run. Resets on re-run. Format: date-time
status	JSON	Required within parent
status (anyOf 1)	string	Alternative
status (anyOf 2)	null	Alternative
triggering_actor	Model	Optional	Expand List users — response body — item
updated_at	string	Required within parent	Format: date-time
url	string	Required within parent	The URL to the workflow run.
workflow_id	JSON	Required within parent
workflow_id (anyOf 1)	integer	Alternative	The ID of the parent workflow.
workflow_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
workflow_url	string	Required within parent	The URL to the workflow.

Referenced models: Transfer a repository — response body, Get a workflow run — response body — head commit, Get a check run — response body — pull requests item, Get a workflow run — response body — referenced workflows array item, List users — response body — item

Get a workflow run — response body — head commit

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Get a workflow run — response body — head commit A commit
$ (anyOf 2)	null	Alternative

Referenced models: Get a workflow run — response body — head commit A commit

Get a workflow run — response body — head commit A commit

Field	Type	Presence	Description and constraints
$	object	Root	A commit.
author	JSON	Required within parent
author (anyOf 1)	object	Alternative	Information about the Git author
author (anyOf 1).email	string	Required within parent	Git email address of the commit's author Format: email
author (anyOf 1).name	string	Required within parent	Name of the commit's author
author (anyOf 2)	null	Alternative
committer	JSON	Required within parent
committer (anyOf 1)	object	Alternative	Information about the Git committer
committer (anyOf 1).email	string	Required within parent	Git email address of the commit's committer Format: email
committer (anyOf 1).name	string	Required within parent	Name of the commit's committer
committer (anyOf 2)	null	Alternative
id	string	Required within parent	SHA for the commit
message	string	Required within parent	Message describing the purpose of the commit
timestamp	string	Required within parent	Timestamp of the commit Format: date-time
tree_id	string	Required within parent	SHA for the commit's tree

Get a workflow run — response body — referenced workflows array item

Field	Type	Presence	Description and constraints
$	object	Root	A workflow referenced/reused by the initial caller workflow
path	string	Required within parent
ref	string	Optional
sha	string	Required within parent

Get a workflow — response body

Field	Type	Presence	Description and constraints
$	object	Root	A GitHub Actions workflow
badge_url	string	Required within parent
created_at	string	Required within parent	Format: date-time
deleted_at	string	Optional	Format: date-time
html_url	string	Required within parent
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent
node_id	string	Required within parent
path	string	Required within parent
state	string	Required within parent	Known values: active, deleted, disabled_fork, disabled_inactivity, disabled_manually
updated_at	string	Required within parent	Format: date-time
url	string	Required within parent

Get allowed actions and reusable workflows for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root
github_owned_allowed	boolean	Optional	Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.
patterns_allowed	array	Optional	Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. > [!NOTE] > The `patterns_allowed` setting only applies to public repositories.
patterns_allowed[]	string	Each item
verified_allowed	boolean	Optional	Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.

Get an artifact — response body

Field	Type	Presence	Description and constraints
$	object	Root	An artifact
archive_download_url	string	Required within parent
created_at	JSON	Required within parent
created_at (anyOf 1)	string	Alternative	Format: date-time
created_at (anyOf 2)	null	Alternative
digest	JSON	Optional
digest (anyOf 1)	string	Alternative	The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.
digest (anyOf 2)	null	Alternative
expired	boolean	Required within parent	Whether or not the artifact has expired.
expires_at	JSON	Required within parent
expires_at (anyOf 1)	string	Alternative	Format: date-time
expires_at (anyOf 2)	null	Alternative
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	The name of the artifact.
node_id	string	Required within parent
size_in_bytes	JSON	Required within parent
size_in_bytes (anyOf 1)	integer	Alternative	The size in bytes of the artifact.
size_in_bytes (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_at	JSON	Required within parent
updated_at (anyOf 1)	string	Alternative	Format: date-time
updated_at (anyOf 2)	null	Alternative
url	string	Required within parent
workflow_run	JSON	Optional
workflow_run (anyOf 1)	object	Alternative
workflow_run (anyOf 1).head_branch	string	Optional
workflow_run (anyOf 1).head_repository_id	JSON	Optional
workflow_run (anyOf 1).head_repository_id (anyOf 1)	integer	Alternative
workflow_run (anyOf 1).head_repository_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
workflow_run (anyOf 1).head_sha	string	Optional
workflow_run (anyOf 1).id	JSON	Optional
workflow_run (anyOf 1).id (anyOf 1)	integer	Alternative
workflow_run (anyOf 1).id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
workflow_run (anyOf 1).repository_id	JSON	Optional
workflow_run (anyOf 1).repository_id (anyOf 1)	integer	Alternative
workflow_run (anyOf 1).repository_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
workflow_run (anyOf 2)	null	Alternative

Get an environment public key — response body

Field	Type	Presence	Description and constraints
$	object	Root	The public key used for setting Actions Secrets.
created_at	string	Optional
id	JSON	Optional
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
key	string	Required within parent	The Base64 encoded public key.
key_id	string	Required within parent	The identifier for the key.
title	string	Optional
url	string	Optional

Get an environment secret — response body

Field	Type	Presence	Description and constraints
$	object	Root	Set secrets for GitHub Actions.
created_at	string	Required within parent	Format: date-time
name	string	Required within parent	The name of the secret.
updated_at	string	Required within parent	Format: date-time

Get an environment variable — response body

Field	Type	Presence	Description and constraints
$	object	Root
created_at	string	Required within parent	The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Format: date-time
name	string	Required within parent	The name of the variable.
updated_at	string	Required within parent	The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Format: date-time
value	string	Required within parent	The value of the variable.

Get an image version of a custom image for Git Hub Actions Hosted Runners — response body

Field	Type	Presence	Description and constraints
$	object	Root	Provides details of a hosted runner custom image version
created_on	string	Required within parent	The creation date time of the image version.
size_gb	JSON	Required within parent
size_gb (anyOf 1)	integer	Alternative	Image version size in GB.
size_gb (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
state	string	Required within parent	The state of image version.
state_details	string	Required within parent	The image version status details.
version	string	Required within parent	The version of image.

Get artifact and log retention settings for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root
days	JSON	Required within parent
days (anyOf 1)	integer	Alternative	The number of days checks, workflow runs, commit statuses, artifacts, and logs are retained
days (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maximum_allowed_days	JSON	Required within parent
maximum_allowed_days (anyOf 1)	integer	Alternative	The maximum number of days that can be configured
maximum_allowed_days (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get default workflow permissions for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root
can_approve_pull_request_reviews	boolean	Required within parent	Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
default_workflow_permissions	string	Required within parent	The default workflow permissions granted to the GITHUB_TOKEN when running workflows. Known values: read, write

Get fork PR contributor approval permissions for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root
approval_policy	string	Required within parent	The policy that controls when fork PR workflows require approval from a maintainer. Known values: first_time_contributors_new_to_github, first_time_contributors, all_external_contributors

Get limits on Git Hub-hosted runners for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root
public_ips	object	Required within parent	Provides details of static public IP limits for GitHub-hosted Hosted Runners
public_ips.current_usage	JSON	Required within parent
public_ips.current_usage (anyOf 1)	integer	Alternative	The current number of static public IP addresses in use by Hosted Runners.
public_ips.current_usage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
public_ips.maximum	JSON	Required within parent
public_ips.maximum (anyOf 1)	integer	Alternative	The maximum number of static public IP addresses that can be used for Hosted Runners.
public_ips.maximum (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get partner images for Git Hub-hosted runners in an organization — response body — images item

Field	Type	Presence	Description and constraints
$	object	Root	Provides details of a hosted runner image
display_name	string	Required within parent	Display name for this image.
id	string	Required within parent	The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.
platform	string	Required within parent	The operating system of the image.
size_gb	JSON	Required within parent
size_gb (anyOf 1)	integer	Alternative	Image size in GB.
size_gb (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
source	string	Required within parent	The image provider. Known values: github, partner, custom

Get pending deployments for a workflow run — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a deployment that is waiting for protection rules to pass
current_user_can_approve	boolean	Required within parent	Whether the currently authenticated user can approve the deployment
environment	object	Required within parent
environment.html_url	string	Optional
environment.id	JSON	Optional
environment.id (anyOf 1)	integer	Alternative	The id of the environment. Format: int64
environment.id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
environment.name	string	Optional	The name of the environment.
environment.node_id	string	Optional
environment.url	string	Optional
reviewers	array	Required within parent	The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
reviewers[]	object	Each item
reviewers[].reviewer	JSON	Optional
reviewers[].reviewer (anyOf 1)	Model	Alternative	Expand List users — response body — item
reviewers[].reviewer (anyOf 2)	Model	Alternative	Expand List teams — response body — item
reviewers[].type	string	Optional	The type of reviewer. Known values: User, Team
wait_timer	JSON	Required within parent
wait_timer (anyOf 1)	integer	Alternative	The set duration of the wait timer
wait_timer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
wait_timer_started_at	JSON	Required within parent
wait_timer_started_at (anyOf 1)	string	Alternative	The time that the wait timer began. Format: date-time
wait_timer_started_at (anyOf 2)	null	Alternative

Referenced models: List users — response body — item, List teams — response body — item

Get private repo fork PR workflow settings for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root
require_approval_for_fork_pr_workflows	boolean	Required within parent	Whether workflows triggered by pull requests from forks require approval from a repository administrator to run.
run_workflows_from_fork_pull_requests	boolean	Required within parent	Whether workflows triggered by pull requests from forks are allowed to run on private repositories.
send_secrets_and_variables	boolean	Required within parent	Whether to make secrets and variables available to workflows triggered by pull requests from forks.
send_write_tokens_to_workflows	boolean	Required within parent	Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request.

Get self-hosted runners settings for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root
enabled_repositories	string	Required within parent	The policy that controls whether self-hosted runners can be used by repositories in the organization Known values: all, selected, none
selected_repositories_url	string	Optional	The URL to the endpoint for managing selected repositories for self-hosted runners in the organization

Get the customization template for an OIDC subject claim for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root	Actions OIDC subject customization for a repository
include_claim_keys	array	Optional	Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.
include_claim_keys[]	string	Each item
sub_claim_prefix	string	Optional	The current `sub` claim prefix for this repository.
use_default	boolean	Required within parent	Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.
use_immutable_subject	boolean	Optional	Whether the repository has opted in to the immutable OIDC subject claim format. When `true`, OIDC tokens will use a stable, repository-ID-based `sub` claim. If not set at the repository level, falls back to the organization-level setting.

Get the level of access for workflows outside of the repository — response body

Field	Type	Presence	Description and constraints
$	object	Root
access_level	string	Required within parent	Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the repository. `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. Known values: none, user, organization

Get the review history for a workflow run — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	An entry in the reviews log for environment deployments
comment	string	Required within parent	The comment submitted with the deployment review
environments	array	Required within parent	The list of environments that were approved or rejected
environments[]	object	Each item
environments[].created_at	string	Optional	The time that the environment was created, in ISO 8601 format. Format: date-time
environments[].html_url	string	Optional
environments[].id	JSON	Optional
environments[].id (anyOf 1)	integer	Alternative	The id of the environment.
environments[].id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
environments[].name	string	Optional	The name of the environment.
environments[].node_id	string	Optional
environments[].updated_at	string	Optional	The time that the environment was last updated, in ISO 8601 format. Format: date-time
environments[].url	string	Optional
state	string	Required within parent	Whether deployment to the environment(s) was approved or rejected or pending (with comments) Known values: approved, rejected, pending
user	Model	Required within parent	Expand List users — response body — item

Referenced models: List users — response body — item

Get workflow run usage — response body

Field	Type	Presence	Description and constraints
$	object	Root	Workflow Run Usage
billable	object	Required within parent
billable.MACOS	Model	Optional	Expand Get workflow run usage — response body — billable MACOS
billable.UBUNTU	Model	Optional	Expand Get workflow run usage — response body — billable MACOS
billable.WINDOWS	Model	Optional	Expand Get workflow run usage — response body — billable MACOS
run_duration_ms	JSON	Optional
run_duration_ms (anyOf 1)	integer	Alternative
run_duration_ms (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get workflow run usage — response body — billable MACOS

Get workflow run usage — response body — billable MACOS

Field	Type	Presence	Description and constraints
$	object	Root
job_runs	array	Optional
job_runs[]	object	Each item
job_runs[].duration_ms	JSON	Required within parent
job_runs[].duration_ms (anyOf 1)	integer	Alternative
job_runs[].duration_ms (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
job_runs[].job_id	JSON	Required within parent
job_runs[].job_id (anyOf 1)	integer	Alternative
job_runs[].job_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
jobs	JSON	Required within parent
jobs (anyOf 1)	integer	Alternative
jobs (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_ms	JSON	Required within parent
total_ms (anyOf 1)	integer	Alternative
total_ms (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get workflow usage — response body

Field	Type	Presence	Description and constraints
$	object	Root	Workflow Usage
billable	object	Required within parent
billable.MACOS	object	Optional
billable.MACOS.total_ms	JSON	Optional
billable.MACOS.total_ms (anyOf 1)	integer	Alternative
billable.MACOS.total_ms (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
billable.UBUNTU	object	Optional
billable.UBUNTU.total_ms	JSON	Optional
billable.UBUNTU.total_ms (anyOf 1)	integer	Alternative
billable.UBUNTU.total_ms (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
billable.WINDOWS	object	Optional
billable.WINDOWS.total_ms	JSON	Optional
billable.WINDOWS.total_ms (anyOf 1)	integer	Alternative
billable.WINDOWS.total_ms (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List Git Hub Actions caches for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root	Repository actions caches
actions_caches	array	Required within parent	Array of caches
actions_caches[]	object	Each item
actions_caches[].created_at	string	Optional	Format: date-time
actions_caches[].id	JSON	Optional
actions_caches[].id (anyOf 1)	integer	Alternative
actions_caches[].id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
actions_caches[].key	string	Optional
actions_caches[].last_accessed_at	string	Optional	Format: date-time
actions_caches[].ref	string	Optional
actions_caches[].size_in_bytes	JSON	Optional
actions_caches[].size_in_bytes (anyOf 1)	integer	Alternative
actions_caches[].size_in_bytes (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
actions_caches[].version	string	Optional
total_count	JSON	Required within parent
total_count (anyOf 1)	integer	Alternative	Total number of caches
total_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List concurrency groups for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root	A list of active concurrency groups for a repository.
concurrency_groups	array	Required within parent
concurrency_groups[]	object	Each item
concurrency_groups[].group_name	string	Required within parent	The name of the concurrency group.
concurrency_groups[].group_url	string	Required within parent	API URL for this concurrency group. Format: uri
concurrency_groups[].last_acquired_at	JSON	Required within parent
concurrency_groups[].last_acquired_at (anyOf 1)	string	Alternative	Format: date-time
concurrency_groups[].last_acquired_at (anyOf 2)	null	Alternative
total_count	JSON	Required within parent
total_count (anyOf 1)	integer	Alternative
total_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List concurrency groups for a workflow run — response body

Field	Type	Presence	Description and constraints
$	object	Root	A list of concurrency groups associated with a workflow run.
concurrency_groups	array	Required within parent
concurrency_groups[]	object	Each item
concurrency_groups[].group_members	array	Required within parent	Items belonging to this workflow run that are either currently holding or waiting for the concurrency group lease. May be empty if the run no longer has any active or queued items in this group.
concurrency_groups[].group_members[]	object	Each item
concurrency_groups[].group_members[].job_html_url	JSON	Optional
concurrency_groups[].group_members[].job_html_url (anyOf 1)	string	Alternative	Web URL for the job. Format: uri
concurrency_groups[].group_members[].job_html_url (anyOf 2)	null	Alternative
concurrency_groups[].group_members[].job_id	JSON	Optional
concurrency_groups[].group_members[].job_id (anyOf 1)	JSON	Alternative
concurrency_groups[].group_members[].job_id (anyOf 1) (anyOf 1)	integer	Alternative	The ID of the job, when the item represents a job-level or reusable-workflow-level lease.
concurrency_groups[].group_members[].job_id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
concurrency_groups[].group_members[].job_id (anyOf 2)	null	Alternative
concurrency_groups[].group_members[].job_name	JSON	Optional
concurrency_groups[].group_members[].job_name (anyOf 1)	string	Alternative	The display name of the job, when the item represents a job-level or reusable-workflow-level lease.
concurrency_groups[].group_members[].job_name (anyOf 2)	null	Alternative
concurrency_groups[].group_members[].job_url	JSON	Optional
concurrency_groups[].group_members[].job_url (anyOf 1)	string	Alternative	API URL for the job. Format: uri
concurrency_groups[].group_members[].job_url (anyOf 2)	null	Alternative
concurrency_groups[].group_members[].position	JSON	Required within parent
concurrency_groups[].group_members[].position (anyOf 1)	integer	Alternative	Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending).
concurrency_groups[].group_members[].position (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
concurrency_groups[].group_members[].position_url	string	Required within parent	API URL to get items ahead of this item in the concurrency group. Format: uri
concurrency_groups[].group_members[].run_html_url	JSON	Required within parent
concurrency_groups[].group_members[].run_html_url (anyOf 1)	string	Alternative	Web URL for the workflow run. Format: uri
concurrency_groups[].group_members[].run_html_url (anyOf 2)	null	Alternative
concurrency_groups[].group_members[].run_id	JSON	Required within parent
concurrency_groups[].group_members[].run_id (anyOf 1)	integer	Alternative	The ID of the workflow run.
concurrency_groups[].group_members[].run_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
concurrency_groups[].group_members[].run_name	string	Required within parent	The name of the workflow run.
concurrency_groups[].group_members[].run_url	JSON	Required within parent
concurrency_groups[].group_members[].run_url (anyOf 1)	string	Alternative	API URL for the workflow run. Format: uri
concurrency_groups[].group_members[].run_url (anyOf 2)	null	Alternative
concurrency_groups[].group_members[].status	string	Required within parent	Known values: in_progress, pending
concurrency_groups[].group_name	string	Required within parent	The name of the concurrency group.
concurrency_groups[].group_url	string	Required within parent	API URL for this concurrency group. May return 404 if the group has no active items at the time it is requested, since the get-by-name endpoint reports the live repo-wide state of a group while this endpoint lists groups associated with a run by configuration. Format: uri
total_count	JSON	Required within parent
total_count (anyOf 1)	integer	Alternative	The total number of concurrency groups this workflow run participates in, derived from the run's configuration. This count is not filtered by whether the run currently holds or is waiting in each group, so it can include groups whose `group_members` array is empty (for example, when the run has already released its lease in that group).
total_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List runner applications for a repository — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Runner Application
architecture	string	Required within parent
download_url	string	Required within parent
filename	string	Required within parent
os	string	Required within parent
sha256_checksum	string	Optional
temp_download_token	string	Optional	A short lived bearer token used to download the runner, if needed.

List workflow runs for a workflow — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
actor	string	Optional
branch	string	Optional
event	string	Optional
status	string	Optional	One of: completed, action_required, cancelled, failure, neutral, skipped, stale, success, timed_out, in_progress, queued, requested, waiting, pending
per_page	integer	Optional	Default: 30
page	integer	Optional	Default: 1
created	string	Optional	Format: date-time
exclude_pull_requests	boolean	Optional	Default: false
check_suite_id	integer	Optional	Format: int64
head_sha	string	Optional

Re-run a workflow — response body

Field	Type	Presence	Description and constraints
$	object	Root	An object without any properties. Additional keys: not allowed

Review custom deployment protection rules for a workflow run — request body — body / state: approved, rejected

Field	Type	Presence	Description and constraints
$	object	Root
comment	string	Optional	Optional comment to include with the review.
environment_name	string	Required within parent	The name of the environment to approve or reject.
state	string	Required within parent	Whether to approve or reject deployment to the specified environments. One of: approved, rejected

Review custom deployment protection rules for a workflow run — request body — body comment, environment name

Field	Type	Presence	Description and constraints
$	object	Root
comment	string	Required within parent	Comment associated with the pending deployment protection rule. **Required when state is not provided.**
environment_name	string	Required within parent	The name of the environment to approve or reject.

Set Git Hub Actions cache retention limit for a repository — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions cache retention policy for a repository.
max_cache_retention_days	integer	Optional	The maximum number of days to keep caches in this repository.

Set Git Hub Actions cache retention limit for an enterprise — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions cache retention policy for an enterprise.
max_cache_retention_days	integer	Optional	For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.

Set Git Hub Actions cache retention limit for an organization — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions cache retention policy for an organization.
max_cache_retention_days	integer	Optional	For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.

Set Git Hub Actions cache storage limit for a repository — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions cache storage policy for a repository.
max_cache_size_gb	integer	Optional	The maximum total cache size for this repository, in gigabytes.

Set Git Hub Actions cache storage limit for an enterprise — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions cache storage policy for an enterprise.
max_cache_size_gb	integer	Optional	For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.

Set Git Hub Actions cache storage limit for an organization — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	GitHub Actions cache storage policy for an organization.
max_cache_size_gb	integer	Optional	For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.

Set artifact and log retention settings for a repository — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
days	integer	Required within parent	The number of days to retain checks, workflow runs, commit statuses, artifacts, and logs

Set default workflow permissions for a repository — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
can_approve_pull_request_reviews	boolean	Optional	Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
default_workflow_permissions	string	Optional	The default workflow permissions granted to the GITHUB_TOKEN when running workflows. One of: read, write

Set fork PR contributor approval permissions for a repository — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
approval_policy	string	Required within parent	The policy that controls when fork PR workflows require approval from a maintainer. One of: first_time_contributors_new_to_github, first_time_contributors, all_external_contributors

Set private repo fork PR workflow settings for a repository — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
require_approval_for_fork_pr_workflows	boolean	Optional	Whether workflows triggered by pull requests from forks require approval from a repository administrator to run.
run_workflows_from_fork_pull_requests	boolean	Required within parent	Whether workflows triggered by pull requests from forks are allowed to run on private repositories.
send_secrets_and_variables	boolean	Optional	Whether to make secrets and variables available to workflows triggered by pull requests from forks.
send_write_tokens_to_workflows	boolean	Optional	Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request.

Set the level of access for workflows outside of the repository — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
access_level	string	Required within parent	Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the repository. `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. One of: none, user, organization