Actions
Download SpecEndpoints to manage GitHub Actions using the REST API.
Get GitHub Actions cache usage for an enterprise
Gets the total GitHub Actions cache usage for an enterprise.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
enterprise
string
required
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Response
Response
{
"total_active_caches_size_in_bytes": 3344284,
"total_active_caches_count": 5
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_active_caches_count
int
required
The count of active caches across all repositories of an enterprise or an organization.
total_active_caches_size_in_bytes
int
required
The total size in bytes of all active cache items across all repositories of an enterprise or an organization.
Link
string
Get GitHub Actions cache usage policy for an enterprise
Gets the GitHub Actions cache usage policy for an enterprise.
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
enterprise
string
required
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Response
Response
{
"repo_cache_size_limit_in_gb": 10,
"max_repo_cache_size_limit_in_gb": 15
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
repo_cache_size_limit_in_gb
int
For repositories in an enterprise, the default size limit for the sum of all caches in a repository, in gigabytes.
- Example
- 10
max_repo_cache_size_limit_in_gb
int
For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.
- Example
- 15
Link
string
Set GitHub Actions cache usage policy for an enterprise
Sets the GitHub Actions cache usage policy for an enterprise.
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
repo_cache_size_limit_in_gb
int
For repositories in an enterprise, the default size limit for the sum of all caches in a repository, in gigabytes.
- Example
- 10
max_repo_cache_size_limit_in_gb
int
For repositories in an enterprise, the maximum value that can be set as the limit for the sum of all caches in a repository, in gigabytes.
- Example
- 15
enterprise
string
required
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Request
{
"repo_cache_size_limit_in_gb": 10,
"max_repo_cache_size_limit_in_gb": 15
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get default workflow permissions for an enterprise
Gets the default workflow permissions granted to the GITHUB_TOKEN
when running workflows in an enterprise,
as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
"Enforcing a policy for workflow permissions in your enterprise."
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
enterprise
string
required
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Response
Success response
{
"default_workflow_permissions": "read",
"can_approve_pull_request_reviews": true
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
default_workflow_permissions
string
required
The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
- Enum
-
- read
- write
can_approve_pull_request_reviews
boolean
required
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
Set default workflow permissions for an enterprise
Sets the default workflow permissions granted to the GITHUB_TOKEN
when running workflows in an enterprise, and sets
whether GitHub Actions can submit approving pull request reviews. For more information, see
"Enforcing a policy for workflow permissions in your enterprise."
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
default_workflow_permissions
string
The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
- Enum
-
- read
- write
can_approve_pull_request_reviews
boolean
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
enterprise
string
required
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Request
{
"default_workflow_permissions": "read",
"can_approve_pull_request_reviews": true
}
Response
Success response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get GitHub Actions cache usage for an organization
Gets the total GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
You must authenticate using an access token with the read:org
scope to use this endpoint. GitHub Apps must have the organization_admistration:read
permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"total_active_caches_size_in_bytes": 3344284,
"total_active_caches_count": 5
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_active_caches_count
int
required
The count of active caches across all repositories of an enterprise or an organization.
total_active_caches_size_in_bytes
int
required
The total size in bytes of all active cache items across all repositories of an enterprise or an organization.
Link
string
List repositories with GitHub Actions cache usage for an organization
Lists repositories and their GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
You must authenticate using an access token with the read:org
scope to use this endpoint. GitHub Apps must have the organization_admistration:read
permission to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"total_count": 2,
"repository_cache_usages": [
{
"full_name": "octo-org/Hello-World",
"active_caches_size_in_bytes": 2322142,
"active_caches_count": 3
},
{
"full_name": "octo-org/server",
"active_caches_size_in_bytes": 1022142,
"active_caches_count": 2
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
repository_cache_usages
array[object (Actions Cache Usage by repository)]
required
Actions Cache Usage by repository
object (Actions Cache Usage by repository)
GitHub Actions Cache Usage by repository.
full_name
string
required
The repository owner and name for the cache usage being shown.
- Example
- "octo-org/Hello-World"
active_caches_size_in_bytes
int
required
The sum of the size in bytes of all the active cache items in the repository.
- Example
- 2322142
active_caches_count
int
required
The number of active caches in the repository.
- Example
- 3
Link
string
Get GitHub Actions permissions for an organization
Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"enabled_repositories": "all",
"allowed_actions": "selected",
"selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
enabled_repositories
string
required
The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
- Enum
-
- all
- none
- selected
selected_repositories_url
string
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
.
allowed_actions
string
The permissions policy that controls the actions that are allowed to run.
- Enum
-
- all
- local_only
- selected
selected_actions_url
string
The API URL to use to get or set the actions that are allowed to run, when allowed_actions
is set to selected
.
Set GitHub Actions permissions for an organization
Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions
to selected
actions, then you cannot override them for the organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
enabled_repositories
string
required
The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
- Enum
-
- all
- none
- selected
allowed_actions
string
The permissions policy that controls the actions that are allowed to run.
- Enum
-
- all
- local_only
- selected
org
string
required
The organization name. The name is not case sensitive.
Request
{
"enabled_repositories": "all",
"allowed_actions": "selected"
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List selected repositories enabled for GitHub Actions in an organization
Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see "Set GitHub Actions permissions for an organization."
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"total_count": 1,
"repositories": [
{
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": null,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": true,
"topics": [
"octocat",
"atom",
"electron",
"api"
],
"has_issues": true,
"has_projects": true,
"has_wiki": true,
"has_pages": false,
"has_downloads": true,
"archived": false,
"disabled": false,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": false,
"push": false,
"pull": true
},
"allow_rebase_merge": true,
"template_repository": null,
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"allow_squash_merge": true,
"allow_auto_merge": false,
"delete_branch_on_merge": true,
"allow_merge_commit": true,
"subscribers_count": 42,
"network_count": 0,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://api.github.com/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"forks": 1,
"open_issues": 1,
"watchers": 1
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
number
required
repositories
array[object (Repository)]
required
Repository
object (Repository)
A repository on GitHub.
id
int
required
Unique identifier of the repository
- Example
- 42
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
The name of the repository.
- Example
- "Team Environment"
full_name
string
required
- Example
- "octocat/Hello-World"
license
object (license) or null
required
License Simple
key
string
required
- Example
- "mit"
name
string
required
- Example
- "MIT License"
url
string or null
uri
required
- Example
- "https://api.github.com/licenses/mit"
spdx_id
string or null
required
- Example
- "MIT"
node_id
string
required
- Example
- "MDc6TGljZW5zZW1pdA=="
html_url
string
uri
organization
object (organization) or null
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
forks
int
required
permissions
object (permissions)
admin
boolean
required
pull
boolean
required
triage
boolean
push
boolean
required
maintain
boolean
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
Whether the repository is private or public.
- Default
- false
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
required
- Example
- "git:github.com/octocat/Hello-World.git"
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
required
- Example
- "git@github.com:octocat/Hello-World.git"
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
required
- Example
- "https://github.com/octocat/Hello-World.git"
mirror_url
string or null
uri
required
- Example
- "git:git.example.com/octocat/Hello-World"
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
uri
required
- Example
- "https://svn.github.com/octocat/Hello-World"
homepage
string or null
uri
required
- Example
- "https://github.com"
language
string or null
required
forks_count
int
required
- Example
- 9
stargazers_count
int
required
- Example
- 80
watchers_count
int
required
- Example
- 80
size
int
required
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- Example
- 108
default_branch
string
required
The default branch of the repository.
- Example
- "master"
open_issues_count
int
required
- Example
- 0
is_template
boolean
Whether this repository acts as a template that can be used to generate new repositories.
- Default
- false
- Example
- true
topics
array[string]
string
has_issues
boolean
required
Whether issues are enabled.
- Default
- true
- Example
- true
has_projects
boolean
required
Whether projects are enabled.
- Default
- true
- Example
- true
has_wiki
boolean
required
Whether the wiki is enabled.
- Default
- true
- Example
- true
has_pages
boolean
required
has_downloads
boolean
required
Whether downloads are enabled.
- Default
- true
- Example
- true
has_discussions
boolean
Whether discussions are enabled.
- Default
- false
- Example
- true
archived
boolean
required
Whether the repository is archived.
- Default
- false
disabled
boolean
required
Returns whether or not this repository disabled.
visibility
string
The repository visibility: public, private, or internal.
- Default
- "public"
pushed_at
string or null
date-time
required
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
required
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
required
- Example
- "2011-01-26T19:14:43Z"
allow_rebase_merge
boolean
Whether to allow rebase merges for pull requests.
- Default
- true
- Example
- true
template_repository
object (template_repository) or null
id
int
node_id
string
name
string
full_name
string
owner
object (owner)
login
string
id
int
node_id
string
avatar_url
string
gravatar_id
string
url
string
html_url
string
followers_url
string
following_url
string
gists_url
string
starred_url
string
subscriptions_url
string
organizations_url
string
repos_url
string
events_url
string
received_events_url
string
type
string
site_admin
boolean
private
boolean
html_url
string
description
string
fork
boolean
url
string
archive_url
string
assignees_url
string
blobs_url
string
branches_url
string
collaborators_url
string
comments_url
string
commits_url
string
compare_url
string
contents_url
string
contributors_url
string
deployments_url
string
downloads_url
string
events_url
string
forks_url
string
git_commits_url
string
git_refs_url
string
git_tags_url
string
git_url
string
issue_comment_url
string
issue_events_url
string
issues_url
string
keys_url
string
labels_url
string
languages_url
string
merges_url
string
milestones_url
string
notifications_url
string
pulls_url
string
releases_url
string
ssh_url
string
stargazers_url
string
statuses_url
string
subscribers_url
string
subscription_url
string
tags_url
string
teams_url
string
trees_url
string
clone_url
string
mirror_url
string
hooks_url
string
svn_url
string
homepage
string
language
string
forks_count
int
stargazers_count
int
watchers_count
int
size
int
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string
created_at
string
updated_at
string
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
allow_rebase_merge
boolean
temp_clone_token
string
allow_squash_merge
boolean
allow_auto_merge
boolean
delete_branch_on_merge
boolean
allow_update_branch
boolean
use_squash_pr_title_as_default
boolean
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
subscribers_count
int
network_count
int
temp_clone_token
string
allow_squash_merge
boolean
Whether to allow squash merges for pull requests.
- Default
- true
- Example
- true
allow_auto_merge
boolean
Whether to allow Auto-merge to be used on pull requests.
- Default
- false
- Example
- false
delete_branch_on_merge
boolean
Whether to delete head branches when pull requests are merged
- Default
- false
- Example
- false
allow_update_branch
boolean
Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- Default
- false
- Example
- false
use_squash_pr_title_as_default
boolean
deprecated
Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title
instead.
- Default
- false
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
Whether to allow merge commits for pull requests.
- Default
- true
- Example
- true
allow_forking
boolean
Whether to allow forking this repo
web_commit_signoff_required
boolean
Whether to require contributors to sign off on web-based commits
- Default
- false
subscribers_count
int
network_count
int
open_issues
int
required
watchers
int
required
master_branch
string
starred_at
string
- Example
- "\"2020-07-09T00:17:42Z\""
anonymous_access_enabled
boolean
Whether anonymous git access is enabled for this repository
Set selected repositories enabled for GitHub Actions in an organization
Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see "Set GitHub Actions permissions for an organization."
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
selected_repository_ids
array[int]
required
List of repository IDs to enable for GitHub Actions.
int
Unique identifier of the repository.
org
string
required
The organization name. The name is not case sensitive.
Request
{
"selected_repository_ids": [
32,
42
]
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Enable a selected repository for GitHub Actions in an organization
Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be must be configured to selected
. For more information, see "Set GitHub Actions permissions for an organization."
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
org
string
required
The organization name. The name is not case sensitive.
repository_id
int
required
The unique identifier of the repository.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Disable a selected repository for GitHub Actions in an organization
Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see "Set GitHub Actions permissions for an organization."
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
org
string
required
The organization name. The name is not case sensitive.
repository_id
int
required
The unique identifier of the repository.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get allowed actions for an organization
Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions
must be configured to selected
. For more information, see "Set GitHub Actions permissions for an organization.""
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"github_owned_allowed": true,
"verified_allowed": false,
"patterns_allowed": [
"monalisa/octocat@*",
"docker/*"
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
github_owned_allowed
boolean
required
Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions
organization.
patterns_allowed
array[string]
required
Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*
, monalisa/octocat@v2
, monalisa/*
.
string
Set allowed actions for an organization
Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions
must be configured to selected
. For more information, see "Set GitHub Actions permissions for an organization."
If the organization belongs to an enterprise that has selected
actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.
To use the patterns_allowed
setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed
setting only applies to public repositories in the organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
github_owned_allowed
boolean
required
Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions
organization.
patterns_allowed
array[string]
required
Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*
, monalisa/octocat@v2
, monalisa/*
.
string
org
string
required
The organization name. The name is not case sensitive.
Request
{
"github_owned_allowed": true,
"verified_allowed": false,
"patterns_allowed": [
"monalisa/octocat@*",
"docker/*"
]
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get default workflow permissions for an organization
Gets the default workflow permissions granted to the GITHUB_TOKEN
when running workflows in an organization,
as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
"Setting the permissions of the GITHUB_TOKEN for your organization."
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"default_workflow_permissions": "read",
"can_approve_pull_request_reviews": true
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
default_workflow_permissions
string
required
The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
- Enum
-
- read
- write
can_approve_pull_request_reviews
boolean
required
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
Set default workflow permissions for an organization
Sets the default workflow permissions granted to the GITHUB_TOKEN
when running workflows in an organization, and sets if GitHub Actions
can submit approving pull request reviews. For more information, see
"Setting the permissions of the GITHUB_TOKEN for your organization."
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
default_workflow_permissions
string
The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
- Enum
-
- read
- write
can_approve_pull_request_reviews
boolean
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
org
string
required
The organization name. The name is not case sensitive.
Request
{
"default_workflow_permissions": "read",
"can_approve_pull_request_reviews": true
}
Response
Success response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Conflict response when changing a setting is prevented by the owning enterprise
Empty response
List required workflows
List all required workflows in an organization.
You must authenticate using an access token with the read:org
scope to use this endpoint.
For more information, see "Required Workflows."
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"total_count": 2,
"required_workflows": [
{
"id": 30433642,
"name": "Required CI",
"path": ".github/workflows/ci.yml",
"scope": "selected",
"ref": "refs/head/main",
"state": "active",
"selected_repositories_url": "https://api.github.com/organizations/org/actions/required_workflows/1/repositories",
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
}
},
{
"id": 30433643,
"name": "Required Linter",
"path": ".github/workflows/lint.yml",
"scope": "all",
"ref": "refs/head/main",
"state": "active",
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
}
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
required_workflows
array[object]
required
object
id
number
required
Unique identifier for a required workflow
name
string
required
Name present in the workflow file
path
string
required
Path of the workflow file
scope
string
required
Scope of the required workflow
- Enum
-
- all
- selected
ref
string
required
Ref at which the workflow file will be selected
state
string
required
State of the required workflow
- Enum
-
- active
- deleted
selected_repositories_url
string
uri
- Example
- "https://api.github.com/organizations/org/actions/required_workflows/1/repositories"
created_at
string
date-time
required
updated_at
string
date-time
required
repository
object (repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
Create a required workflow
Create a required workflow in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
For more information, see "Required Workflows."
workflow_file_path
string
required
Path of the workflow file to be configured as a required workflow.
repository_id
string
required
The ID of the repository that contains the workflow file.
scope
string
Enable the required workflow for all repositories or selected repositories in the organization.
- Default
- "all"
- Enum
-
- selected
- all
selected_repository_ids
array[int]
A list of repository IDs where you want to enable the required workflow. You can only provide a list of repository ids when the scope
is set to selected
.
int
Unique identifier of the repository.
org
string
required
The organization name. The name is not case sensitive.
Request
{
"workflow_file_path": ".github/workflows/ci.yaml",
"repository_id": 53,
"scope": "selected",
"selected_repository_ids": [
32,
91
]
}
Response
Response
{
"id": 30433642,
"name": "Required CI",
"path": ".github/workflows/ci.yml",
"scope": "selected",
"ref": "refs/head/main",
"state": "active",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/required_workflows/1/repositories",
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
required
documentation_url
string
required
errors
array[string]
string
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
"string"
]
}
id
number
required
Unique identifier for a required workflow
name
string
required
Name present in the workflow file
path
string
required
Path of the workflow file
scope
string
required
Scope of the required workflow
- Enum
-
- all
- selected
ref
string
required
Ref at which the workflow file will be selected
state
string
required
State of the required workflow
- Enum
-
- active
- deleted
selected_repositories_url
string
uri
- Example
- "https://api.github.com/organizations/org/actions/required_workflows/1/repositories"
created_at
string
date-time
required
updated_at
string
date-time
required
repository
object (repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
Get a required workflow
Get a required workflow configured in an organization.
You must authenticate using an access token with the read:org
scope to use this endpoint.
For more information, see "Required Workflows."
org
string
required
The organization name. The name is not case sensitive.
required_workflow_id
int
required
The unique identifier of the required workflow.
Response
Response
{
"id": 30433642,
"name": "Required CI",
"path": ".github/workflows/ci.yml",
"scope": "selected",
"ref": "refs/head/main",
"state": "active",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/required_workflows/1/repositories",
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
id
number
required
Unique identifier for a required workflow
name
string
required
Name present in the workflow file
path
string
required
Path of the workflow file
scope
string
required
Scope of the required workflow
- Enum
-
- all
- selected
ref
string
required
Ref at which the workflow file will be selected
state
string
required
State of the required workflow
- Enum
-
- active
- deleted
selected_repositories_url
string
uri
- Example
- "https://api.github.com/organizations/org/actions/required_workflows/1/repositories"
created_at
string
date-time
required
updated_at
string
date-time
required
repository
object (repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
Delete a required workflow
Deletes a required workflow configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
For more information, see "Required Workflows."
org
string
required
The organization name. The name is not case sensitive.
required_workflow_id
int
required
The unique identifier of the required workflow.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Update a required workflow
Update a required workflow in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
For more information, see "Required Workflows."
workflow_file_path
string
Path of the workflow file to be configured as a required workflow.
repository_id
string
The ID of the repository that contains the workflow file.
scope
string
Enable the required workflow for all repositories or selected repositories in the organization.
- Default
- "all"
- Enum
-
- selected
- all
selected_repository_ids
array[int]
A list of repository IDs where you want to enable the required workflow. A list of repository IDs where you want to enable the required workflow. You can only provide a list of repository ids when the scope
is set to selected
.
int
Unique identifier of the repository.
org
string
required
The organization name. The name is not case sensitive.
required_workflow_id
int
required
The unique identifier of the required workflow.
Request
{
"workflow_file_path": ".github/workflows/ci.yaml",
"repository_id": 53,
"scope": "selected",
"selected_repository_ids": [
32,
91
]
}
Response
Response
{
"id": 30433642,
"name": "Required CI",
"path": ".github/workflows/ci.yml",
"scope": "selected",
"ref": "refs/head/main",
"state": "active",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/required_workflows/1/repositories",
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
required
documentation_url
string
required
errors
array[string]
string
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
"string"
]
}
id
number
required
Unique identifier for a required workflow
name
string
required
Name present in the workflow file
path
string
required
Path of the workflow file
scope
string
required
Scope of the required workflow
- Enum
-
- all
- selected
ref
string
required
Ref at which the workflow file will be selected
state
string
required
State of the required workflow
- Enum
-
- active
- deleted
selected_repositories_url
string
uri
- Example
- "https://api.github.com/organizations/org/actions/required_workflows/1/repositories"
created_at
string
date-time
required
updated_at
string
date-time
required
repository
object (repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
List selected repositories for a required workflow
Lists the selected repositories that are configured for a required workflow in an organization. To use this endpoint, the required workflow must be configured to run on selected repositories.
You must authenticate using an access token with the read:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this endpoint.
For more information, see "Required Workflows."
org
string
required
The organization name. The name is not case sensitive.
required_workflow_id
int
required
The unique identifier of the required workflow.
Response
Success
{
"total_count": 1,
"repositories": [
{
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": null,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": true,
"topics": [
"octocat",
"atom",
"electron",
"api"
],
"has_issues": true,
"has_projects": true,
"has_wiki": true,
"has_pages": false,
"has_downloads": true,
"archived": false,
"disabled": false,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": false,
"push": false,
"pull": true
},
"allow_rebase_merge": true,
"template_repository": null,
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"allow_squash_merge": true,
"allow_auto_merge": false,
"delete_branch_on_merge": true,
"allow_merge_commit": true,
"subscribers_count": 42,
"network_count": 0,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://api.github.com/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"forks": 1,
"open_issues": 1,
"watchers": 1
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Resource Not Found
Empty response
total_count
number
required
repositories
array[object (Repository)]
required
Repository
object (Repository)
A repository on GitHub.
id
int
required
Unique identifier of the repository
- Example
- 42
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
The name of the repository.
- Example
- "Team Environment"
full_name
string
required
- Example
- "octocat/Hello-World"
license
object (license) or null
required
License Simple
key
string
required
- Example
- "mit"
name
string
required
- Example
- "MIT License"
url
string or null
uri
required
- Example
- "https://api.github.com/licenses/mit"
spdx_id
string or null
required
- Example
- "MIT"
node_id
string
required
- Example
- "MDc6TGljZW5zZW1pdA=="
html_url
string
uri
organization
object (organization) or null
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
forks
int
required
permissions
object (permissions)
admin
boolean
required
pull
boolean
required
triage
boolean
push
boolean
required
maintain
boolean
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
Whether the repository is private or public.
- Default
- false
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
required
- Example
- "git:github.com/octocat/Hello-World.git"
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
required
- Example
- "git@github.com:octocat/Hello-World.git"
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
required
- Example
- "https://github.com/octocat/Hello-World.git"
mirror_url
string or null
uri
required
- Example
- "git:git.example.com/octocat/Hello-World"
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
uri
required
- Example
- "https://svn.github.com/octocat/Hello-World"
homepage
string or null
uri
required
- Example
- "https://github.com"
language
string or null
required
forks_count
int
required
- Example
- 9
stargazers_count
int
required
- Example
- 80
watchers_count
int
required
- Example
- 80
size
int
required
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- Example
- 108
default_branch
string
required
The default branch of the repository.
- Example
- "master"
open_issues_count
int
required
- Example
- 0
is_template
boolean
Whether this repository acts as a template that can be used to generate new repositories.
- Default
- false
- Example
- true
topics
array[string]
string
has_issues
boolean
required
Whether issues are enabled.
- Default
- true
- Example
- true
has_projects
boolean
required
Whether projects are enabled.
- Default
- true
- Example
- true
has_wiki
boolean
required
Whether the wiki is enabled.
- Default
- true
- Example
- true
has_pages
boolean
required
has_downloads
boolean
required
Whether downloads are enabled.
- Default
- true
- Example
- true
has_discussions
boolean
Whether discussions are enabled.
- Default
- false
- Example
- true
archived
boolean
required
Whether the repository is archived.
- Default
- false
disabled
boolean
required
Returns whether or not this repository disabled.
visibility
string
The repository visibility: public, private, or internal.
- Default
- "public"
pushed_at
string or null
date-time
required
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
required
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
required
- Example
- "2011-01-26T19:14:43Z"
allow_rebase_merge
boolean
Whether to allow rebase merges for pull requests.
- Default
- true
- Example
- true
template_repository
object (template_repository) or null
id
int
node_id
string
name
string
full_name
string
owner
object (owner)
login
string
id
int
node_id
string
avatar_url
string
gravatar_id
string
url
string
html_url
string
followers_url
string
following_url
string
gists_url
string
starred_url
string
subscriptions_url
string
organizations_url
string
repos_url
string
events_url
string
received_events_url
string
type
string
site_admin
boolean
private
boolean
html_url
string
description
string
fork
boolean
url
string
archive_url
string
assignees_url
string
blobs_url
string
branches_url
string
collaborators_url
string
comments_url
string
commits_url
string
compare_url
string
contents_url
string
contributors_url
string
deployments_url
string
downloads_url
string
events_url
string
forks_url
string
git_commits_url
string
git_refs_url
string
git_tags_url
string
git_url
string
issue_comment_url
string
issue_events_url
string
issues_url
string
keys_url
string
labels_url
string
languages_url
string
merges_url
string
milestones_url
string
notifications_url
string
pulls_url
string
releases_url
string
ssh_url
string
stargazers_url
string
statuses_url
string
subscribers_url
string
subscription_url
string
tags_url
string
teams_url
string
trees_url
string
clone_url
string
mirror_url
string
hooks_url
string
svn_url
string
homepage
string
language
string
forks_count
int
stargazers_count
int
watchers_count
int
size
int
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string
created_at
string
updated_at
string
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
allow_rebase_merge
boolean
temp_clone_token
string
allow_squash_merge
boolean
allow_auto_merge
boolean
delete_branch_on_merge
boolean
allow_update_branch
boolean
use_squash_pr_title_as_default
boolean
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
subscribers_count
int
network_count
int
temp_clone_token
string
allow_squash_merge
boolean
Whether to allow squash merges for pull requests.
- Default
- true
- Example
- true
allow_auto_merge
boolean
Whether to allow Auto-merge to be used on pull requests.
- Default
- false
- Example
- false
delete_branch_on_merge
boolean
Whether to delete head branches when pull requests are merged
- Default
- false
- Example
- false
allow_update_branch
boolean
Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- Default
- false
- Example
- false
use_squash_pr_title_as_default
boolean
deprecated
Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title
instead.
- Default
- false
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
Whether to allow merge commits for pull requests.
- Default
- true
- Example
- true
allow_forking
boolean
Whether to allow forking this repo
web_commit_signoff_required
boolean
Whether to require contributors to sign off on web-based commits
- Default
- false
subscribers_count
int
network_count
int
open_issues
int
required
watchers
int
required
master_branch
string
starred_at
string
- Example
- "\"2020-07-09T00:17:42Z\""
anonymous_access_enabled
boolean
Whether anonymous git access is enabled for this repository
Sets repositories for a required workflow
Sets the repositories for a required workflow that is required for selected repositories.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
For more information, see "Required Workflows."
selected_repository_ids
array[int]
required
The IDs of the repositories for which the workflow should be required.
int
Unique identifier of the repository.
org
string
required
The organization name. The name is not case sensitive.
required_workflow_id
int
required
The unique identifier of the required workflow.
Request
{
"selected_repository_ids": [
32,
91
]
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Add a repository to a required workflow
Adds a repository to a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
For more information, see "Required Workflows."
org
string
required
The organization name. The name is not case sensitive.
required_workflow_id
int
required
The unique identifier of the required workflow.
repository_id
int
required
The unique identifier of the repository.
Response
Success
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
No schema
Resource Not Found
Empty response
Validation Error
Empty response
Remove a selected repository from required workflow
Removes a repository from a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
For more information, see "Required Workflows."
org
string
required
The organization name. The name is not case sensitive.
required_workflow_id
int
required
The unique identifier of the required workflow.
repository_id
int
required
The unique identifier of the repository.
Response
Success
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
No schema
Resource Not Found
Empty response
Validation Error
Empty response
List self-hosted runner groups for an organization
Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
visible_to_repository
string
Only return runner groups that are allowed to be used by this repository.
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"total_count": 3,
"runner_groups": [
{
"id": 1,
"name": "Default",
"visibility": "all",
"default": true,
"runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners",
"inherited": false,
"allows_public_repositories": true,
"restricted_to_workflows": false,
"selected_workflows": [],
"workflow_restrictions_read_only": false
},
{
"id": 2,
"name": "octo-runner-group",
"visibility": "selected",
"default": false,
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories",
"runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
"inherited": true,
"allows_public_repositories": true,
"restricted_to_workflows": true,
"selected_workflows": [
"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
],
"workflow_restrictions_read_only": true
},
{
"id": 3,
"name": "expensive-hardware",
"visibility": "private",
"default": false,
"runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners",
"inherited": false,
"allows_public_repositories": true,
"restricted_to_workflows": false,
"selected_workflows": [
"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
],
"workflow_restrictions_read_only": false
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
number
required
runner_groups
array[object]
required
object
id
number
required
name
string
required
visibility
string
required
default
boolean
required
selected_repositories_url
string
Link to the selected repositories resource for this runner group. Not present unless visibility was set to selected
runners_url
string
required
inherited
boolean
required
inherited_allows_public_repositories
boolean
allows_public_repositories
boolean
required
workflow_restrictions_read_only
boolean
If true
, the restricted_to_workflows
and selected_workflows
fields cannot be modified.
- Default
- false
restricted_to_workflows
boolean
If true
, the runner group will be restricted to running only the workflows specified in the selected_workflows
array.
- Default
- false
selected_workflows
array[string]
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows
is set to true
.
string
Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
- Example
- "octo-org/octo-repo/.github/workflows/deploy.yaml@main"
Create a self-hosted runner group for an organization
Creates a new self-hosted runner group for an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
name
string
required
Name of the runner group.
visibility
string
Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.
- Default
- "all"
- Enum
-
- selected
- all
- private
selected_repository_ids
array[int]
List of repository IDs that can access the runner group.
int
Unique identifier of the repository.
runners
array[int]
List of runner IDs to add to the runner group.
int
Unique identifier of the runner.
allows_public_repositories
boolean
Whether the runner group can be used by public
repositories.
- Default
- false
restricted_to_workflows
boolean
If true
, the runner group will be restricted to running only the workflows specified in the selected_workflows
array.
- Default
- false
selected_workflows
array[string]
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows
is set to true
.
string
Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
- Example
- "octo-org/octo-repo/.github/workflows/deploy.yaml@main"
org
string
required
The organization name. The name is not case sensitive.
Request
{
"name": "Expensive hardware runners",
"visibility": "selected",
"selected_repository_ids": [
32,
91
],
"runners": [
9,
2
]
}
Response
Response
{
"id": 2,
"name": "octo-runner-group",
"visibility": "selected",
"default": false,
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories",
"runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
"inherited": false,
"allows_public_repositories": true,
"restricted_to_workflows": true,
"selected_workflows": [
"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
],
"workflow_restrictions_read_only": false
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
id
number
required
name
string
required
visibility
string
required
default
boolean
required
selected_repositories_url
string
Link to the selected repositories resource for this runner group. Not present unless visibility was set to selected
runners_url
string
required
inherited
boolean
required
inherited_allows_public_repositories
boolean
allows_public_repositories
boolean
required
workflow_restrictions_read_only
boolean
If true
, the restricted_to_workflows
and selected_workflows
fields cannot be modified.
- Default
- false
restricted_to_workflows
boolean
If true
, the runner group will be restricted to running only the workflows specified in the selected_workflows
array.
- Default
- false
selected_workflows
array[string]
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows
is set to true
.
string
Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
- Example
- "octo-org/octo-repo/.github/workflows/deploy.yaml@main"
Get a self-hosted runner group for an organization
Gets a specific self-hosted runner group for an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
runner_group_id
int
required
Unique identifier of the self-hosted runner group.
Response
Response
{
"id": 2,
"name": "octo-runner-group",
"visibility": "selected",
"default": false,
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories",
"runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
"inherited": false,
"allows_public_repositories": true,
"restricted_to_workflows": true,
"selected_workflows": [
"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
],
"workflow_restrictions_read_only": false
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
id
number
required
name
string
required
visibility
string
required
default
boolean
required
selected_repositories_url
string
Link to the selected repositories resource for this runner group. Not present unless visibility was set to selected
runners_url
string
required
inherited
boolean
required
inherited_allows_public_repositories
boolean
allows_public_repositories
boolean
required
workflow_restrictions_read_only
boolean
If true
, the restricted_to_workflows
and selected_workflows
fields cannot be modified.
- Default
- false
restricted_to_workflows
boolean
If true
, the runner group will be restricted to running only the workflows specified in the selected_workflows
array.
- Default
- false
selected_workflows
array[string]
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows
is set to true
.
string
Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
- Example
- "octo-org/octo-repo/.github/workflows/deploy.yaml@main"
Delete a self-hosted runner group from an organization
Deletes a self-hosted runner group for an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
runner_group_id
int
required
Unique identifier of the self-hosted runner group.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Update a self-hosted runner group for an organization
Updates the name
and visibility
of a self-hosted runner group in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
name
string
required
Name of the runner group.
visibility
string
Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.
- Enum
-
- selected
- all
- private
allows_public_repositories
boolean
Whether the runner group can be used by public
repositories.
- Default
- false
restricted_to_workflows
boolean
If true
, the runner group will be restricted to running only the workflows specified in the selected_workflows
array.
- Default
- false
selected_workflows
array[string]
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows
is set to true
.
string
Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
- Example
- "octo-org/octo-repo/.github/workflows/deploy.yaml@main"
org
string
required
The organization name. The name is not case sensitive.
runner_group_id
int
required
Unique identifier of the self-hosted runner group.
Request
{
"name": "Expensive hardware runners",
"visibility": "selected"
}
Response
Response
{
"id": 2,
"name": "octo-runner-group",
"visibility": "selected",
"default": false,
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories",
"runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
"inherited": false,
"allows_public_repositories": true,
"restricted_to_workflows": true,
"selected_workflows": [
"octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
],
"workflow_restrictions_read_only": false
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
id
number
required
name
string
required
visibility
string
required
default
boolean
required
selected_repositories_url
string
Link to the selected repositories resource for this runner group. Not present unless visibility was set to selected
runners_url
string
required
inherited
boolean
required
inherited_allows_public_repositories
boolean
allows_public_repositories
boolean
required
workflow_restrictions_read_only
boolean
If true
, the restricted_to_workflows
and selected_workflows
fields cannot be modified.
- Default
- false
restricted_to_workflows
boolean
If true
, the runner group will be restricted to running only the workflows specified in the selected_workflows
array.
- Default
- false
selected_workflows
array[string]
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows
is set to true
.
string
Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
- Example
- "octo-org/octo-repo/.github/workflows/deploy.yaml@main"
List repository access to a self-hosted runner group in an organization
Lists the repositories with access to a self-hosted runner group configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
page
int
Page number of the results to fetch.
- Default
- 1
per_page
int
The number of results per page (max 100).
- Default
- 30
org
string
required
The organization name. The name is not case sensitive.
runner_group_id
int
required
Unique identifier of the self-hosted runner group.
Response
Response
{
"total_count": 1,
"repositories": [
{
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": null,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": true,
"topics": [
"octocat",
"atom",
"electron",
"api"
],
"has_issues": true,
"has_projects": true,
"has_wiki": true,
"has_pages": false,
"has_downloads": true,
"archived": false,
"disabled": false,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": false,
"push": false,
"pull": true
},
"template_repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"organization": null,
"language": null,
"forks": 9,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"watchers": 80,
"size": 108,
"default_branch": "master",
"open_issues": 0,
"open_issues_count": 0,
"is_template": true,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://api.github.com/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://api.github.com/licenses/mit"
},
"topics": [
"octocat",
"atom",
"electron",
"api"
],
"has_issues": true,
"has_projects": true,
"has_wiki": true,
"has_pages": false,
"has_downloads": true,
"archived": false,
"disabled": false,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": false,
"push": false,
"pull": true
},
"allow_rebase_merge": true,
"template_repository": null,
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"allow_squash_merge": true,
"allow_auto_merge": false,
"delete_branch_on_merge": true,
"allow_merge_commit": true,
"subscribers_count": 42,
"network_count": 0
},
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"delete_branch_on_merge": true,
"subscribers_count": 42,
"network_count": 0,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://api.github.com/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA=="
},
"forks": 1,
"open_issues": 1,
"watchers": 1
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
number
required
repositories
array[object (Minimal Repository)]
required
Minimal Repository
object (Minimal Repository)
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
Set repository access for a self-hosted runner group in an organization
Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
selected_repository_ids
array[int]
required
List of repository IDs that can access the runner group.
int
Unique identifier of the repository.
org
string
required
The organization name. The name is not case sensitive.
runner_group_id
int
required
Unique identifier of the self-hosted runner group.
Request
{
"selected_repository_ids": [
32,
91
]
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Add repository access to a self-hosted runner group in an organization
Adds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see "Create a self-hosted runner group for an organization."
You must authenticate using an access token with the admin:org
scope to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
runner_group_id
int
required
Unique identifier of the self-hosted runner group.
repository_id
int
required
The unique identifier of the repository.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Remove repository access to a self-hosted runner group in an organization
Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see "Create a self-hosted runner group for an organization."
You must authenticate using an access token with the admin:org
scope to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
runner_group_id
int
required
Unique identifier of the self-hosted runner group.
repository_id
int
required
The unique identifier of the repository.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List self-hosted runners in a group for an organization
Lists self-hosted runners that are in a specific organization group.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
runner_group_id
int
required
Unique identifier of the self-hosted runner group.
Response
Response
{
"total_count": 2,
"runners": [
{
"id": 23,
"name": "linux_runner",
"os": "linux",
"status": "online",
"busy": true,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 11,
"name": "Linux",
"type": "read-only"
}
]
},
{
"id": 24,
"name": "mac_runner",
"os": "macos",
"status": "offline",
"busy": false,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
number
required
runners
array[object (Self hosted runners)]
required
Self hosted runners
object (Self hosted runners)
A self hosted runner
id
int
required
The id of the runner.
- Example
- 5
runner_group_id
int
The id of the runner group.
- Example
- 1
name
string
required
The name of the runner.
- Example
- "iMac"
os
string
required
The Operating System of the runner.
- Example
- "macos"
status
string
required
The status of the runner.
- Example
- "online"
busy
boolean
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Link
string
Set self-hosted runners in a group for an organization
Replaces the list of self-hosted runners that are part of an organization runner group.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
runners
array[int]
required
List of runner IDs to add to the runner group.
int
Unique identifier of the runner.
org
string
required
The organization name. The name is not case sensitive.
runner_group_id
int
required
Unique identifier of the self-hosted runner group.
Request
{
"runners": [
9,
2
]
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Add a self-hosted runner to a group for an organization
Adds a self-hosted runner to a runner group configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
runner_group_id
int
required
Unique identifier of the self-hosted runner group.
runner_id
int
required
Unique identifier of the self-hosted runner.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Remove a self-hosted runner from a group for an organization
Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
runner_group_id
int
required
Unique identifier of the self-hosted runner group.
runner_id
int
required
Unique identifier of the self-hosted runner.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List self-hosted runners for an organization
Lists all self-hosted runners configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"total_count": 2,
"runners": [
{
"id": 23,
"name": "linux_runner",
"os": "linux",
"status": "online",
"busy": true,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 11,
"name": "Linux",
"type": "read-only"
}
]
},
{
"id": 24,
"name": "mac_runner",
"os": "macos",
"status": "offline",
"busy": false,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
runners
array[object (Self hosted runners)]
required
Self hosted runners
object (Self hosted runners)
A self hosted runner
id
int
required
The id of the runner.
- Example
- 5
runner_group_id
int
The id of the runner group.
- Example
- 1
name
string
required
The name of the runner.
- Example
- "iMac"
os
string
required
The Operating System of the runner.
- Example
- "macos"
status
string
required
The status of the runner.
- Example
- "online"
busy
boolean
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Link
string
List runner applications for an organization
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
Response
Response
[
{
"os": "osx",
"architecture": "x64",
"download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz",
"filename": "actions-runner-osx-x64-2.277.1.tar.gz",
"temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA",
"sha256_checksum": "f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b"
},
{
"os": "linux",
"architecture": "x64",
"download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz",
"filename": "actions-runner-linux-x64-2.277.1.tar.gz",
"temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA",
"sha256_checksum": "02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98"
},
{
"os": "linux",
"architecture": "arm",
"download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz",
"filename": "actions-runner-linux-arm-2.277.1.tar.gz",
"temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw",
"sha256_checksum": "2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85"
},
{
"os": "win",
"architecture": "x64",
"download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip",
"filename": "actions-runner-win-x64-2.277.1.zip",
"temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA",
"sha256_checksum": "7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30"
},
{
"os": "linux",
"architecture": "arm64",
"download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz",
"filename": "actions-runner-linux-arm64-2.277.1.tar.gz",
"temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA",
"sha256_checksum": "a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64"
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
array[object (Runner Application)]
- Content Type
- application/json
Runner Application
object (Runner Application)
Runner Application
os
string
required
architecture
string
required
download_url
string
required
filename
string
required
temp_download_token
string
A short lived bearer token used to download the runner, if needed.
sha256_checksum
string
Create a registration token for an organization
Returns a token that you can pass to the config
script. The token expires after one hour.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
Example using registration token
Configure your self-hosted runner, replacing TOKEN
with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6",
"expires_at": "2020-01-22T12:13:35.123-08:00"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
token
string
required
The token used for authentication
- Example
- "v1.1f699f1069f60xxx"
expires_at
string
date-time
required
The time this token expires
- Example
- "2016-07-11T22:14:10Z"
permissions
object (permissions)
- Example
- { "issues": "read", "deployments": "write" }
repositories
array[object (Repository)]
The repositories this token has access to
Repository
object (Repository)
A repository on GitHub.
id
int
required
Unique identifier of the repository
- Example
- 42
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
The name of the repository.
- Example
- "Team Environment"
full_name
string
required
- Example
- "octocat/Hello-World"
license
object (license) or null
required
License Simple
key
string
required
- Example
- "mit"
name
string
required
- Example
- "MIT License"
url
string or null
uri
required
- Example
- "https://api.github.com/licenses/mit"
spdx_id
string or null
required
- Example
- "MIT"
node_id
string
required
- Example
- "MDc6TGljZW5zZW1pdA=="
html_url
string
uri
organization
object (organization) or null
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
forks
int
required
permissions
object (permissions)
admin
boolean
required
pull
boolean
required
triage
boolean
push
boolean
required
maintain
boolean
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
Whether the repository is private or public.
- Default
- false
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
required
- Example
- "git:github.com/octocat/Hello-World.git"
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
required
- Example
- "git@github.com:octocat/Hello-World.git"
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
required
- Example
- "https://github.com/octocat/Hello-World.git"
mirror_url
string or null
uri
required
- Example
- "git:git.example.com/octocat/Hello-World"
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
uri
required
- Example
- "https://svn.github.com/octocat/Hello-World"
homepage
string or null
uri
required
- Example
- "https://github.com"
language
string or null
required
forks_count
int
required
- Example
- 9
stargazers_count
int
required
- Example
- 80
watchers_count
int
required
- Example
- 80
size
int
required
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- Example
- 108
default_branch
string
required
The default branch of the repository.
- Example
- "master"
open_issues_count
int
required
- Example
- 0
is_template
boolean
Whether this repository acts as a template that can be used to generate new repositories.
- Default
- false
- Example
- true
topics
array[string]
string
has_issues
boolean
required
Whether issues are enabled.
- Default
- true
- Example
- true
has_projects
boolean
required
Whether projects are enabled.
- Default
- true
- Example
- true
has_wiki
boolean
required
Whether the wiki is enabled.
- Default
- true
- Example
- true
has_pages
boolean
required
has_downloads
boolean
required
Whether downloads are enabled.
- Default
- true
- Example
- true
has_discussions
boolean
Whether discussions are enabled.
- Default
- false
- Example
- true
archived
boolean
required
Whether the repository is archived.
- Default
- false
disabled
boolean
required
Returns whether or not this repository disabled.
visibility
string
The repository visibility: public, private, or internal.
- Default
- "public"
pushed_at
string or null
date-time
required
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
required
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
required
- Example
- "2011-01-26T19:14:43Z"
allow_rebase_merge
boolean
Whether to allow rebase merges for pull requests.
- Default
- true
- Example
- true
template_repository
object (template_repository) or null
id
int
node_id
string
name
string
full_name
string
owner
object (owner)
login
string
id
int
node_id
string
avatar_url
string
gravatar_id
string
url
string
html_url
string
followers_url
string
following_url
string
gists_url
string
starred_url
string
subscriptions_url
string
organizations_url
string
repos_url
string
events_url
string
received_events_url
string
type
string
site_admin
boolean
private
boolean
html_url
string
description
string
fork
boolean
url
string
archive_url
string
assignees_url
string
blobs_url
string
branches_url
string
collaborators_url
string
comments_url
string
commits_url
string
compare_url
string
contents_url
string
contributors_url
string
deployments_url
string
downloads_url
string
events_url
string
forks_url
string
git_commits_url
string
git_refs_url
string
git_tags_url
string
git_url
string
issue_comment_url
string
issue_events_url
string
issues_url
string
keys_url
string
labels_url
string
languages_url
string
merges_url
string
milestones_url
string
notifications_url
string
pulls_url
string
releases_url
string
ssh_url
string
stargazers_url
string
statuses_url
string
subscribers_url
string
subscription_url
string
tags_url
string
teams_url
string
trees_url
string
clone_url
string
mirror_url
string
hooks_url
string
svn_url
string
homepage
string
language
string
forks_count
int
stargazers_count
int
watchers_count
int
size
int
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string
created_at
string
updated_at
string
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
allow_rebase_merge
boolean
temp_clone_token
string
allow_squash_merge
boolean
allow_auto_merge
boolean
delete_branch_on_merge
boolean
allow_update_branch
boolean
use_squash_pr_title_as_default
boolean
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
subscribers_count
int
network_count
int
temp_clone_token
string
allow_squash_merge
boolean
Whether to allow squash merges for pull requests.
- Default
- true
- Example
- true
allow_auto_merge
boolean
Whether to allow Auto-merge to be used on pull requests.
- Default
- false
- Example
- false
delete_branch_on_merge
boolean
Whether to delete head branches when pull requests are merged
- Default
- false
- Example
- false
allow_update_branch
boolean
Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- Default
- false
- Example
- false
use_squash_pr_title_as_default
boolean
deprecated
Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title
instead.
- Default
- false
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
Whether to allow merge commits for pull requests.
- Default
- true
- Example
- true
allow_forking
boolean
Whether to allow forking this repo
web_commit_signoff_required
boolean
Whether to require contributors to sign off on web-based commits
- Default
- false
subscribers_count
int
network_count
int
open_issues
int
required
watchers
int
required
master_branch
string
starred_at
string
- Example
- "\"2020-07-09T00:17:42Z\""
anonymous_access_enabled
boolean
Whether anonymous git access is enabled for this repository
single_file
string or null
- Example
- "config.yaml"
repository_selection
string
Describe whether all repositories have been selected or there's a selection involved
- Enum
-
- all
- selected
Create a remove token for an organization
Returns a token that you can pass to the config
script to remove a self-hosted runner from an organization. The token expires after one hour.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
Example using remove token
To remove your self-hosted runner from an organization, replace TOKEN
with the remove token provided by this
endpoint.
./config.sh remove --token TOKEN
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6",
"expires_at": "2020-01-29T12:13:35.123-08:00"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
token
string
required
The token used for authentication
- Example
- "v1.1f699f1069f60xxx"
expires_at
string
date-time
required
The time this token expires
- Example
- "2016-07-11T22:14:10Z"
permissions
object (permissions)
- Example
- { "issues": "read", "deployments": "write" }
repositories
array[object (Repository)]
The repositories this token has access to
Repository
object (Repository)
A repository on GitHub.
id
int
required
Unique identifier of the repository
- Example
- 42
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
The name of the repository.
- Example
- "Team Environment"
full_name
string
required
- Example
- "octocat/Hello-World"
license
object (license) or null
required
License Simple
key
string
required
- Example
- "mit"
name
string
required
- Example
- "MIT License"
url
string or null
uri
required
- Example
- "https://api.github.com/licenses/mit"
spdx_id
string or null
required
- Example
- "MIT"
node_id
string
required
- Example
- "MDc6TGljZW5zZW1pdA=="
html_url
string
uri
organization
object (organization) or null
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
forks
int
required
permissions
object (permissions)
admin
boolean
required
pull
boolean
required
triage
boolean
push
boolean
required
maintain
boolean
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
Whether the repository is private or public.
- Default
- false
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
required
- Example
- "git:github.com/octocat/Hello-World.git"
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
required
- Example
- "git@github.com:octocat/Hello-World.git"
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
required
- Example
- "https://github.com/octocat/Hello-World.git"
mirror_url
string or null
uri
required
- Example
- "git:git.example.com/octocat/Hello-World"
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
uri
required
- Example
- "https://svn.github.com/octocat/Hello-World"
homepage
string or null
uri
required
- Example
- "https://github.com"
language
string or null
required
forks_count
int
required
- Example
- 9
stargazers_count
int
required
- Example
- 80
watchers_count
int
required
- Example
- 80
size
int
required
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- Example
- 108
default_branch
string
required
The default branch of the repository.
- Example
- "master"
open_issues_count
int
required
- Example
- 0
is_template
boolean
Whether this repository acts as a template that can be used to generate new repositories.
- Default
- false
- Example
- true
topics
array[string]
string
has_issues
boolean
required
Whether issues are enabled.
- Default
- true
- Example
- true
has_projects
boolean
required
Whether projects are enabled.
- Default
- true
- Example
- true
has_wiki
boolean
required
Whether the wiki is enabled.
- Default
- true
- Example
- true
has_pages
boolean
required
has_downloads
boolean
required
Whether downloads are enabled.
- Default
- true
- Example
- true
has_discussions
boolean
Whether discussions are enabled.
- Default
- false
- Example
- true
archived
boolean
required
Whether the repository is archived.
- Default
- false
disabled
boolean
required
Returns whether or not this repository disabled.
visibility
string
The repository visibility: public, private, or internal.
- Default
- "public"
pushed_at
string or null
date-time
required
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
required
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
required
- Example
- "2011-01-26T19:14:43Z"
allow_rebase_merge
boolean
Whether to allow rebase merges for pull requests.
- Default
- true
- Example
- true
template_repository
object (template_repository) or null
id
int
node_id
string
name
string
full_name
string
owner
object (owner)
login
string
id
int
node_id
string
avatar_url
string
gravatar_id
string
url
string
html_url
string
followers_url
string
following_url
string
gists_url
string
starred_url
string
subscriptions_url
string
organizations_url
string
repos_url
string
events_url
string
received_events_url
string
type
string
site_admin
boolean
private
boolean
html_url
string
description
string
fork
boolean
url
string
archive_url
string
assignees_url
string
blobs_url
string
branches_url
string
collaborators_url
string
comments_url
string
commits_url
string
compare_url
string
contents_url
string
contributors_url
string
deployments_url
string
downloads_url
string
events_url
string
forks_url
string
git_commits_url
string
git_refs_url
string
git_tags_url
string
git_url
string
issue_comment_url
string
issue_events_url
string
issues_url
string
keys_url
string
labels_url
string
languages_url
string
merges_url
string
milestones_url
string
notifications_url
string
pulls_url
string
releases_url
string
ssh_url
string
stargazers_url
string
statuses_url
string
subscribers_url
string
subscription_url
string
tags_url
string
teams_url
string
trees_url
string
clone_url
string
mirror_url
string
hooks_url
string
svn_url
string
homepage
string
language
string
forks_count
int
stargazers_count
int
watchers_count
int
size
int
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string
created_at
string
updated_at
string
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
allow_rebase_merge
boolean
temp_clone_token
string
allow_squash_merge
boolean
allow_auto_merge
boolean
delete_branch_on_merge
boolean
allow_update_branch
boolean
use_squash_pr_title_as_default
boolean
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
subscribers_count
int
network_count
int
temp_clone_token
string
allow_squash_merge
boolean
Whether to allow squash merges for pull requests.
- Default
- true
- Example
- true
allow_auto_merge
boolean
Whether to allow Auto-merge to be used on pull requests.
- Default
- false
- Example
- false
delete_branch_on_merge
boolean
Whether to delete head branches when pull requests are merged
- Default
- false
- Example
- false
allow_update_branch
boolean
Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- Default
- false
- Example
- false
use_squash_pr_title_as_default
boolean
deprecated
Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title
instead.
- Default
- false
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
Whether to allow merge commits for pull requests.
- Default
- true
- Example
- true
allow_forking
boolean
Whether to allow forking this repo
web_commit_signoff_required
boolean
Whether to require contributors to sign off on web-based commits
- Default
- false
subscribers_count
int
network_count
int
open_issues
int
required
watchers
int
required
master_branch
string
starred_at
string
- Example
- "\"2020-07-09T00:17:42Z\""
anonymous_access_enabled
boolean
Whether anonymous git access is enabled for this repository
single_file
string or null
- Example
- "config.yaml"
repository_selection
string
Describe whether all repositories have been selected or there's a selection involved
- Enum
-
- all
- selected
Get a self-hosted runner for an organization
Gets a specific self-hosted runner configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
Response
Response
{
"id": 23,
"name": "MBP",
"os": "macos",
"status": "online",
"busy": true,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
id
int
required
The id of the runner.
- Example
- 5
runner_group_id
int
The id of the runner group.
- Example
- 1
name
string
required
The name of the runner.
- Example
- "iMac"
os
string
required
The Operating System of the runner.
- Example
- "macos"
status
string
required
The status of the runner.
- Example
- "online"
busy
boolean
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Delete a self-hosted runner from an organization
Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List labels for a self-hosted runner for an organization
Lists all labels for a self-hosted runner configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
Response
Response
{
"total_count": 4,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
total_count
int
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Set custom labels for a self-hosted runner for an organization
Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
labels
array[string]
required
The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.
string
org
string
required
The organization name. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
Request
{
"labels": [
"gpu",
"accelerated"
]
}
Response
Response
{
"total_count": 4,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string
required
documentation_url
string
required
errors
array[string]
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
"string"
]
}
total_count
int
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Add custom labels to a self-hosted runner for an organization
Add custom labels to a self-hosted runner configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
labels
array[string]
required
The names of the custom labels to add to the runner.
string
org
string
required
The organization name. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
Request
{
"labels": [
"gpu",
"accelerated"
]
}
Response
Response
{
"total_count": 4,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string
required
documentation_url
string
required
errors
array[string]
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
"string"
]
}
total_count
int
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Remove all custom labels from a self-hosted runner for an organization
Remove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
Response
Response
{
"total_count": 3,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
total_count
int
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Remove a custom label from a self-hosted runner for an organization
Remove a custom label from a self-hosted runner configured in an organization. Returns the remaining labels from the runner.
This endpoint returns a 404 Not Found
status if the custom label is not
present on the runner.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
name
string
required
The name of a self-hosted runner's custom label.
Response
Response
{
"total_count": 4,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string
required
documentation_url
string
required
errors
array[string]
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
"string"
]
}
total_count
int
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
List organization secrets
Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"total_count": 3,
"secrets": [
{
"name": "GIST_ID",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z",
"visibility": "private"
},
{
"name": "DEPLOY_TOKEN",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z",
"visibility": "all"
},
{
"name": "GH_TOKEN",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z",
"visibility": "selected",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
secrets
array[object (Actions Secret for an Organization)]
required
Actions Secret for an Organization
object (Actions Secret for an Organization)
Secrets for GitHub Actions for an organization.
name
string
required
The name of the secret.
- Example
- "SECRET_TOKEN"
created_at
string
date-time
required
updated_at
string
date-time
required
visibility
string
required
Visibility of a secret
- Enum
-
- all
- private
- selected
selected_repositories_url
string
uri
- Example
- "https://api.github.com/organizations/org/secrets/my_secret/repositories"
Link
string
Get an organization public key
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"key_id": "012345678912345678",
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
key_id
string
required
The identifier for the key.
- Example
- "1234567"
key
string
required
The Base64 encoded public key.
- Example
- "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs="
id
int
- Example
- 2
url
string
- Example
- "https://api.github.com/user/keys/2"
title
string
- Example
- "ssh-rsa AAAAB3NzaC1yc2EAAA"
created_at
string
- Example
- "2011-01-26T19:01:12Z"
Get an organization secret
Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
secret_name
string
required
The name of the secret.
Response
Response
{
"name": "GH_TOKEN",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z",
"visibility": "selected",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
name
string
required
The name of the secret.
- Example
- "SECRET_TOKEN"
created_at
string
date-time
required
updated_at
string
date-time
required
visibility
string
required
Visibility of a secret
- Enum
-
- all
- private
- selected
selected_repositories_url
string
uri
- Example
- "https://api.github.com/organizations/org/secrets/my_secret/repositories"
Create or update an organization secret
Creates or updates an organization secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to
use this endpoint.
Example encrypting a secret using Node.js
Encrypt your secret using the libsodium-wrappers library.
const sodium = require('libsodium-wrappers')
const secret = 'plain-text-secret' // replace with the secret you want to encrypt
const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
//Check if libsodium is ready and then proceed.
sodium.ready.then(() => {
// Convert Secret & Base64 key to Uint8Array.
let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
let binsec = sodium.from_string(secret)
//Encrypt the secret using LibSodium
let encBytes = sodium.crypto_box_seal(binsec, binkey)
// Convert encrypted Uint8Array to Base64
let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
console.log(output)
});
Example encrypting a secret using Python
Encrypt your secret using pynacl with Python 3.
from base64 import b64encode
from nacl import encoding, public
def encrypt(public_key: str, secret_value: str) -> str:
"""Encrypt a Unicode string using the public key."""
public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
sealed_box = public.SealedBox(public_key)
encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
return b64encode(encrypted).decode("utf-8")
Example encrypting a secret using C#
Encrypt your secret using the Sodium.Core package.
var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
Example encrypting a secret using Ruby
Encrypt your secret using the rbnacl gem.
require "rbnacl"
require "base64"
key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)
box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")
# Print the base64 encoded secret
puts Base64.strict_encode64(encrypted_secret)
encrypted_value
string
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$
Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.
key_id
string
ID of the key you used to encrypt the secret.
visibility
string
required
Which type of organization repositories have access to the organization secret. selected
means only the repositories specified by selected_repository_ids
can access the secret.
- Enum
-
- all
- private
- selected
selected_repository_ids
array[int]
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility
is set to selected
. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
int
org
string
required
The organization name. The name is not case sensitive.
secret_name
string
required
The name of the secret.
Request
{
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678",
"visibility": "selected",
"selected_repository_ids": [
1296269,
1296280
]
}
Response
Response when creating a secret
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Response when updating a secret
Empty response
Delete an organization secret
Deletes a secret in an organization using the secret name. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
secret_name
string
required
The name of the secret.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List selected repositories for an organization secret
Lists all repositories that have been selected when the visibility
for repository access to a secret is set to selected
. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
page
int
Page number of the results to fetch.
- Default
- 1
per_page
int
The number of results per page (max 100).
- Default
- 30
org
string
required
The organization name. The name is not case sensitive.
secret_name
string
required
The name of the secret.
Response
Response
{
"total_count": 1,
"repositories": [
{
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
repositories
array[object (Minimal Repository)]
required
Minimal Repository
object (Minimal Repository)
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
Set selected repositories for an organization secret
Replaces all repositories for an organization secret when the visibility
for repository access is set to selected
. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
selected_repository_ids
array[int]
required
An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility
is set to selected
. You can add and remove individual repositories using the Add selected repository to an organization secret and Remove selected repository from an organization secret endpoints.
int
org
string
required
The organization name. The name is not case sensitive.
secret_name
string
required
The name of the secret.
Request
{
"selected_repository_ids": [
64780797
]
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Add selected repository to an organization secret
Adds a repository to an organization secret when the visibility
for repository access is set to selected
. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
secret_name
string
required
The name of the secret.
repository_id
int
required
Response
No Content when repository was added to the selected list
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Conflict when visibility type is not set to selected
Empty response
Remove selected repository from an organization secret
Removes a repository from an organization secret when the visibility
for repository access is set to selected
. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
secret_name
string
required
The name of the secret.
repository_id
int
required
Response
Response when repository was removed from the selected list
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Conflict when visibility type not set to selected
Empty response
List organization variables
Lists all organization variables. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read
organization permission to use this endpoint.
per_page
int
The number of results per page (max 30).
- Default
- 10
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
Response
Response
{
"total_count": 3,
"variables": [
{
"name": "USERNAME",
"value": "octocat",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z",
"visibility": "private"
},
{
"name": "ACTIONS_RUNNER_DEBUG",
"value": true,
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z",
"visibility": "all"
},
{
"name": "ADMIN_EMAIL",
"value": "octocat@github.com",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z",
"visibility": "selected",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
variables
array[object (Actions Variable for an Organization)]
required
Actions Variable for an Organization
object (Actions Variable for an Organization)
Organization variable for GitHub Actions.
name
string
required
The name of the variable.
- Example
- "USERNAME"
value
string
required
The value of the variable.
- Example
- "octocat"
created_at
string
date-time
required
The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
updated_at
string
date-time
required
The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
visibility
string
required
Visibility of a variable
- Enum
-
- all
- private
- selected
selected_repositories_url
string
uri
- Example
- "https://api.github.com/organizations/org/variables/USERNAME/repositories"
Link
string
Create an organization variable
Creates an organization variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub Apps must have the organization_actions_variables:write
organization permission to use this endpoint.
name
string
required
The name of the variable.
value
string
required
The value of the variable.
visibility
string
required
The type of repositories in the organization that can access the variable. selected
means only the repositories specified by selected_repository_ids
can access the variable.
- Enum
-
- all
- private
- selected
selected_repository_ids
array[int]
An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility
is set to selected
.
int
org
string
required
The organization name. The name is not case sensitive.
Request
{
"name": "USERNAME",
"value": "octocat",
"visibility": "selected",
"selected_repository_ids": [
1296269,
1296280
]
}
Response
Response when creating a variable
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get an organization variable
Gets a specific variable in an organization. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read
organization permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
name
string
required
The name of the variable.
Response
Response
{
"name": "USERNAME",
"value": "octocat",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z",
"visibility": "selected",
"selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
name
string
required
The name of the variable.
- Example
- "USERNAME"
value
string
required
The value of the variable.
- Example
- "octocat"
created_at
string
date-time
required
The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
updated_at
string
date-time
required
The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
visibility
string
required
Visibility of a variable
- Enum
-
- all
- private
- selected
selected_repositories_url
string
uri
- Example
- "https://api.github.com/organizations/org/variables/USERNAME/repositories"
Delete an organization variable
Deletes an organization variable using the variable name.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub Apps must have the organization_actions_variables:write
organization permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
name
string
required
The name of the variable.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Update an organization variable
Updates an organization variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub Apps must have the organization_actions_variables:write
organization permission to use this endpoint.
name
string
The name of the variable.
value
string
The value of the variable.
visibility
string
The type of repositories in the organization that can access the variable. selected
means only the repositories specified by selected_repository_ids
can access the variable.
- Enum
-
- all
- private
- selected
selected_repository_ids
array[int]
An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility
is set to selected
.
int
org
string
required
The organization name. The name is not case sensitive.
name
string
required
The name of the variable.
Request
{
"name": "USERNAME",
"value": "octocat",
"visibility": "selected",
"selected_repository_ids": [
1296269,
1296280
]
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List selected repositories for an organization variable
Lists all repositories that can access an organization variable that is available to selected repositories. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read
organization permission to use this endpoint.
page
int
Page number of the results to fetch.
- Default
- 1
per_page
int
The number of results per page (max 100).
- Default
- 30
org
string
required
The organization name. The name is not case sensitive.
name
string
required
The name of the variable.
Response
Response
{
"total_count": 1,
"repositories": [
{
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Response when the visibility of the variable is not set to selected
Empty response
total_count
int
required
repositories
array[object (Minimal Repository)]
required
Minimal Repository
object (Minimal Repository)
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
Set selected repositories for an organization variable
Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility
field set to selected
. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write
organization permission to use this endpoint.
selected_repository_ids
array[int]
required
The IDs of the repositories that can access the organization variable.
int
org
string
required
The organization name. The name is not case sensitive.
name
string
required
The name of the variable.
Request
{
"selected_repository_ids": [
64780797
]
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Response when the visibility of the variable is not set to selected
Empty response
Add selected repository to an organization variable
Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility
field set to selected
. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write
organization permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
name
string
required
The name of the variable.
repository_id
int
required
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Response when the visibility of the variable is not set to selected
Empty response
Remove selected repository from an organization variable
Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility
field set to selected
. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write
organization permission to use this endpoint.
org
string
required
The organization name. The name is not case sensitive.
name
string
required
The name of the variable.
repository_id
int
required
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Response when the visibility of the variable is not set to selected
Empty response
List repository required workflows
Lists the required workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint. For more information, see "Required Workflows."
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
org
string
required
The organization name. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"total_count": 1,
"required_workflows": [
{
"id": 161335,
"node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
"name": "RequiredCI",
"path": ".github/workflows/required_ci.yaml",
"state": "active",
"created_at": "2020-01-08T23:48:37.000-08:00",
"updated_at": "2020-01-08T23:50:21.000-08:00",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/required_workflows/161335",
"html_url": "https://github.com/octo-org/octo-repo/blob/master/octo-org/hello-world/.github/workflows/required_ci.yaml",
"badge_url": "https://github.com/octo-org/octo-repo/workflows/required/octo-org/hello-world/.github/workflows/required_ci.yaml/badge.svg",
"source_repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octo-org/Hello-World",
"owner": {
"login": "octo-org",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octo-org_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octo-org",
"html_url": "https://github.com/octo-org",
"followers_url": "https://api.github.com/users/octo-org/followers",
"following_url": "https://api.github.com/users/octo-org/following{/other_user}",
"gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
"organizations_url": "https://api.github.com/users/octo-org/orgs",
"repos_url": "https://api.github.com/users/octo-org/repos",
"events_url": "https://api.github.com/users/octo-org/events{/privacy}",
"received_events_url": "https://api.github.com/users/octo-org/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octo-org/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octo-org/Hello-World",
"archive_url": "https://api.github.com/repos/octo-org/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octo-org/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octo-org/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octo-org/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octo-org/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octo-org/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octo-org/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octo-org/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octo-org/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octo-org/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octo-org/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octo-org/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octo-org/Hello-World/events",
"forks_url": "https://api.github.com/repos/octo-org/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octo-org/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octo-org/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octo-org/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octo-org/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octo-org/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octo-org/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octo-org/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octo-org/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octo-org/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octo-org/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octo-org/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octo-org/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octo-org/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octo-org/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octo-org/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octo-org/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octo-org/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octo-org/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octo-org/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octo-org/Hello-World/hooks"
}
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
total_count
int
required
required_workflows
array[object (Required workflow)]
required
Required workflow
object (Required workflow)
A GitHub Actions required workflow
id
int
required
- Example
- 5
node_id
string
required
- Example
- "MDg6V29ya2Zsb3cxMg=="
name
string
required
- Example
- "Required CI"
path
string
required
- Example
- ".github/workflows/required_ci.yaml"
state
string
required
- Enum
-
- active
- deleted
- Example
- "active"
source_repository
object (source_repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
created_at
string
date-time
required
- Example
- "2019-12-06T14:20:20.000Z"
updated_at
string
date-time
required
- Example
- "2019-12-06T14:20:20.000Z"
url
string
required
- Example
- "https://api.github.com/repos/sample-org/sample-repo/actions/required_workflows/5"
html_url
string
required
- Example
- "https://github.com/sample-org/source-repo/blob/main/.github/workflows/required_ci.yaml"
badge_url
string
required
- Example
- "https://github.com/sample-org/sample-repo/workflows/required/sample-org/source-repo/.github/workflows/required_ci.yaml/badge.svg"
Get a required workflow entity for a repository
Gets a specific required workflow present in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint. For more information, see "Required Workflows."
org
string
required
The organization name. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
required_workflow_id_for_repo
int
required
The ID of the required workflow that has run at least once in a repository.
Response
Response
{
"id": 161335,
"node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
"name": "RequiredCI",
"path": ".github/workflows/required_ci.yaml",
"state": "active",
"created_at": "2020-01-08T23:48:37.000-08:00",
"updated_at": "2020-01-08T23:50:21.000-08:00",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/required_workflows/161335",
"html_url": "https://github.com/octo-org/octo-repo/blob/master/octo-org/hello-world/.github/workflows/required_ci.yaml",
"badge_url": "https://github.com/octo-org/octo-repo/workflows/required/octo-org/hello-world/.github/workflows/required_ci.yaml/badge.svg",
"source_repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octo-org/Hello-World",
"owner": {
"login": "octo-org",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octo-org_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octo-org",
"html_url": "https://github.com/octo-org",
"followers_url": "https://api.github.com/users/octo-org/followers",
"following_url": "https://api.github.com/users/octo-org/following{/other_user}",
"gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
"organizations_url": "https://api.github.com/users/octo-org/orgs",
"repos_url": "https://api.github.com/users/octo-org/repos",
"events_url": "https://api.github.com/users/octo-org/events{/privacy}",
"received_events_url": "https://api.github.com/users/octo-org/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octo-org/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octo-org/Hello-World",
"archive_url": "https://api.github.com/repos/octo-org/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octo-org/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octo-org/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octo-org/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octo-org/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octo-org/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octo-org/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octo-org/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octo-org/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octo-org/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octo-org/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octo-org/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octo-org/Hello-World/events",
"forks_url": "https://api.github.com/repos/octo-org/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octo-org/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octo-org/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octo-org/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octo-org/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octo-org/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octo-org/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octo-org/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octo-org/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octo-org/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octo-org/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octo-org/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octo-org/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octo-org/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octo-org/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octo-org/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octo-org/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octo-org/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octo-org/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octo-org/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octo-org/Hello-World/hooks"
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
id
int
required
- Example
- 5
node_id
string
required
- Example
- "MDg6V29ya2Zsb3cxMg=="
name
string
required
- Example
- "Required CI"
path
string
required
- Example
- ".github/workflows/required_ci.yaml"
state
string
required
- Enum
-
- active
- deleted
- Example
- "active"
source_repository
object (source_repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
created_at
string
date-time
required
- Example
- "2019-12-06T14:20:20.000Z"
updated_at
string
date-time
required
- Example
- "2019-12-06T14:20:20.000Z"
url
string
required
- Example
- "https://api.github.com/repos/sample-org/sample-repo/actions/required_workflows/5"
html_url
string
required
- Example
- "https://github.com/sample-org/source-repo/blob/main/.github/workflows/required_ci.yaml"
badge_url
string
required
- Example
- "https://github.com/sample-org/sample-repo/workflows/required/sample-org/source-repo/.github/workflows/required_ci.yaml/badge.svg"
List artifacts for a repository
Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
name
string
Filters artifacts by exact match on their name field.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"total_count": 2,
"artifacts": [
{
"id": 11,
"node_id": "MDg6QXJ0aWZhY3QxMQ==",
"name": "Rails",
"size_in_bytes": 556,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip",
"expired": false,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-03-21T14:59:22Z",
"updated_at": "2020-02-21T14:59:22Z",
"workflow_run": {
"id": 2332938,
"repository_id": 1296269,
"head_repository_id": 1296269,
"head_branch": "main",
"head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3"
}
},
{
"id": 13,
"node_id": "MDg6QXJ0aWZhY3QxMw==",
"name": "Test output",
"size_in_bytes": 453,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip",
"expired": false,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-03-21T14:59:22Z",
"updated_at": "2020-02-21T14:59:22Z",
"workflow_run": {
"id": 2332942,
"repository_id": 1296269,
"head_repository_id": 1296269,
"head_branch": "main",
"head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652"
}
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
artifacts
array[object (Artifact)]
required
Artifact
object (Artifact)
An artifact
id
int
required
- Example
- 5
node_id
string
required
- Example
- "MDEwOkNoZWNrU3VpdGU1"
name
string
required
The name of the artifact.
- Example
- "AdventureWorks.Framework"
size_in_bytes
int
required
The size in bytes of the artifact.
- Example
- 12345
url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/actions/artifacts/5"
archive_download_url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip"
expired
boolean
required
Whether or not the artifact has expired.
created_at
string or null
date-time
required
expires_at
string or null
date-time
required
updated_at
string or null
date-time
required
workflow_run
object (workflow_run) or null
id
int
- Example
- 10
repository_id
int
- Example
- 42
head_repository_id
int
- Example
- 42
head_branch
string
- Example
- "main"
head_sha
string
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
Link
string
Get an artifact
Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
artifact_id
int
required
The unique identifier of the artifact.
Response
Response
{
"id": 11,
"node_id": "MDg6QXJ0aWZhY3QxMQ==",
"name": "Rails",
"size_in_bytes": 556,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip",
"expired": false,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-01-21T14:59:22Z",
"updated_at": "2020-01-21T14:59:22Z",
"workflow_run": {
"id": 2332938,
"repository_id": 1296269,
"head_repository_id": 1296269,
"head_branch": "main",
"head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3"
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
id
int
required
- Example
- 5
node_id
string
required
- Example
- "MDEwOkNoZWNrU3VpdGU1"
name
string
required
The name of the artifact.
- Example
- "AdventureWorks.Framework"
size_in_bytes
int
required
The size in bytes of the artifact.
- Example
- 12345
url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/actions/artifacts/5"
archive_download_url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip"
expired
boolean
required
Whether or not the artifact has expired.
created_at
string or null
date-time
required
expires_at
string or null
date-time
required
updated_at
string or null
date-time
required
workflow_run
object (workflow_run) or null
id
int
- Example
- 10
repository_id
int
- Example
- 42
head_repository_id
int
- Example
- 42
head_branch
string
- Example
- "main"
head_sha
string
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
Delete an artifact
Deletes an artifact for a workflow run. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
artifact_id
int
required
The unique identifier of the artifact.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Download an artifact
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location:
in
the response header to find the URL for the download. The :archive_format
must be zip
. Anyone with read access to
the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope.
GitHub Apps must have the actions:read
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
artifact_id
int
required
The unique identifier of the artifact.
archive_format
string
required
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Location
string
message
string
documentation_url
string
url
string
status
string
Gone
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Get GitHub Actions cache usage for a repository
Gets GitHub Actions cache usage for a repository.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"full_name": "octo-org/Hello-World",
"active_caches_size_in_bytes": 2322142,
"active_caches_count": 3
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
full_name
string
required
The repository owner and name for the cache usage being shown.
- Example
- "octo-org/Hello-World"
active_caches_size_in_bytes
int
required
The sum of the size in bytes of all the active cache items in the repository.
- Example
- 2322142
active_caches_count
int
required
The number of active caches in the repository.
- Example
- 3
Get GitHub Actions cache usage policy for a repository
Gets GitHub Actions cache usage policy for a repository.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub Apps must have the actions:read
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"repo_cache_size_limit_in_gb": 14
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
repo_cache_size_limit_in_gb
int
required
The size limit for the sum of all caches, in gigabytes.
- Example
- 14
Set GitHub Actions cache usage policy for a repository
Sets GitHub Actions cache usage policy for a repository.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub Apps must have the actions:write
permission to use this endpoint.
repo_cache_size_limit_in_gb
int
required
The size limit for the sum of all caches, in gigabytes.
- Example
- 14
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Request
{
"repo_cache_size_limit_in_gb": 14
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List GitHub Actions caches for a repository
Lists the GitHub Actions caches for a repository.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub Apps must have the actions:read
permission to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
ref
string
The full Git reference for narrowing down the cache. The ref
for a branch should be formatted as refs/heads/<branch name>
. To reference a pull request use refs/pull/<number>/merge
.
key
string
An explicit key or prefix for identifying the cache
sort
string
The property to sort the results by. created_at
means when the cache was created. last_accessed_at
means when the cache was last accessed. size_in_bytes
is the size of the cache in bytes.
- Default
- "last_accessed_at"
- Enum
-
- created_at
- last_accessed_at
- size_in_bytes
direction
string
The direction to sort the results by.
- Default
- "desc"
- Enum
-
- asc
- desc
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"total_count": 1,
"actions_caches": [
{
"id": 505,
"ref": "refs/heads/main",
"key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b",
"version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0",
"last_accessed_at": "2019-01-24T22:45:36.000Z",
"created_at": "2019-01-24T22:45:36.000Z",
"size_in_bytes": 1024
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
Total number of caches
- Example
- 2
actions_caches
array[object]
required
Array of caches
object
id
int
- Example
- 2
ref
string
- Example
- "refs/heads/main"
key
string
- Example
- "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b"
version
string
- Example
- "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0"
last_accessed_at
string
date-time
- Example
- "2019-01-24T22:45:36.000Z"
created_at
string
date-time
- Example
- "2019-01-24T22:45:36.000Z"
size_in_bytes
int
- Example
- 1024
Link
string
Delete GitHub Actions caches for a repository (using a cache key)
Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub Apps must have the actions:write
permission to use this endpoint.
key
string
required
A key for identifying the cache.
ref
string
The full Git reference for narrowing down the cache. The ref
for a branch should be formatted as refs/heads/<branch name>
. To reference a pull request use refs/pull/<number>/merge
.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"total_count": 1,
"actions_caches": [
{
"id": 505,
"ref": "refs/heads/main",
"key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b",
"version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0",
"last_accessed_at": "2019-01-24T22:45:36.000Z",
"created_at": "2019-01-24T22:45:36.000Z",
"size_in_bytes": 1024
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
Total number of caches
- Example
- 2
actions_caches
array[object]
required
Array of caches
object
id
int
- Example
- 2
ref
string
- Example
- "refs/heads/main"
key
string
- Example
- "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b"
version
string
- Example
- "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0"
last_accessed_at
string
date-time
- Example
- "2019-01-24T22:45:36.000Z"
created_at
string
date-time
- Example
- "2019-01-24T22:45:36.000Z"
size_in_bytes
int
- Example
- 1024
Delete a GitHub Actions cache for a repository (using a cache ID)
Deletes a GitHub Actions cache for a repository, using a cache ID.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub Apps must have the actions:write
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
cache_id
int
required
The unique identifier of the GitHub Actions cache.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get a job for a workflow run
Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
job_id
int
required
The unique identifier of the job.
Response
Response
{
"id": 399444496,
"run_id": 29679449,
"run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449",
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
"status": "completed",
"conclusion": "success",
"started_at": "2020-01-20T17:42:40Z",
"completed_at": "2020-01-20T17:44:39Z",
"name": "build",
"steps": [
{
"name": "Set up job",
"status": "completed",
"conclusion": "success",
"number": 1,
"started_at": "2020-01-20T09:42:40.000-08:00",
"completed_at": "2020-01-20T09:42:41.000-08:00"
},
{
"name": "Run actions/checkout@v2",
"status": "completed",
"conclusion": "success",
"number": 2,
"started_at": "2020-01-20T09:42:41.000-08:00",
"completed_at": "2020-01-20T09:42:45.000-08:00"
},
{
"name": "Set up Ruby",
"status": "completed",
"conclusion": "success",
"number": 3,
"started_at": "2020-01-20T09:42:45.000-08:00",
"completed_at": "2020-01-20T09:42:45.000-08:00"
},
{
"name": "Run actions/cache@v3",
"status": "completed",
"conclusion": "success",
"number": 4,
"started_at": "2020-01-20T09:42:45.000-08:00",
"completed_at": "2020-01-20T09:42:48.000-08:00"
},
{
"name": "Install Bundler",
"status": "completed",
"conclusion": "success",
"number": 5,
"started_at": "2020-01-20T09:42:48.000-08:00",
"completed_at": "2020-01-20T09:42:52.000-08:00"
},
{
"name": "Install Gems",
"status": "completed",
"conclusion": "success",
"number": 6,
"started_at": "2020-01-20T09:42:52.000-08:00",
"completed_at": "2020-01-20T09:42:53.000-08:00"
},
{
"name": "Run Tests",
"status": "completed",
"conclusion": "success",
"number": 7,
"started_at": "2020-01-20T09:42:53.000-08:00",
"completed_at": "2020-01-20T09:42:59.000-08:00"
},
{
"name": "Deploy to Heroku",
"status": "completed",
"conclusion": "success",
"number": 8,
"started_at": "2020-01-20T09:42:59.000-08:00",
"completed_at": "2020-01-20T09:44:39.000-08:00"
},
{
"name": "Post actions/cache@v3",
"status": "completed",
"conclusion": "success",
"number": 16,
"started_at": "2020-01-20T09:44:39.000-08:00",
"completed_at": "2020-01-20T09:44:39.000-08:00"
},
{
"name": "Complete job",
"status": "completed",
"conclusion": "success",
"number": 17,
"started_at": "2020-01-20T09:44:39.000-08:00",
"completed_at": "2020-01-20T09:44:39.000-08:00"
}
],
"check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496",
"labels": [
"self-hosted",
"foo",
"bar"
],
"runner_id": 1,
"runner_name": "my runner",
"runner_group_id": 2,
"runner_group_name": "my runner group",
"workflow_name": "CI",
"head_branch": "main"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
id
int
required
The id of the job.
- Example
- 21
run_id
int
required
The id of the associated workflow run.
- Example
- 5
run_url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5"
run_attempt
int
Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.
- Example
- 1
node_id
string
required
- Example
- "MDg6Q2hlY2tSdW40"
head_sha
string
required
The SHA of the commit that is being run.
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/actions/jobs/21"
html_url
string or null
required
- Example
- "https://github.com/github/hello-world/runs/4"
status
string
required
The phase of the lifecycle that the job is currently in.
- Enum
-
- queued
- in_progress
- completed
- Example
- "queued"
conclusion
string or null
required
The outcome of the job.
- Enum
-
- success
- failure
- neutral
- cancelled
- skipped
- timed_out
- action_required
- Example
- "success"
created_at
string
date-time
required
The time that the job created, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
started_at
string
date-time
required
The time that the job started, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
completed_at
string or null
date-time
required
The time that the job finished, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
name
string
required
The name of the job.
- Example
- "test-coverage"
steps
array[object]
Steps in this job.
object
status
string
required
The phase of the lifecycle that the job is currently in.
- Enum
-
- queued
- in_progress
- completed
- Example
- "queued"
conclusion
string or null
required
The outcome of the job.
- Example
- "success"
name
string
required
The name of the job.
- Example
- "test-coverage"
number
int
required
- Example
- 1
started_at
string or null
date-time
The time that the step started, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
completed_at
string or null
date-time
The time that the job finished, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
check_run_url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/check-runs/4"
labels
array[string]
required
Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file.
- Example
- [ "self-hosted", "foo", "bar" ]
string
runner_id
int or null
required
The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- Example
- 1
runner_name
string or null
required
The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- Example
- "my runner"
runner_group_id
int or null
required
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.)
- Example
- 2
runner_group_name
string or null
required
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.)
- Example
- "my runner group"
workflow_name
string or null
required
The name of the workflow.
- Example
- "Build"
head_branch
string or null
required
The name of the current branch.
- Example
- "main"
Download job logs for a workflow run
Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
for Location:
in the response header to find the URL for the download. Anyone with read access to the repository can
use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must
have the actions:read
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
job_id
int
required
The unique identifier of the job.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Location
string
Re-run a job from a workflow run
Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
enable_debug_logging
boolean
Whether to enable debug logging for the re-run.
- Default
- false
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
job_id
int
required
The unique identifier of the job.
Request
null
Response
Response
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
Forbidden
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Get the customization template for an OIDC subject claim for a repository
Gets the customization template for an OpenID Connect (OIDC) subject claim.
You must authenticate using an access token with the repo
scope to use this
endpoint. GitHub Apps must have the organization_administration:read
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Status response
{
"use_default": false,
"include_claim_keys": [
"repo",
"context"
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
message
string or null
documentation_url
string or null
detail
string or null
status
int
scimType
string or null
schemas
array[string]
string
Bad Request
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
use_default
boolean
required
Whether to use the default template or not. If true
, the include_claim_keys
field is ignored.
include_claim_keys
array[string]
Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.
string
Set the customization template for an OIDC subject claim for a repository
Sets the customization template and opt-in
or opt-out
flag for an OpenID Connect (OIDC) subject claim for a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
use_default
boolean
required
Whether to use the default template or not. If true
, the include_claim_keys
field is ignored.
include_claim_keys
array[string]
Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.
string
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Request
{
"use_default": false,
"include_claim_keys": [
"repo",
"context"
]
}
Response
Empty response
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
message
string or null
documentation_url
string or null
detail
string or null
status
int
scimType
string or null
schemas
array[string]
string
message
string
required
documentation_url
string
required
errors
array[string]
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Bad Request
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
"string"
]
}
List repository organization secrets
Lists all organization secrets shared with a repository without revealing their encrypted values. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"total_count": 2,
"secrets": [
{
"name": "GH_TOKEN",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z"
},
{
"name": "GIST_ID",
"created_at": "2020-01-10T10:59:22Z",
"updated_at": "2020-01-11T11:59:22Z"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
secrets
array[object (Actions Secret)]
required
Actions Secret
object (Actions Secret)
Set secrets for GitHub Actions.
name
string
required
The name of the secret.
- Example
- "SECRET_TOKEN"
created_at
string
date-time
required
updated_at
string
date-time
required
Link
string
List repository organization variables
Lists all organiation variables shared with a repository. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions_variables:read
repository permission to use this endpoint.
per_page
int
The number of results per page (max 30).
- Default
- 10
page
int
Page number of the results to fetch.
- Default
- 1
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"total_count": 2,
"variables": [
{
"name": "USERNAME",
"value": "octocat",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z"
},
{
"name": "EMAIL",
"value": "octocat@github.com",
"created_at": "2020-01-10T10:59:22Z",
"updated_at": "2020-01-11T11:59:22Z"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
variables
array[object (Actions Variable)]
required
Actions Variable
object (Actions Variable)
name
string
required
The name of the variable.
- Example
- "USERNAME"
value
string
required
The value of the variable.
- Example
- "octocat"
created_at
string
date-time
required
The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
updated_at
string
date-time
required
The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
Link
string
Get GitHub Actions permissions for a repository
Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration
repository permission to use this API.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"enabled": true,
"allowed_actions": "selected",
"selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
enabled
boolean
required
Whether GitHub Actions is enabled on the repository.
allowed_actions
string
The permissions policy that controls the actions that are allowed to run.
- Enum
-
- all
- local_only
- selected
selected_actions_url
string
The API URL to use to get or set the actions that are allowed to run, when allowed_actions
is set to selected
.
Set GitHub Actions permissions for a repository
Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.
If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions
to selected
actions, then you cannot override them for the repository.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration
repository permission to use this API.
enabled
boolean
required
Whether GitHub Actions is enabled on the repository.
allowed_actions
string
The permissions policy that controls the actions that are allowed to run.
- Enum
-
- all
- local_only
- selected
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Request
{
"enabled": true,
"allowed_actions": "selected"
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get the level of access for workflows outside of the repository
Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. For more information, see "Allowing access to components in a private repository" and "Allowing access to components in an internal repository."
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the
repository administration
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"access_level": "organization"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
access_level
string
required
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 repos only. organization
level access allows sharing across the organization. enterprise
level access allows sharing across the enterprise.
- Enum
-
- none
- user
- organization
- enterprise
Set the level of access for workflows outside of the repository
Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. For more information, see "Allowing access to components in a private repository" and "Allowing access to components in an internal repository."
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the
repository administration
permission to use this endpoint.
access_level
string
required
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 repos only. organization
level access allows sharing across the organization. enterprise
level access allows sharing across the enterprise.
- Enum
-
- none
- user
- organization
- enterprise
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Request
{
"access_level": "organization"
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get allowed actions for a repository
Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions
must be configured to selected
. For more information, see "Set GitHub Actions permissions for a repository."
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration
repository permission to use this API.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"github_owned_allowed": true,
"verified_allowed": false,
"patterns_allowed": [
"monalisa/octocat@*",
"docker/*"
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
github_owned_allowed
boolean
required
Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions
organization.
patterns_allowed
array[string]
required
Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*
, monalisa/octocat@v2
, monalisa/*
.
string
Set allowed actions for a repository
Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions
must be configured to selected
. For more information, see "Set GitHub Actions permissions for a repository."
If the repository belongs to an organization or enterprise that has selected
actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.
To use the patterns_allowed
setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed
setting only applies to public repositories.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration
repository permission to use this API.
github_owned_allowed
boolean
required
Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions
organization.
patterns_allowed
array[string]
required
Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*
, monalisa/octocat@v2
, monalisa/*
.
string
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Request
{
"github_owned_allowed": true,
"verified_allowed": false,
"patterns_allowed": [
"monalisa/octocat@*",
"docker/*"
]
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get default workflow permissions for a repository
Gets the default workflow permissions granted to the GITHUB_TOKEN
when running workflows in a repository,
as well as if GitHub Actions can submit approving pull request reviews.
For more information, see "Setting the permissions of the GITHUB_TOKEN for your repository."
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the repository administration
permission to use this API.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"default_workflow_permissions": "read",
"can_approve_pull_request_reviews": true
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
default_workflow_permissions
string
required
The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
- Enum
-
- read
- write
can_approve_pull_request_reviews
boolean
required
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
Set default workflow permissions for a repository
Sets the default workflow permissions granted to the GITHUB_TOKEN
when running workflows in a repository, and sets if GitHub Actions
can submit approving pull request reviews.
For more information, see "Setting the permissions of the GITHUB_TOKEN for your repository."
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the repository administration
permission to use this API.
default_workflow_permissions
string
The default workflow permissions granted to the GITHUB_TOKEN when running workflows.
- Enum
-
- read
- write
can_approve_pull_request_reviews
boolean
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Request
{
"default_workflow_permissions": "read",
"can_approve_pull_request_reviews": true
}
Response
Success response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Conflict response when changing a setting is prevented by the owning organization or enterprise
Empty response
List workflow runs for a required workflow
List all workflow runs for a required workflow. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. For more information, see "Required Workflows."
actor
string
Returns someone's workflow runs. Use the login for the user who created the push
associated with the check suite or workflow run.
branch
string
Returns workflow runs associated with a branch. Use the name of the branch of the push
.
event
string
Returns workflow run triggered by the event you specify. For example, push
, pull_request
or issue
. For more information, see "Events that trigger workflows."
status
string
Returns workflow runs with the check run status
or conclusion
that you specify. For example, a conclusion can be success
or a status can be in_progress
. Only GitHub can set a status of waiting
or requested
.
- Enum
-
- completed
- action_required
- cancelled
- failure
- neutral
- skipped
- stale
- success
- timed_out
- in_progress
- queued
- requested
- waiting
- pending
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
created
string
date-time
Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."
exclude_pull_requests
boolean
If true
pull requests are omitted from the response (empty array).
- Default
- false
check_suite_id
int
Returns workflow runs with the check_suite_id
that you specify.
head_sha
string
Only returns workflow runs that are associated with the specified head_sha
.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
required_workflow_id_for_repo
int
required
The ID of the required workflow that has run at least once in a repository.
Response
Response
{
"total_count": 1,
"workflow_runs": [
{
"id": 30433642,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": null,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com"
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com"
}
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": true,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": null,
"fork": false,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments"
}
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
workflow_runs
array[object (Workflow Run)]
required
Workflow Run
object (Workflow Run)
An invocation of a workflow
id
int
required
The ID of the workflow run.
- Example
- 5
name
string or null
The name of the workflow run.
- Example
- "Build"
node_id
string
required
- Example
- "MDEwOkNoZWNrU3VpdGU1"
check_suite_id
int
The ID of the associated check suite.
- Example
- 42
check_suite_node_id
string
The node ID of the associated check suite.
- Example
- "MDEwOkNoZWNrU3VpdGU0Mg=="
head_branch
string or null
required
- Example
- "master"
head_sha
string
required
The SHA of the head commit that points to the version of the workflow being run.
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
path
string
required
The full path of the workflow
- Example
- "octocat/octo-repo/.github/workflows/ci.yml@main"
run_number
int
required
The auto incrementing run number for the workflow run.
- Example
- 106
run_attempt
int
Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.
- Example
- 1
referenced_workflows
array[object (Referenced workflow)] or null
Referenced workflow
object (Referenced workflow)
A workflow referenced/reused by the initial caller workflow
path
string
required
sha
string
required
ref
string
event
string
required
- Example
- "push"
status
string or null
required
- Example
- "completed"
conclusion
string or null
required
- Example
- "neutral"
workflow_id
int
required
The ID of the parent workflow.
- Example
- 5
url
string
required
The URL to the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5"
html_url
string
required
- Example
- "https://github.com/github/hello-world/suites/4"
pull_requests
array[object (Pull Request Minimal)] or null
required
Pull Request Minimal
object (Pull Request Minimal)
id
int
required
number
int
required
url
string
required
head
object (head)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
base
object (base)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
created_at
string
date-time
required
updated_at
string
date-time
required
actor
object (actor)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
triggering_actor
object (triggering_actor)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
run_started_at
string
date-time
The start time of the latest run. Resets on re-run.
jobs_url
string
required
The URL to the jobs for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs"
logs_url
string
required
The URL to download the logs for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/logs"
check_suite_url
string
required
The URL to the associated check suite.
- Example
- "https://api.github.com/repos/github/hello-world/check-suites/12"
artifacts_url
string
required
The URL to the artifacts for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts"
cancel_url
string
required
The URL to cancel the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel"
rerun_url
string
required
The URL to rerun the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun"
previous_attempt_url
string or null
The URL to the previous attempted run of this workflow, if one exists.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3"
workflow_url
string
required
The URL to the workflow.
- Example
- "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml"
head_commit
object (head_commit) or null
required
A commit.
id
string
required
SHA for the commit
- Example
- "7638417db6d59f3c431d3e1f261cc637155684cd"
tree_id
string
required
SHA for the commit's tree
message
string
required
Message describing the purpose of the commit
- Example
- "Fix #42"
timestamp
string
date-time
required
Timestamp of the commit
- Example
- "2014-08-09T08:02:04+12:00"
author
object (author) or null
required
Information about the Git author
name
string
required
Name of the commit's author
- Example
- "Monalisa Octocat"
string
required
Git email address of the commit's author
- Example
- "monalisa.octocat@example.com"
committer
object (committer) or null
required
Information about the Git committer
name
string
required
Name of the commit's committer
- Example
- "Monalisa Octocat"
string
required
Git email address of the commit's committer
- Example
- "monalisa.octocat@example.com"
repository
object (repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
head_repository
object (head_repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
head_repository_id
int
- Example
- 5
display_title
string
required
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.
- Example
- "Simple Workflow"
Link
string
List self-hosted runners for a repository
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo
scope to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"total_count": 2,
"runners": [
{
"id": 23,
"name": "linux_runner",
"os": "linux",
"status": "online",
"busy": true,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 11,
"name": "Linux",
"type": "read-only"
}
]
},
{
"id": 24,
"name": "mac_runner",
"os": "macos",
"status": "offline",
"busy": false,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
runners
array[object (Self hosted runners)]
required
Self hosted runners
object (Self hosted runners)
A self hosted runner
id
int
required
The id of the runner.
- Example
- 5
runner_group_id
int
The id of the runner group.
- Example
- 1
name
string
required
The name of the runner.
- Example
- "iMac"
os
string
required
The Operating System of the runner.
- Example
- "macos"
status
string
required
The status of the runner.
- Example
- "online"
busy
boolean
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Link
string
List runner applications for a repository
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the repo
scope to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
[
{
"os": "osx",
"architecture": "x64",
"download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz",
"filename": "actions-runner-osx-x64-2.277.1.tar.gz",
"temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA",
"sha256_checksum": "f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b"
},
{
"os": "linux",
"architecture": "x64",
"download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz",
"filename": "actions-runner-linux-x64-2.277.1.tar.gz",
"temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA",
"sha256_checksum": "02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98"
},
{
"os": "linux",
"architecture": "arm",
"download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz",
"filename": "actions-runner-linux-arm-2.277.1.tar.gz",
"temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw",
"sha256_checksum": "2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85"
},
{
"os": "win",
"architecture": "x64",
"download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip",
"filename": "actions-runner-win-x64-2.277.1.zip",
"temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA",
"sha256_checksum": "7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30"
},
{
"os": "linux",
"architecture": "arm64",
"download_url": "https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz",
"filename": "actions-runner-linux-arm64-2.277.1.tar.gz",
"temp_download_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA",
"sha256_checksum": "a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64"
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
array[object (Runner Application)]
- Content Type
- application/json
Runner Application
object (Runner Application)
Runner Application
os
string
required
architecture
string
required
download_url
string
required
filename
string
required
temp_download_token
string
A short lived bearer token used to download the runner, if needed.
sha256_checksum
string
Create a registration token for a repository
Returns a token that you can pass to the config
script. The token expires after one hour. You must authenticate
using an access token with the repo
scope to use this endpoint.
Example using registration token
Configure your self-hosted runner, replacing TOKEN
with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6",
"expires_at": "2020-01-22T12:13:35.123-08:00"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
token
string
required
The token used for authentication
- Example
- "v1.1f699f1069f60xxx"
expires_at
string
date-time
required
The time this token expires
- Example
- "2016-07-11T22:14:10Z"
permissions
object (permissions)
- Example
- { "issues": "read", "deployments": "write" }
repositories
array[object (Repository)]
The repositories this token has access to
Repository
object (Repository)
A repository on GitHub.
id
int
required
Unique identifier of the repository
- Example
- 42
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
The name of the repository.
- Example
- "Team Environment"
full_name
string
required
- Example
- "octocat/Hello-World"
license
object (license) or null
required
License Simple
key
string
required
- Example
- "mit"
name
string
required
- Example
- "MIT License"
url
string or null
uri
required
- Example
- "https://api.github.com/licenses/mit"
spdx_id
string or null
required
- Example
- "MIT"
node_id
string
required
- Example
- "MDc6TGljZW5zZW1pdA=="
html_url
string
uri
organization
object (organization) or null
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
forks
int
required
permissions
object (permissions)
admin
boolean
required
pull
boolean
required
triage
boolean
push
boolean
required
maintain
boolean
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
Whether the repository is private or public.
- Default
- false
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
required
- Example
- "git:github.com/octocat/Hello-World.git"
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
required
- Example
- "git@github.com:octocat/Hello-World.git"
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
required
- Example
- "https://github.com/octocat/Hello-World.git"
mirror_url
string or null
uri
required
- Example
- "git:git.example.com/octocat/Hello-World"
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
uri
required
- Example
- "https://svn.github.com/octocat/Hello-World"
homepage
string or null
uri
required
- Example
- "https://github.com"
language
string or null
required
forks_count
int
required
- Example
- 9
stargazers_count
int
required
- Example
- 80
watchers_count
int
required
- Example
- 80
size
int
required
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- Example
- 108
default_branch
string
required
The default branch of the repository.
- Example
- "master"
open_issues_count
int
required
- Example
- 0
is_template
boolean
Whether this repository acts as a template that can be used to generate new repositories.
- Default
- false
- Example
- true
topics
array[string]
string
has_issues
boolean
required
Whether issues are enabled.
- Default
- true
- Example
- true
has_projects
boolean
required
Whether projects are enabled.
- Default
- true
- Example
- true
has_wiki
boolean
required
Whether the wiki is enabled.
- Default
- true
- Example
- true
has_pages
boolean
required
has_downloads
boolean
required
Whether downloads are enabled.
- Default
- true
- Example
- true
has_discussions
boolean
Whether discussions are enabled.
- Default
- false
- Example
- true
archived
boolean
required
Whether the repository is archived.
- Default
- false
disabled
boolean
required
Returns whether or not this repository disabled.
visibility
string
The repository visibility: public, private, or internal.
- Default
- "public"
pushed_at
string or null
date-time
required
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
required
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
required
- Example
- "2011-01-26T19:14:43Z"
allow_rebase_merge
boolean
Whether to allow rebase merges for pull requests.
- Default
- true
- Example
- true
template_repository
object (template_repository) or null
id
int
node_id
string
name
string
full_name
string
owner
object (owner)
login
string
id
int
node_id
string
avatar_url
string
gravatar_id
string
url
string
html_url
string
followers_url
string
following_url
string
gists_url
string
starred_url
string
subscriptions_url
string
organizations_url
string
repos_url
string
events_url
string
received_events_url
string
type
string
site_admin
boolean
private
boolean
html_url
string
description
string
fork
boolean
url
string
archive_url
string
assignees_url
string
blobs_url
string
branches_url
string
collaborators_url
string
comments_url
string
commits_url
string
compare_url
string
contents_url
string
contributors_url
string
deployments_url
string
downloads_url
string
events_url
string
forks_url
string
git_commits_url
string
git_refs_url
string
git_tags_url
string
git_url
string
issue_comment_url
string
issue_events_url
string
issues_url
string
keys_url
string
labels_url
string
languages_url
string
merges_url
string
milestones_url
string
notifications_url
string
pulls_url
string
releases_url
string
ssh_url
string
stargazers_url
string
statuses_url
string
subscribers_url
string
subscription_url
string
tags_url
string
teams_url
string
trees_url
string
clone_url
string
mirror_url
string
hooks_url
string
svn_url
string
homepage
string
language
string
forks_count
int
stargazers_count
int
watchers_count
int
size
int
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string
created_at
string
updated_at
string
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
allow_rebase_merge
boolean
temp_clone_token
string
allow_squash_merge
boolean
allow_auto_merge
boolean
delete_branch_on_merge
boolean
allow_update_branch
boolean
use_squash_pr_title_as_default
boolean
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
subscribers_count
int
network_count
int
temp_clone_token
string
allow_squash_merge
boolean
Whether to allow squash merges for pull requests.
- Default
- true
- Example
- true
allow_auto_merge
boolean
Whether to allow Auto-merge to be used on pull requests.
- Default
- false
- Example
- false
delete_branch_on_merge
boolean
Whether to delete head branches when pull requests are merged
- Default
- false
- Example
- false
allow_update_branch
boolean
Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- Default
- false
- Example
- false
use_squash_pr_title_as_default
boolean
deprecated
Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title
instead.
- Default
- false
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
Whether to allow merge commits for pull requests.
- Default
- true
- Example
- true
allow_forking
boolean
Whether to allow forking this repo
web_commit_signoff_required
boolean
Whether to require contributors to sign off on web-based commits
- Default
- false
subscribers_count
int
network_count
int
open_issues
int
required
watchers
int
required
master_branch
string
starred_at
string
- Example
- "\"2020-07-09T00:17:42Z\""
anonymous_access_enabled
boolean
Whether anonymous git access is enabled for this repository
single_file
string or null
- Example
- "config.yaml"
repository_selection
string
Describe whether all repositories have been selected or there's a selection involved
- Enum
-
- all
- selected
Create a remove token for a repository
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.
Example using remove token
To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
./config.sh remove --token TOKEN
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6",
"expires_at": "2020-01-29T12:13:35.123-08:00"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
token
string
required
The token used for authentication
- Example
- "v1.1f699f1069f60xxx"
expires_at
string
date-time
required
The time this token expires
- Example
- "2016-07-11T22:14:10Z"
permissions
object (permissions)
- Example
- { "issues": "read", "deployments": "write" }
repositories
array[object (Repository)]
The repositories this token has access to
Repository
object (Repository)
A repository on GitHub.
id
int
required
Unique identifier of the repository
- Example
- 42
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
The name of the repository.
- Example
- "Team Environment"
full_name
string
required
- Example
- "octocat/Hello-World"
license
object (license) or null
required
License Simple
key
string
required
- Example
- "mit"
name
string
required
- Example
- "MIT License"
url
string or null
uri
required
- Example
- "https://api.github.com/licenses/mit"
spdx_id
string or null
required
- Example
- "MIT"
node_id
string
required
- Example
- "MDc6TGljZW5zZW1pdA=="
html_url
string
uri
organization
object (organization) or null
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
forks
int
required
permissions
object (permissions)
admin
boolean
required
pull
boolean
required
triage
boolean
push
boolean
required
maintain
boolean
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
Whether the repository is private or public.
- Default
- false
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
required
- Example
- "git:github.com/octocat/Hello-World.git"
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
required
- Example
- "git@github.com:octocat/Hello-World.git"
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
required
- Example
- "https://github.com/octocat/Hello-World.git"
mirror_url
string or null
uri
required
- Example
- "git:git.example.com/octocat/Hello-World"
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
uri
required
- Example
- "https://svn.github.com/octocat/Hello-World"
homepage
string or null
uri
required
- Example
- "https://github.com"
language
string or null
required
forks_count
int
required
- Example
- 9
stargazers_count
int
required
- Example
- 80
watchers_count
int
required
- Example
- 80
size
int
required
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
- Example
- 108
default_branch
string
required
The default branch of the repository.
- Example
- "master"
open_issues_count
int
required
- Example
- 0
is_template
boolean
Whether this repository acts as a template that can be used to generate new repositories.
- Default
- false
- Example
- true
topics
array[string]
string
has_issues
boolean
required
Whether issues are enabled.
- Default
- true
- Example
- true
has_projects
boolean
required
Whether projects are enabled.
- Default
- true
- Example
- true
has_wiki
boolean
required
Whether the wiki is enabled.
- Default
- true
- Example
- true
has_pages
boolean
required
has_downloads
boolean
required
Whether downloads are enabled.
- Default
- true
- Example
- true
has_discussions
boolean
Whether discussions are enabled.
- Default
- false
- Example
- true
archived
boolean
required
Whether the repository is archived.
- Default
- false
disabled
boolean
required
Returns whether or not this repository disabled.
visibility
string
The repository visibility: public, private, or internal.
- Default
- "public"
pushed_at
string or null
date-time
required
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
required
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
required
- Example
- "2011-01-26T19:14:43Z"
allow_rebase_merge
boolean
Whether to allow rebase merges for pull requests.
- Default
- true
- Example
- true
template_repository
object (template_repository) or null
id
int
node_id
string
name
string
full_name
string
owner
object (owner)
login
string
id
int
node_id
string
avatar_url
string
gravatar_id
string
url
string
html_url
string
followers_url
string
following_url
string
gists_url
string
starred_url
string
subscriptions_url
string
organizations_url
string
repos_url
string
events_url
string
received_events_url
string
type
string
site_admin
boolean
private
boolean
html_url
string
description
string
fork
boolean
url
string
archive_url
string
assignees_url
string
blobs_url
string
branches_url
string
collaborators_url
string
comments_url
string
commits_url
string
compare_url
string
contents_url
string
contributors_url
string
deployments_url
string
downloads_url
string
events_url
string
forks_url
string
git_commits_url
string
git_refs_url
string
git_tags_url
string
git_url
string
issue_comment_url
string
issue_events_url
string
issues_url
string
keys_url
string
labels_url
string
languages_url
string
merges_url
string
milestones_url
string
notifications_url
string
pulls_url
string
releases_url
string
ssh_url
string
stargazers_url
string
statuses_url
string
subscribers_url
string
subscription_url
string
tags_url
string
teams_url
string
trees_url
string
clone_url
string
mirror_url
string
hooks_url
string
svn_url
string
homepage
string
language
string
forks_count
int
stargazers_count
int
watchers_count
int
size
int
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string
created_at
string
updated_at
string
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
allow_rebase_merge
boolean
temp_clone_token
string
allow_squash_merge
boolean
allow_auto_merge
boolean
delete_branch_on_merge
boolean
allow_update_branch
boolean
use_squash_pr_title_as_default
boolean
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
subscribers_count
int
network_count
int
temp_clone_token
string
allow_squash_merge
boolean
Whether to allow squash merges for pull requests.
- Default
- true
- Example
- true
allow_auto_merge
boolean
Whether to allow Auto-merge to be used on pull requests.
- Default
- false
- Example
- false
delete_branch_on_merge
boolean
Whether to delete head branches when pull requests are merged
- Default
- false
- Example
- false
allow_update_branch
boolean
Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
- Default
- false
- Example
- false
use_squash_pr_title_as_default
boolean
deprecated
Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title
instead.
- Default
- false
squash_merge_commit_title
string
The default value for a squash merge commit title:
PR_TITLE
- default to the pull request's title.COMMIT_OR_PR_TITLE
- default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
- Enum
-
- PR_TITLE
- COMMIT_OR_PR_TITLE
squash_merge_commit_message
string
The default value for a squash merge commit message:
PR_BODY
- default to the pull request's body.COMMIT_MESSAGES
- default to the branch's commit messages.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- COMMIT_MESSAGES
- BLANK
merge_commit_title
string
The default value for a merge commit title.
PR_TITLE
- default to the pull request's title.MERGE_MESSAGE
- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
- Enum
-
- PR_TITLE
- MERGE_MESSAGE
merge_commit_message
string
The default value for a merge commit message.
PR_TITLE
- default to the pull request's title.PR_BODY
- default to the pull request's body.BLANK
- default to a blank commit message.
- Enum
-
- PR_BODY
- PR_TITLE
- BLANK
allow_merge_commit
boolean
Whether to allow merge commits for pull requests.
- Default
- true
- Example
- true
allow_forking
boolean
Whether to allow forking this repo
web_commit_signoff_required
boolean
Whether to require contributors to sign off on web-based commits
- Default
- false
subscribers_count
int
network_count
int
open_issues
int
required
watchers
int
required
master_branch
string
starred_at
string
- Example
- "\"2020-07-09T00:17:42Z\""
anonymous_access_enabled
boolean
Whether anonymous git access is enabled for this repository
single_file
string or null
- Example
- "config.yaml"
repository_selection
string
Describe whether all repositories have been selected or there's a selection involved
- Enum
-
- all
- selected
Get a self-hosted runner for a repository
Gets a specific self-hosted runner configured in a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
Response
Response
{
"id": 23,
"name": "MBP",
"os": "macos",
"status": "online",
"busy": true,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
id
int
required
The id of the runner.
- Example
- 5
runner_group_id
int
The id of the runner group.
- Example
- 1
name
string
required
The name of the runner.
- Example
- "iMac"
os
string
required
The Operating System of the runner.
- Example
- "macos"
status
string
required
The status of the runner.
- Example
- "online"
busy
boolean
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Delete a self-hosted runner from a repository
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the repo
scope to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List labels for a self-hosted runner for a repository
Lists all labels for a self-hosted runner configured in a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
Response
Response
{
"total_count": 4,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
total_count
int
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Set custom labels for a self-hosted runner for a repository
Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint.
labels
array[string]
required
The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.
string
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
Request
{
"labels": [
"gpu",
"accelerated"
]
}
Response
Response
{
"total_count": 4,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string
required
documentation_url
string
required
errors
array[string]
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
"string"
]
}
total_count
int
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Add custom labels to a self-hosted runner for a repository
Add custom labels to a self-hosted runner configured in a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint.
labels
array[string]
required
The names of the custom labels to add to the runner.
string
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
Request
{
"labels": [
"gpu",
"accelerated"
]
}
Response
Response
{
"total_count": 4,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string
required
documentation_url
string
required
errors
array[string]
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
"string"
]
}
total_count
int
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Remove all custom labels from a self-hosted runner for a repository
Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner.
You must authenticate using an access token with the repo
scope to use this
endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
Response
Response
{
"total_count": 3,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
total_count
int
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
Remove a custom label from a self-hosted runner for a repository
Remove a custom label from a self-hosted runner configured in a repository. Returns the remaining labels from the runner.
This endpoint returns a 404 Not Found
status if the custom label is not
present on the runner.
You must authenticate using an access token with the repo
scope to use this
endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
runner_id
int
required
Unique identifier of the self-hosted runner.
name
string
required
The name of a self-hosted runner's custom label.
Response
Response
{
"total_count": 4,
"labels": [
{
"id": 5,
"name": "self-hosted",
"type": "read-only"
},
{
"id": 7,
"name": "X64",
"type": "read-only"
},
{
"id": 20,
"name": "macOS",
"type": "read-only"
},
{
"id": 21,
"name": "no-gpu",
"type": "custom"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
message
string
required
documentation_url
string
required
errors
array[string]
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Validation failed, or the endpoint has been spammed.
{
"message": "string",
"documentation_url": "string",
"errors": [
"string"
]
}
total_count
int
required
labels
array[object (Self hosted runner label)]
required
Self hosted runner label
object (Self hosted runner label)
A label for a self hosted runner
id
int
Unique identifier of the label.
name
string
required
Name of the label.
type
string
The type of label. Read-only labels are applied automatically when the runner is configured.
- Enum
-
- read-only
- custom
List workflow runs for a repository
Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
actor
string
Returns someone's workflow runs. Use the login for the user who created the push
associated with the check suite or workflow run.
branch
string
Returns workflow runs associated with a branch. Use the name of the branch of the push
.
event
string
Returns workflow run triggered by the event you specify. For example, push
, pull_request
or issue
. For more information, see "Events that trigger workflows."
status
string
Returns workflow runs with the check run status
or conclusion
that you specify. For example, a conclusion can be success
or a status can be in_progress
. Only GitHub can set a status of waiting
or requested
.
- Enum
-
- completed
- action_required
- cancelled
- failure
- neutral
- skipped
- stale
- success
- timed_out
- in_progress
- queued
- requested
- waiting
- pending
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
created
string
date-time
Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."
exclude_pull_requests
boolean
If true
pull requests are omitted from the response (empty array).
- Default
- false
check_suite_id
int
Returns workflow runs with the check_suite_id
that you specify.
head_sha
string
Only returns workflow runs that are associated with the specified head_sha
.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"total_count": 1,
"workflow_runs": [
{
"id": 30433642,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": null,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com"
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com"
}
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": true,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": null,
"fork": false,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments"
}
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
workflow_runs
array[object (Workflow Run)]
required
Workflow Run
object (Workflow Run)
An invocation of a workflow
id
int
required
The ID of the workflow run.
- Example
- 5
name
string or null
The name of the workflow run.
- Example
- "Build"
node_id
string
required
- Example
- "MDEwOkNoZWNrU3VpdGU1"
check_suite_id
int
The ID of the associated check suite.
- Example
- 42
check_suite_node_id
string
The node ID of the associated check suite.
- Example
- "MDEwOkNoZWNrU3VpdGU0Mg=="
head_branch
string or null
required
- Example
- "master"
head_sha
string
required
The SHA of the head commit that points to the version of the workflow being run.
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
path
string
required
The full path of the workflow
- Example
- "octocat/octo-repo/.github/workflows/ci.yml@main"
run_number
int
required
The auto incrementing run number for the workflow run.
- Example
- 106
run_attempt
int
Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.
- Example
- 1
referenced_workflows
array[object (Referenced workflow)] or null
Referenced workflow
object (Referenced workflow)
A workflow referenced/reused by the initial caller workflow
path
string
required
sha
string
required
ref
string
event
string
required
- Example
- "push"
status
string or null
required
- Example
- "completed"
conclusion
string or null
required
- Example
- "neutral"
workflow_id
int
required
The ID of the parent workflow.
- Example
- 5
url
string
required
The URL to the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5"
html_url
string
required
- Example
- "https://github.com/github/hello-world/suites/4"
pull_requests
array[object (Pull Request Minimal)] or null
required
Pull Request Minimal
object (Pull Request Minimal)
id
int
required
number
int
required
url
string
required
head
object (head)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
base
object (base)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
created_at
string
date-time
required
updated_at
string
date-time
required
actor
object (actor)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
triggering_actor
object (triggering_actor)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
run_started_at
string
date-time
The start time of the latest run. Resets on re-run.
jobs_url
string
required
The URL to the jobs for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs"
logs_url
string
required
The URL to download the logs for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/logs"
check_suite_url
string
required
The URL to the associated check suite.
- Example
- "https://api.github.com/repos/github/hello-world/check-suites/12"
artifacts_url
string
required
The URL to the artifacts for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts"
cancel_url
string
required
The URL to cancel the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel"
rerun_url
string
required
The URL to rerun the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun"
previous_attempt_url
string or null
The URL to the previous attempted run of this workflow, if one exists.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3"
workflow_url
string
required
The URL to the workflow.
- Example
- "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml"
head_commit
object (head_commit) or null
required
A commit.
id
string
required
SHA for the commit
- Example
- "7638417db6d59f3c431d3e1f261cc637155684cd"
tree_id
string
required
SHA for the commit's tree
message
string
required
Message describing the purpose of the commit
- Example
- "Fix #42"
timestamp
string
date-time
required
Timestamp of the commit
- Example
- "2014-08-09T08:02:04+12:00"
author
object (author) or null
required
Information about the Git author
name
string
required
Name of the commit's author
- Example
- "Monalisa Octocat"
string
required
Git email address of the commit's author
- Example
- "monalisa.octocat@example.com"
committer
object (committer) or null
required
Information about the Git committer
name
string
required
Name of the commit's committer
- Example
- "Monalisa Octocat"
string
required
Git email address of the commit's committer
- Example
- "monalisa.octocat@example.com"
repository
object (repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
head_repository
object (head_repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
head_repository_id
int
- Example
- 5
display_title
string
required
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.
- Example
- "Simple Workflow"
Link
string
Get a workflow run
Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
exclude_pull_requests
boolean
If true
pull requests are omitted from the response (empty array).
- Default
- false
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
Response
Response
{
"id": 30433642,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "main",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"path": ".github/workflows/build.yml@main",
"run_number": 562,
"event": "push",
"display_title": "Update README.md",
"status": "queued",
"conclusion": null,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"run_attempt": 1,
"referenced_workflows": [
{
"path": "octocat/Hello-World/.github/workflows/deploy.yml@main",
"sha": "86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db",
"ref": "refs/heads/main"
},
{
"path": "octo-org/octo-repo/.github/workflows/report.yml@v2",
"sha": "79e9790903e1c3373b1a3e3a941d57405478a232",
"ref": "refs/tags/v2"
},
{
"path": "octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e",
"sha": "1595d4b6de6a9e9751fb270a41019ce507d4099e"
}
],
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"previous_attempt_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com"
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com"
}
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": true,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": null,
"fork": false,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments"
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
id
int
required
The ID of the workflow run.
- Example
- 5
name
string or null
The name of the workflow run.
- Example
- "Build"
node_id
string
required
- Example
- "MDEwOkNoZWNrU3VpdGU1"
check_suite_id
int
The ID of the associated check suite.
- Example
- 42
check_suite_node_id
string
The node ID of the associated check suite.
- Example
- "MDEwOkNoZWNrU3VpdGU0Mg=="
head_branch
string or null
required
- Example
- "master"
head_sha
string
required
The SHA of the head commit that points to the version of the workflow being run.
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
path
string
required
The full path of the workflow
- Example
- "octocat/octo-repo/.github/workflows/ci.yml@main"
run_number
int
required
The auto incrementing run number for the workflow run.
- Example
- 106
run_attempt
int
Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.
- Example
- 1
referenced_workflows
array[object (Referenced workflow)] or null
Referenced workflow
object (Referenced workflow)
A workflow referenced/reused by the initial caller workflow
path
string
required
sha
string
required
ref
string
event
string
required
- Example
- "push"
status
string or null
required
- Example
- "completed"
conclusion
string or null
required
- Example
- "neutral"
workflow_id
int
required
The ID of the parent workflow.
- Example
- 5
url
string
required
The URL to the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5"
html_url
string
required
- Example
- "https://github.com/github/hello-world/suites/4"
pull_requests
array[object (Pull Request Minimal)] or null
required
Pull Request Minimal
object (Pull Request Minimal)
id
int
required
number
int
required
url
string
required
head
object (head)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
base
object (base)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
created_at
string
date-time
required
updated_at
string
date-time
required
actor
object (actor)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
triggering_actor
object (triggering_actor)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
run_started_at
string
date-time
The start time of the latest run. Resets on re-run.
jobs_url
string
required
The URL to the jobs for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs"
logs_url
string
required
The URL to download the logs for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/logs"
check_suite_url
string
required
The URL to the associated check suite.
- Example
- "https://api.github.com/repos/github/hello-world/check-suites/12"
artifacts_url
string
required
The URL to the artifacts for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts"
cancel_url
string
required
The URL to cancel the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel"
rerun_url
string
required
The URL to rerun the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun"
previous_attempt_url
string or null
The URL to the previous attempted run of this workflow, if one exists.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3"
workflow_url
string
required
The URL to the workflow.
- Example
- "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml"
head_commit
object (head_commit) or null
required
A commit.
id
string
required
SHA for the commit
- Example
- "7638417db6d59f3c431d3e1f261cc637155684cd"
tree_id
string
required
SHA for the commit's tree
message
string
required
Message describing the purpose of the commit
- Example
- "Fix #42"
timestamp
string
date-time
required
Timestamp of the commit
- Example
- "2014-08-09T08:02:04+12:00"
author
object (author) or null
required
Information about the Git author
name
string
required
Name of the commit's author
- Example
- "Monalisa Octocat"
string
required
Git email address of the commit's author
- Example
- "monalisa.octocat@example.com"
committer
object (committer) or null
required
Information about the Git committer
name
string
required
Name of the commit's committer
- Example
- "Monalisa Octocat"
string
required
Git email address of the commit's committer
- Example
- "monalisa.octocat@example.com"
repository
object (repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
head_repository
object (head_repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
head_repository_id
int
- Example
- 5
display_title
string
required
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.
- Example
- "Simple Workflow"
Delete a workflow run
Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is
private you must use an access token with the repo
scope. GitHub Apps must have the actions:write
permission to use
this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get the review history for a workflow run
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
Response
Response
[
{
"state": "approved",
"comment": "Ship it!",
"environments": [
{
"id": 161088068,
"node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4",
"name": "staging",
"url": "https://api.github.com/repos/github/hello-world/environments/staging",
"html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging",
"created_at": "2020-11-23T22:00:40Z",
"updated_at": "2020-11-23T22:00:40Z"
}
],
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
array[object (Environment Approval)]
- Content Type
- application/json
Environment Approval
object (Environment Approval)
An entry in the reviews log for environment deployments
environments
array[object]
required
The list of environments that were approved or rejected
object
id
int
The id of the environment.
- Example
- 56780428
node_id
string
- Example
- "MDExOkVudmlyb25tZW50NTY3ODA0Mjg="
name
string
The name of the environment.
- Example
- "staging"
url
string
- Example
- "https://api.github.com/repos/github/hello-world/environments/staging"
html_url
string
- Example
- "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging"
created_at
string
date-time
The time that the environment was created, in ISO 8601 format.
- Example
- "2020-11-23T22:00:40Z"
updated_at
string
date-time
The time that the environment was last updated, in ISO 8601 format.
- Example
- "2020-11-23T22:00:40Z"
state
string
required
Whether deployment to the environment(s) was approved or rejected or pending (with comments)
- Enum
-
- approved
- rejected
- pending
- Example
- "approved"
user
object (user)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
comment
string
required
The comment submitted with the deployment review
- Example
- "Ship it!"
List workflow run artifacts
Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
Response
Response
{
"total_count": 2,
"artifacts": [
{
"id": 11,
"node_id": "MDg6QXJ0aWZhY3QxMQ==",
"name": "Rails",
"size_in_bytes": 556,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip",
"expired": false,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-03-21T14:59:22Z",
"updated_at": "2020-02-21T14:59:22Z",
"workflow_run": {
"id": 2332938,
"repository_id": 1296269,
"head_repository_id": 1296269,
"head_branch": "main",
"head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3"
}
},
{
"id": 13,
"node_id": "MDg6QXJ0aWZhY3QxMw==",
"name": "Test output",
"size_in_bytes": 453,
"url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13",
"archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip",
"expired": false,
"created_at": "2020-01-10T14:59:22Z",
"expires_at": "2020-03-21T14:59:22Z",
"updated_at": "2020-02-21T14:59:22Z",
"workflow_run": {
"id": 2332942,
"repository_id": 1296269,
"head_repository_id": 1296269,
"head_branch": "main",
"head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652"
}
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
artifacts
array[object (Artifact)]
required
Artifact
object (Artifact)
An artifact
id
int
required
- Example
- 5
node_id
string
required
- Example
- "MDEwOkNoZWNrU3VpdGU1"
name
string
required
The name of the artifact.
- Example
- "AdventureWorks.Framework"
size_in_bytes
int
required
The size in bytes of the artifact.
- Example
- 12345
url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/actions/artifacts/5"
archive_download_url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip"
expired
boolean
required
Whether or not the artifact has expired.
created_at
string or null
date-time
required
expires_at
string or null
date-time
required
updated_at
string or null
date-time
required
workflow_run
object (workflow_run) or null
id
int
- Example
- 10
repository_id
int
- Example
- 42
head_repository_id
int
- Example
- 42
head_branch
string
- Example
- "main"
head_sha
string
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
Link
string
Get a workflow run attempt
Gets a specific workflow run attempt. Anyone with read access to the repository
can use this endpoint. If the repository is private you must use an access token
with the repo
scope. GitHub Apps must have the actions:read
permission to
use this endpoint.
exclude_pull_requests
boolean
If true
pull requests are omitted from the response (empty array).
- Default
- false
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
attempt_number
int
required
The attempt number of the workflow run.
Response
Response
{
"id": 30433642,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "main",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"path": ".github/workflows/build.yml@main",
"run_number": 562,
"event": "push",
"display_title": "Update README.md",
"status": "queued",
"conclusion": null,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"run_attempt": 1,
"referenced_workflows": [
{
"path": "octocat/Hello-World/.github/workflows/deploy.yml@main",
"sha": "86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db",
"ref": "refs/heads/main"
},
{
"path": "octo-org/octo-repo/.github/workflows/report.yml@v2",
"sha": "79e9790903e1c3373b1a3e3a941d57405478a232",
"ref": "refs/tags/v2"
},
{
"path": "octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e",
"sha": "1595d4b6de6a9e9751fb270a41019ce507d4099e"
}
],
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"previous_attempt_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com"
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com"
}
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": true,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": null,
"fork": false,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments"
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
id
int
required
The ID of the workflow run.
- Example
- 5
name
string or null
The name of the workflow run.
- Example
- "Build"
node_id
string
required
- Example
- "MDEwOkNoZWNrU3VpdGU1"
check_suite_id
int
The ID of the associated check suite.
- Example
- 42
check_suite_node_id
string
The node ID of the associated check suite.
- Example
- "MDEwOkNoZWNrU3VpdGU0Mg=="
head_branch
string or null
required
- Example
- "master"
head_sha
string
required
The SHA of the head commit that points to the version of the workflow being run.
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
path
string
required
The full path of the workflow
- Example
- "octocat/octo-repo/.github/workflows/ci.yml@main"
run_number
int
required
The auto incrementing run number for the workflow run.
- Example
- 106
run_attempt
int
Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.
- Example
- 1
referenced_workflows
array[object (Referenced workflow)] or null
Referenced workflow
object (Referenced workflow)
A workflow referenced/reused by the initial caller workflow
path
string
required
sha
string
required
ref
string
event
string
required
- Example
- "push"
status
string or null
required
- Example
- "completed"
conclusion
string or null
required
- Example
- "neutral"
workflow_id
int
required
The ID of the parent workflow.
- Example
- 5
url
string
required
The URL to the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5"
html_url
string
required
- Example
- "https://github.com/github/hello-world/suites/4"
pull_requests
array[object (Pull Request Minimal)] or null
required
Pull Request Minimal
object (Pull Request Minimal)
id
int
required
number
int
required
url
string
required
head
object (head)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
base
object (base)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
created_at
string
date-time
required
updated_at
string
date-time
required
actor
object (actor)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
triggering_actor
object (triggering_actor)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
run_started_at
string
date-time
The start time of the latest run. Resets on re-run.
jobs_url
string
required
The URL to the jobs for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs"
logs_url
string
required
The URL to download the logs for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/logs"
check_suite_url
string
required
The URL to the associated check suite.
- Example
- "https://api.github.com/repos/github/hello-world/check-suites/12"
artifacts_url
string
required
The URL to the artifacts for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts"
cancel_url
string
required
The URL to cancel the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel"
rerun_url
string
required
The URL to rerun the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun"
previous_attempt_url
string or null
The URL to the previous attempted run of this workflow, if one exists.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3"
workflow_url
string
required
The URL to the workflow.
- Example
- "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml"
head_commit
object (head_commit) or null
required
A commit.
id
string
required
SHA for the commit
- Example
- "7638417db6d59f3c431d3e1f261cc637155684cd"
tree_id
string
required
SHA for the commit's tree
message
string
required
Message describing the purpose of the commit
- Example
- "Fix #42"
timestamp
string
date-time
required
Timestamp of the commit
- Example
- "2014-08-09T08:02:04+12:00"
author
object (author) or null
required
Information about the Git author
name
string
required
Name of the commit's author
- Example
- "Monalisa Octocat"
string
required
Git email address of the commit's author
- Example
- "monalisa.octocat@example.com"
committer
object (committer) or null
required
Information about the Git committer
name
string
required
Name of the commit's committer
- Example
- "Monalisa Octocat"
string
required
Git email address of the commit's committer
- Example
- "monalisa.octocat@example.com"
repository
object (repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
head_repository
object (head_repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
head_repository_id
int
- Example
- 5
display_title
string
required
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.
- Example
- "Simple Workflow"
List jobs for a workflow run attempt
Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
attempt_number
int
required
The attempt number of the workflow run.
Response
Response
{
"total_count": 1,
"jobs": [
{
"id": 399444496,
"run_id": 29679449,
"run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449",
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
"status": "completed",
"conclusion": "success",
"started_at": "2020-01-20T17:42:40Z",
"completed_at": "2020-01-20T17:44:39Z",
"name": "build",
"steps": [
{
"name": "Set up job",
"status": "completed",
"conclusion": "success",
"number": 1,
"started_at": "2020-01-20T09:42:40.000-08:00",
"completed_at": "2020-01-20T09:42:41.000-08:00"
},
{
"name": "Run actions/checkout@v2",
"status": "completed",
"conclusion": "success",
"number": 2,
"started_at": "2020-01-20T09:42:41.000-08:00",
"completed_at": "2020-01-20T09:42:45.000-08:00"
},
{
"name": "Set up Ruby",
"status": "completed",
"conclusion": "success",
"number": 3,
"started_at": "2020-01-20T09:42:45.000-08:00",
"completed_at": "2020-01-20T09:42:45.000-08:00"
},
{
"name": "Run actions/cache@v3",
"status": "completed",
"conclusion": "success",
"number": 4,
"started_at": "2020-01-20T09:42:45.000-08:00",
"completed_at": "2020-01-20T09:42:48.000-08:00"
},
{
"name": "Install Bundler",
"status": "completed",
"conclusion": "success",
"number": 5,
"started_at": "2020-01-20T09:42:48.000-08:00",
"completed_at": "2020-01-20T09:42:52.000-08:00"
},
{
"name": "Install Gems",
"status": "completed",
"conclusion": "success",
"number": 6,
"started_at": "2020-01-20T09:42:52.000-08:00",
"completed_at": "2020-01-20T09:42:53.000-08:00"
},
{
"name": "Run Tests",
"status": "completed",
"conclusion": "success",
"number": 7,
"started_at": "2020-01-20T09:42:53.000-08:00",
"completed_at": "2020-01-20T09:42:59.000-08:00"
},
{
"name": "Deploy to Heroku",
"status": "completed",
"conclusion": "success",
"number": 8,
"started_at": "2020-01-20T09:42:59.000-08:00",
"completed_at": "2020-01-20T09:44:39.000-08:00"
},
{
"name": "Post actions/cache@v3",
"status": "completed",
"conclusion": "success",
"number": 16,
"started_at": "2020-01-20T09:44:39.000-08:00",
"completed_at": "2020-01-20T09:44:39.000-08:00"
},
{
"name": "Complete job",
"status": "completed",
"conclusion": "success",
"number": 17,
"started_at": "2020-01-20T09:44:39.000-08:00",
"completed_at": "2020-01-20T09:44:39.000-08:00"
}
],
"check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496",
"labels": [
"self-hosted",
"foo",
"bar"
],
"runner_id": 1,
"runner_name": "my runner",
"runner_group_id": 2,
"runner_group_name": "my runner group",
"workflow_name": "CI",
"head_branch": "main"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
message
string
documentation_url
string
url
string
status
string
Resource not found
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
total_count
int
required
jobs
array[object (Job)]
required
Job
object (Job)
Information of a job execution in a workflow run
id
int
required
The id of the job.
- Example
- 21
run_id
int
required
The id of the associated workflow run.
- Example
- 5
run_url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5"
run_attempt
int
Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.
- Example
- 1
node_id
string
required
- Example
- "MDg6Q2hlY2tSdW40"
head_sha
string
required
The SHA of the commit that is being run.
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/actions/jobs/21"
html_url
string or null
required
- Example
- "https://github.com/github/hello-world/runs/4"
status
string
required
The phase of the lifecycle that the job is currently in.
- Enum
-
- queued
- in_progress
- completed
- Example
- "queued"
conclusion
string or null
required
The outcome of the job.
- Enum
-
- success
- failure
- neutral
- cancelled
- skipped
- timed_out
- action_required
- Example
- "success"
created_at
string
date-time
required
The time that the job created, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
started_at
string
date-time
required
The time that the job started, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
completed_at
string or null
date-time
required
The time that the job finished, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
name
string
required
The name of the job.
- Example
- "test-coverage"
steps
array[object]
Steps in this job.
object
status
string
required
The phase of the lifecycle that the job is currently in.
- Enum
-
- queued
- in_progress
- completed
- Example
- "queued"
conclusion
string or null
required
The outcome of the job.
- Example
- "success"
name
string
required
The name of the job.
- Example
- "test-coverage"
number
int
required
- Example
- 1
started_at
string or null
date-time
The time that the step started, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
completed_at
string or null
date-time
The time that the job finished, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
check_run_url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/check-runs/4"
labels
array[string]
required
Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file.
- Example
- [ "self-hosted", "foo", "bar" ]
string
runner_id
int or null
required
The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- Example
- 1
runner_name
string or null
required
The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- Example
- "my runner"
runner_group_id
int or null
required
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.)
- Example
- 2
runner_group_name
string or null
required
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.)
- Example
- "my runner group"
workflow_name
string or null
required
The name of the workflow.
- Example
- "Build"
head_branch
string or null
required
The name of the current branch.
- Example
- "main"
Link
string
Download workflow run attempt logs
Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
1 minute. Look for Location:
in the response header to find the URL for the download. Anyone with read access to
the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope.
GitHub Apps must have the actions:read
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
attempt_number
int
required
The attempt number of the workflow run.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Location
string
Cancel a workflow run
Cancels a workflow run using its id
. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
Response
Response
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
Conflict
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
List jobs for a workflow run
Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
filter
string
Filters jobs by their completed_at
timestamp. latest
returns jobs from the most recent execution of the workflow run. all
returns all jobs for a workflow run, including from old executions of the workflow run.
- Default
- "latest"
- Enum
-
- latest
- all
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
Response
Response
{
"total_count": 1,
"jobs": [
{
"id": 399444496,
"run_id": 29679449,
"run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449",
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
"status": "completed",
"conclusion": "success",
"started_at": "2020-01-20T17:42:40Z",
"completed_at": "2020-01-20T17:44:39Z",
"name": "build",
"steps": [
{
"name": "Set up job",
"status": "completed",
"conclusion": "success",
"number": 1,
"started_at": "2020-01-20T09:42:40.000-08:00",
"completed_at": "2020-01-20T09:42:41.000-08:00"
},
{
"name": "Run actions/checkout@v2",
"status": "completed",
"conclusion": "success",
"number": 2,
"started_at": "2020-01-20T09:42:41.000-08:00",
"completed_at": "2020-01-20T09:42:45.000-08:00"
},
{
"name": "Set up Ruby",
"status": "completed",
"conclusion": "success",
"number": 3,
"started_at": "2020-01-20T09:42:45.000-08:00",
"completed_at": "2020-01-20T09:42:45.000-08:00"
},
{
"name": "Run actions/cache@v3",
"status": "completed",
"conclusion": "success",
"number": 4,
"started_at": "2020-01-20T09:42:45.000-08:00",
"completed_at": "2020-01-20T09:42:48.000-08:00"
},
{
"name": "Install Bundler",
"status": "completed",
"conclusion": "success",
"number": 5,
"started_at": "2020-01-20T09:42:48.000-08:00",
"completed_at": "2020-01-20T09:42:52.000-08:00"
},
{
"name": "Install Gems",
"status": "completed",
"conclusion": "success",
"number": 6,
"started_at": "2020-01-20T09:42:52.000-08:00",
"completed_at": "2020-01-20T09:42:53.000-08:00"
},
{
"name": "Run Tests",
"status": "completed",
"conclusion": "success",
"number": 7,
"started_at": "2020-01-20T09:42:53.000-08:00",
"completed_at": "2020-01-20T09:42:59.000-08:00"
},
{
"name": "Deploy to Heroku",
"status": "completed",
"conclusion": "success",
"number": 8,
"started_at": "2020-01-20T09:42:59.000-08:00",
"completed_at": "2020-01-20T09:44:39.000-08:00"
},
{
"name": "Post actions/cache@v3",
"status": "completed",
"conclusion": "success",
"number": 16,
"started_at": "2020-01-20T09:44:39.000-08:00",
"completed_at": "2020-01-20T09:44:39.000-08:00"
},
{
"name": "Complete job",
"status": "completed",
"conclusion": "success",
"number": 17,
"started_at": "2020-01-20T09:44:39.000-08:00",
"completed_at": "2020-01-20T09:44:39.000-08:00"
}
],
"check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496",
"labels": [
"self-hosted",
"foo",
"bar"
],
"runner_id": 1,
"runner_name": "my runner",
"runner_group_id": 2,
"runner_group_name": "my runner group",
"workflow_name": "CI",
"head_branch": "main"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
jobs
array[object (Job)]
required
Job
object (Job)
Information of a job execution in a workflow run
id
int
required
The id of the job.
- Example
- 21
run_id
int
required
The id of the associated workflow run.
- Example
- 5
run_url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5"
run_attempt
int
Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.
- Example
- 1
node_id
string
required
- Example
- "MDg6Q2hlY2tSdW40"
head_sha
string
required
The SHA of the commit that is being run.
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/actions/jobs/21"
html_url
string or null
required
- Example
- "https://github.com/github/hello-world/runs/4"
status
string
required
The phase of the lifecycle that the job is currently in.
- Enum
-
- queued
- in_progress
- completed
- Example
- "queued"
conclusion
string or null
required
The outcome of the job.
- Enum
-
- success
- failure
- neutral
- cancelled
- skipped
- timed_out
- action_required
- Example
- "success"
created_at
string
date-time
required
The time that the job created, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
started_at
string
date-time
required
The time that the job started, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
completed_at
string or null
date-time
required
The time that the job finished, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
name
string
required
The name of the job.
- Example
- "test-coverage"
steps
array[object]
Steps in this job.
object
status
string
required
The phase of the lifecycle that the job is currently in.
- Enum
-
- queued
- in_progress
- completed
- Example
- "queued"
conclusion
string or null
required
The outcome of the job.
- Example
- "success"
name
string
required
The name of the job.
- Example
- "test-coverage"
number
int
required
- Example
- 1
started_at
string or null
date-time
The time that the step started, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
completed_at
string or null
date-time
The time that the job finished, in ISO 8601 format.
- Example
- "2019-08-08T08:00:00-07:00"
check_run_url
string
required
- Example
- "https://api.github.com/repos/github/hello-world/check-runs/4"
labels
array[string]
required
Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file.
- Example
- [ "self-hosted", "foo", "bar" ]
string
runner_id
int or null
required
The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- Example
- 1
runner_name
string or null
required
The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
- Example
- "my runner"
runner_group_id
int or null
required
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.)
- Example
- 2
runner_group_name
string or null
required
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.)
- Example
- "my runner group"
workflow_name
string or null
required
The name of the workflow.
- Example
- "Build"
head_branch
string or null
required
The name of the current branch.
- Example
- "main"
Link
string
Download workflow run logs
Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
Location:
in the response header to find the URL for the download. Anyone with read access to the repository can use
this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have
the actions:read
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Location
string
Delete workflow run logs
Deletes all logs for a workflow run. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
Forbidden
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Internal Error
{
"message": "string",
"documentation_url": "string",
"url": "string",
"status": "string"
}
Get pending deployments for a workflow run
Get all deployment environments for a workflow run that are waiting for protection rules to pass.
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
Response
Response
[
{
"environment": {
"id": 161088068,
"node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4",
"name": "staging",
"url": "https://api.github.com/repos/github/hello-world/environments/staging",
"html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging"
},
"wait_timer": 30,
"wait_timer_started_at": "2020-11-23T22:00:40Z",
"current_user_can_approve": true,
"reviewers": [
{
"type": "User",
"reviewer": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
}
},
{
"type": "Team",
"reviewer": {
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/justice-league",
"name": "Justice League",
"slug": "justice-league",
"description": "A great team.",
"privacy": "closed",
"permission": "admin",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos",
"parent": null
}
}
]
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
array[object (Pending Deployment)]
- Content Type
- application/json
Pending Deployment
object (Pending Deployment)
Details of a deployment that is waiting for protection rules to pass
environment
object (environment)
required
id
int
The id of the environment.
- Example
- 56780428
node_id
string
- Example
- "MDExOkVudmlyb25tZW50NTY3ODA0Mjg="
name
string
The name of the environment.
- Example
- "staging"
url
string
- Example
- "https://api.github.com/repos/github/hello-world/environments/staging"
html_url
string
- Example
- "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging"
wait_timer
int
required
The set duration of the wait timer
- Example
- 30
wait_timer_started_at
string or null
date-time
required
The time that the wait timer began.
- Example
- "2020-11-23T22:00:40Z"
current_user_can_approve
boolean
required
Whether the currently authenticated user can approve the deployment
- Example
- true
reviewers
array[object]
required
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.
object
type
string
The type of reviewer.
- Enum
-
- User
- Team
- Example
- "User"
reviewer
Any Of
Simple User
object (Simple User)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
Team
object (Team)
Groups of organization members that gives permissions on specified repositories.
id
int
required
node_id
string
required
name
string
required
slug
string
required
description
string or null
required
privacy
string
permission
string
required
permissions
object (permissions)
pull
boolean
required
triage
boolean
required
push
boolean
required
maintain
boolean
required
admin
boolean
required
url
string
uri
required
html_url
string
uri
required
- Example
- "https://github.com/orgs/rails/teams/core"
members_url
string
required
repositories_url
string
uri
required
parent
object (parent) or null
required
Groups of organization members that gives permissions on specified repositories.
id
int
required
Unique identifier of the team
- Example
- 1
node_id
string
required
- Example
- "MDQ6VGVhbTE="
url
string
uri
required
URL for the team
- Example
- "https://api.github.com/organizations/1/team/1"
members_url
string
required
- Example
- "https://api.github.com/organizations/1/team/1/members{/member}"
name
string
required
Name of the team
- Example
- "Justice League"
description
string or null
required
Description of the team
- Example
- "A great team."
permission
string
required
Permission that the team will have for its repositories
- Example
- "admin"
privacy
string
The level of privacy this team should have
- Example
- "closed"
html_url
string
uri
required
- Example
- "https://github.com/orgs/rails/teams/core"
repositories_url
string
uri
required
- Example
- "https://api.github.com/organizations/1/team/1/repos"
slug
string
required
- Example
- "justice-league"
ldap_dn
string
Distinguished Name (DN) that team maps to within LDAP environment
- Example
- "uid=example,ou=users,dc=github,dc=com"
Review pending deployments for a workflow run
Approve or reject pending deployments that are waiting on approval by a required reviewer.
Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the repo
scope to use this endpoint.
environment_ids
array[int]
required
The list of environment ids to approve or reject
- Example
- [ 161171787, 161171795 ]
int
- Example
- 161171787
state
string
required
Whether to approve or reject deployment to the specified environments.
- Enum
-
- approved
- rejected
- Example
- "approved"
comment
string
required
A comment to accompany the deployment review
- Example
- "Ship it!"
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
Request
{
"environment_ids": [
161171787
],
"state": "approved",
"comment": "Ship it!"
}
Response
Response
[
{
"url": "https://api.github.com/repos/octocat/example/deployments/1",
"id": 1,
"node_id": "MDEwOkRlcGxveW1lbnQx",
"sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
"ref": "topic-branch",
"task": "deploy",
"payload": {},
"original_environment": "staging",
"environment": "production",
"description": "Deploy request from hubot",
"creator": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"created_at": "2012-07-20T01:19:13Z",
"updated_at": "2012-07-20T01:19:13Z",
"statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses",
"repository_url": "https://api.github.com/repos/octocat/example",
"transient_environment": false,
"production_environment": true
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
array[object (Deployment)]
- Content Type
- application/json
Deployment
object (Deployment)
A request for a specific ref(branch,sha,tag) to be deployed
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/example/deployments/1"
id
int
required
Unique identifier of the deployment
- Example
- 42
node_id
string
required
- Example
- "MDEwOkRlcGxveW1lbnQx"
sha
string
required
- Example
- "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d"
ref
string
required
The ref to deploy. This can be a branch, tag, or sha.
- Example
- "topic-branch"
task
string
required
Parameter to specify a task to execute
- Example
- "deploy"
payload
One Of
required
object
string
original_environment
string
- Example
- "staging"
environment
string
required
Name for the target deployment environment.
- Example
- "production"
description
string or null
required
- Example
- "Deploy request from hubot"
creator
object (creator) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
- Example
- "2012-07-20T01:19:13Z"
updated_at
string
date-time
required
- Example
- "2012-07-20T01:19:13Z"
statuses_url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/example/deployments/1/statuses"
repository_url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/example"
transient_environment
boolean
Specifies if the given environment is will no longer exist at some point in the future. Default: false.
- Example
- true
production_environment
boolean
Specifies if the given environment is one that end-users directly interact with. Default: false.
- Example
- true
performed_via_github_app
object (performed_via_github_app) or null
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
id
int
required
Unique identifier of the GitHub app
- Example
- 37
slug
string
The slug name of the GitHub app
- Example
- "probot-owners"
node_id
string
required
- Example
- "MDExOkludGVncmF0aW9uMQ=="
owner
object (owner) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
name
string
required
The name of the GitHub app
- Example
- "Probot Owners"
description
string or null
required
- Example
- "The description of the app."
external_url
string
uri
required
- Example
- "https://example.com"
html_url
string
uri
required
- Example
- "https://github.com/apps/super-ci"
created_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
updated_at
string
date-time
required
- Example
- "2017-07-08T16:18:44-04:00"
permissions
object (permissions)
required
The set of permissions for the GitHub app
- Example
- { "issues": "read", "deployments": "write" }
issues
string
checks
string
metadata
string
contents
string
deployments
string
events
array[string]
required
The list of events for the GitHub app
- Example
- [ "label", "deployment" ]
string
installations_count
int
The number of installations associated with the GitHub app
- Example
- 5
client_id
string
- Example
- "\"Iv1.25b5d1e65ffc4022\""
client_secret
string
- Example
- "\"1d4b2097ac622ba702d19de498f005747a8b21d3\""
webhook_secret
string or null
- Example
- "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\""
pem
string
- Example
- "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\""
Re-run a workflow
Re-runs your workflow run using its id
. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
enable_debug_logging
boolean
Whether to enable debug logging for the re-run.
- Default
- false
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
Request
null
Response
Response
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Re-run failed jobs from a workflow run
Re-run all of the failed jobs and their dependent jobs in a workflow run using the id
of the workflow run. You must authenticate using an access token with the repo
scope to use this endpoint.
enable_debug_logging
boolean
Whether to enable debug logging for the re-run.
- Default
- false
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
run_id
int
required
The unique identifier of the workflow run.
Request
null
Response
Response
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List repository secrets
Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"total_count": 2,
"secrets": [
{
"name": "GH_TOKEN",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z"
},
{
"name": "GIST_ID",
"created_at": "2020-01-10T10:59:22Z",
"updated_at": "2020-01-11T11:59:22Z"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
secrets
array[object (Actions Secret)]
required
Actions Secret
object (Actions Secret)
Set secrets for GitHub Actions.
name
string
required
The name of the secret.
- Example
- "SECRET_TOKEN"
created_at
string
date-time
required
updated_at
string
date-time
required
Link
string
Get a repository public key
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the secrets
repository permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"key_id": "012345678912345678",
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
key_id
string
required
The identifier for the key.
- Example
- "1234567"
key
string
required
The Base64 encoded public key.
- Example
- "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs="
id
int
- Example
- 2
url
string
- Example
- "https://api.github.com/user/keys/2"
title
string
- Example
- "ssh-rsa AAAAB3NzaC1yc2EAAA"
created_at
string
- Example
- "2011-01-26T19:01:12Z"
Get a repository secret
Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
secret_name
string
required
The name of the secret.
Response
Response
{
"name": "GH_TOKEN",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
name
string
required
The name of the secret.
- Example
- "SECRET_TOKEN"
created_at
string
date-time
required
updated_at
string
date-time
required
Create or update a repository secret
Creates or updates a repository secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use
this endpoint.
Example encrypting a secret using Node.js
Encrypt your secret using the libsodium-wrappers library.
const sodium = require('libsodium-wrappers')
const secret = 'plain-text-secret' // replace with the secret you want to encrypt
const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
//Check if libsodium is ready and then proceed.
sodium.ready.then(() => {
// Convert Secret & Base64 key to Uint8Array.
let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
let binsec = sodium.from_string(secret)
//Encrypt the secret using LibSodium
let encBytes = sodium.crypto_box_seal(binsec, binkey)
// Convert encrypted Uint8Array to Base64
let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
console.log(output)
});
Example encrypting a secret using Python
Encrypt your secret using pynacl with Python 3.
from base64 import b64encode
from nacl import encoding, public
def encrypt(public_key: str, secret_value: str) -> str:
"""Encrypt a Unicode string using the public key."""
public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
sealed_box = public.SealedBox(public_key)
encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
return b64encode(encrypted).decode("utf-8")
Example encrypting a secret using C#
Encrypt your secret using the Sodium.Core package.
var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
Example encrypting a secret using Ruby
Encrypt your secret using the rbnacl gem.
require "rbnacl"
require "base64"
key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)
box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")
# Print the base64 encoded secret
puts Base64.strict_encode64(encrypted_secret)
encrypted_value
string
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$
Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
key_id
string
ID of the key you used to encrypt the secret.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
secret_name
string
required
The name of the secret.
Request
{
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
Response
Response when creating a secret
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Response when updating a secret
Empty response
Delete a repository secret
Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
secret_name
string
required
The name of the secret.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List repository variables
Lists all repository variables. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions_variables:read
repository permission to use this endpoint.
per_page
int
The number of results per page (max 30).
- Default
- 10
page
int
Page number of the results to fetch.
- Default
- 1
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"total_count": 2,
"variables": [
{
"name": "USERNAME",
"value": "octocat",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z"
},
{
"name": "EMAIL",
"value": "octocat@github.com",
"created_at": "2020-01-10T10:59:22Z",
"updated_at": "2020-01-11T11:59:22Z"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
variables
array[object (Actions Variable)]
required
Actions Variable
object (Actions Variable)
name
string
required
The name of the variable.
- Example
- "USERNAME"
value
string
required
The value of the variable.
- Example
- "octocat"
created_at
string
date-time
required
The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
updated_at
string
date-time
required
The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
Link
string
Create a repository variable
Creates a repository variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub Apps must have the actions_variables:write
repository permission to use this endpoint.
name
string
required
The name of the variable.
value
string
required
The value of the variable.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Request
{
"name": "USERNAME",
"value": "octocat"
}
Response
Response
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get a repository variable
Gets a specific variable in a repository. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions_variables:read
repository permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
name
string
required
The name of the variable.
Response
Response
{
"name": "USERNAME",
"value": "octocat",
"created_at": "2021-08-10T14:59:22Z",
"updated_at": "2022-01-10T14:59:22Z"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
name
string
required
The name of the variable.
- Example
- "USERNAME"
value
string
required
The value of the variable.
- Example
- "octocat"
created_at
string
date-time
required
The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
updated_at
string
date-time
required
The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
Delete a repository variable
Deletes a repository variable using the variable name.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub Apps must have the actions_variables:write
repository permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
name
string
required
The name of the variable.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Update a repository variable
Updates a repository variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub Apps must have the actions_variables:write
repository permission to use this endpoint.
name
string
The name of the variable.
value
string
The value of the variable.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
name
string
required
The name of the variable.
Request
{
"name": "USERNAME",
"value": "octocat"
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List repository workflows
Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
Response
Response
{
"total_count": 2,
"workflows": [
{
"id": 161335,
"node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
"name": "CI",
"path": ".github/workflows/blank.yaml",
"state": "active",
"created_at": "2020-01-08T23:48:37.000-08:00",
"updated_at": "2020-01-08T23:50:21.000-08:00",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335",
"html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
"badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg"
},
{
"id": 269289,
"node_id": "MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==",
"name": "Linter",
"path": ".github/workflows/linter.yaml",
"state": "active",
"created_at": "2020-01-08T23:48:37.000-08:00",
"updated_at": "2020-01-08T23:50:21.000-08:00",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289",
"html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289",
"badge_url": "https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
workflows
array[object (Workflow)]
required
Workflow
object (Workflow)
A GitHub Actions workflow
id
int
required
- Example
- 5
node_id
string
required
- Example
- "MDg6V29ya2Zsb3cxMg=="
name
string
required
- Example
- "CI"
path
string
required
- Example
- "ruby.yaml"
state
string
required
- Enum
-
- active
- deleted
- disabled_fork
- disabled_inactivity
- disabled_manually
- Example
- "active"
created_at
string
date-time
required
- Example
- "2019-12-06T14:20:20.000Z"
updated_at
string
date-time
required
- Example
- "2019-12-06T14:20:20.000Z"
url
string
required
- Example
- "https://api.github.com/repos/actions/setup-ruby/workflows/5"
html_url
string
required
- Example
- "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml"
badge_url
string
required
- Example
- "https://github.com/actions/setup-ruby/workflows/CI/badge.svg"
deleted_at
string
date-time
- Example
- "2019-12-06T14:20:20.000Z"
Link
string
Get a workflow
Gets a specific workflow. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
workflow_id
One Of
required
The ID of the workflow. You can also pass the workflow file name as a string.
int
string
Response
Response
{
"id": 161335,
"node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
"name": "CI",
"path": ".github/workflows/blank.yaml",
"state": "active",
"created_at": "2020-01-08T23:48:37.000-08:00",
"updated_at": "2020-01-08T23:50:21.000-08:00",
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335",
"html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
"badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
id
int
required
- Example
- 5
node_id
string
required
- Example
- "MDg6V29ya2Zsb3cxMg=="
name
string
required
- Example
- "CI"
path
string
required
- Example
- "ruby.yaml"
state
string
required
- Enum
-
- active
- deleted
- disabled_fork
- disabled_inactivity
- disabled_manually
- Example
- "active"
created_at
string
date-time
required
- Example
- "2019-12-06T14:20:20.000Z"
updated_at
string
date-time
required
- Example
- "2019-12-06T14:20:20.000Z"
url
string
required
- Example
- "https://api.github.com/repos/actions/setup-ruby/workflows/5"
html_url
string
required
- Example
- "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml"
badge_url
string
required
- Example
- "https://github.com/actions/setup-ruby/workflows/CI/badge.svg"
deleted_at
string
date-time
- Example
- "2019-12-06T14:20:20.000Z"
Disable a workflow
Disables a workflow and sets the state
of the workflow to disabled_manually
. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
workflow_id
One Of
required
The ID of the workflow. You can also pass the workflow file name as a string.
int
string
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Create a workflow dispatch event
You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must configure your GitHub Actions workflow to run when the workflow_dispatch
webhook event occurs. The inputs
are configured in the workflow file. For more information about how to configure the workflow_dispatch
event in the workflow file, see "Events that trigger workflows."
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint. For more information, see "Creating a personal access token for the command line."
ref
string
required
The git reference for the workflow. The reference can be a branch or tag name.
inputs
object (inputs)
Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs
are omitted.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
workflow_id
One Of
required
The ID of the workflow. You can also pass the workflow file name as a string.
int
string
Request
{
"ref": "topic-branch",
"inputs": {
"name": "Mona the Octocat",
"home": "San Francisco, CA"
}
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Enable a workflow
Enables a workflow and sets the state
of the workflow to active
. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
workflow_id
One Of
required
The ID of the workflow. You can also pass the workflow file name as a string.
int
string
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List workflow runs for a workflow
List all workflow runs for a workflow. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope.
actor
string
Returns someone's workflow runs. Use the login for the user who created the push
associated with the check suite or workflow run.
branch
string
Returns workflow runs associated with a branch. Use the name of the branch of the push
.
event
string
Returns workflow run triggered by the event you specify. For example, push
, pull_request
or issue
. For more information, see "Events that trigger workflows."
status
string
Returns workflow runs with the check run status
or conclusion
that you specify. For example, a conclusion can be success
or a status can be in_progress
. Only GitHub can set a status of waiting
or requested
.
- Enum
-
- completed
- action_required
- cancelled
- failure
- neutral
- skipped
- stale
- success
- timed_out
- in_progress
- queued
- requested
- waiting
- pending
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
created
string
date-time
Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."
exclude_pull_requests
boolean
If true
pull requests are omitted from the response (empty array).
- Default
- false
check_suite_id
int
Returns workflow runs with the check_suite_id
that you specify.
head_sha
string
Only returns workflow runs that are associated with the specified head_sha
.
owner
string
required
The account owner of the repository. The name is not case sensitive.
repo
string
required
The name of the repository. The name is not case sensitive.
workflow_id
One Of
required
The ID of the workflow. You can also pass the workflow file name as a string.
int
string
Response
Response
{
"total_count": 1,
"workflow_runs": [
{
"id": 30433642,
"name": "Build",
"node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==",
"check_suite_id": 42,
"check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==",
"head_branch": "master",
"head_sha": "acb5820ced9479c074f688cc328bf03f341a511d",
"run_number": 562,
"event": "push",
"status": "queued",
"conclusion": null,
"workflow_id": 159038,
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642",
"html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642",
"pull_requests": [],
"created_at": "2020-01-22T19:33:08Z",
"updated_at": "2020-01-22T19:33:08Z",
"actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"run_attempt": 1,
"run_started_at": "2020-01-22T19:33:08Z",
"triggering_actor": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs",
"logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs",
"check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374",
"artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts",
"cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel",
"rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun",
"workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038",
"head_commit": {
"id": "acb5820ced9479c074f688cc328bf03f341a511d",
"tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223",
"message": "Create linter.yaml",
"timestamp": "2020-01-22T19:33:05Z",
"author": {
"name": "Octo Cat",
"email": "octocat@github.com"
},
"committer": {
"name": "GitHub",
"email": "noreply@github.com"
}
},
"repository": {
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://api.github.com/repos/octocat/Hello-World",
"archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
"deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
"downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
"events_url": "https://api.github.com/repos/octocat/Hello-World/events",
"forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
"git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
"merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
"milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
"tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
"teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
"trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
"hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"head_repository": {
"id": 217723378,
"node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=",
"name": "octo-repo",
"full_name": "octo-org/octo-repo",
"private": true,
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"html_url": "https://github.com/octo-org/octo-repo",
"description": null,
"fork": false,
"url": "https://api.github.com/repos/octo-org/octo-repo",
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments"
}
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
workflow_runs
array[object (Workflow Run)]
required
Workflow Run
object (Workflow Run)
An invocation of a workflow
id
int
required
The ID of the workflow run.
- Example
- 5
name
string or null
The name of the workflow run.
- Example
- "Build"
node_id
string
required
- Example
- "MDEwOkNoZWNrU3VpdGU1"
check_suite_id
int
The ID of the associated check suite.
- Example
- 42
check_suite_node_id
string
The node ID of the associated check suite.
- Example
- "MDEwOkNoZWNrU3VpdGU0Mg=="
head_branch
string or null
required
- Example
- "master"
head_sha
string
required
The SHA of the head commit that points to the version of the workflow being run.
- Example
- "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
path
string
required
The full path of the workflow
- Example
- "octocat/octo-repo/.github/workflows/ci.yml@main"
run_number
int
required
The auto incrementing run number for the workflow run.
- Example
- 106
run_attempt
int
Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.
- Example
- 1
referenced_workflows
array[object (Referenced workflow)] or null
Referenced workflow
object (Referenced workflow)
A workflow referenced/reused by the initial caller workflow
path
string
required
sha
string
required
ref
string
event
string
required
- Example
- "push"
status
string or null
required
- Example
- "completed"
conclusion
string or null
required
- Example
- "neutral"
workflow_id
int
required
The ID of the parent workflow.
- Example
- 5
url
string
required
The URL to the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5"
html_url
string
required
- Example
- "https://github.com/github/hello-world/suites/4"
pull_requests
array[object (Pull Request Minimal)] or null
required
Pull Request Minimal
object (Pull Request Minimal)
id
int
required
number
int
required
url
string
required
head
object (head)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
base
object (base)
required
ref
string
required
sha
string
required
repo
object (repo)
required
id
int
required
url
string
required
name
string
required
created_at
string
date-time
required
updated_at
string
date-time
required
actor
object (actor)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
triggering_actor
object (triggering_actor)
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
run_started_at
string
date-time
The start time of the latest run. Resets on re-run.
jobs_url
string
required
The URL to the jobs for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs"
logs_url
string
required
The URL to download the logs for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/logs"
check_suite_url
string
required
The URL to the associated check suite.
- Example
- "https://api.github.com/repos/github/hello-world/check-suites/12"
artifacts_url
string
required
The URL to the artifacts for the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts"
cancel_url
string
required
The URL to cancel the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel"
rerun_url
string
required
The URL to rerun the workflow run.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun"
previous_attempt_url
string or null
The URL to the previous attempted run of this workflow, if one exists.
- Example
- "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3"
workflow_url
string
required
The URL to the workflow.
- Example
- "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml"
head_commit
object (head_commit) or null
required
A commit.
id
string
required
SHA for the commit
- Example
- "7638417db6d59f3c431d3e1f261cc637155684cd"
tree_id
string
required
SHA for the commit's tree
message
string
required
Message describing the purpose of the commit
- Example
- "Fix #42"
timestamp
string
date-time
required
Timestamp of the commit
- Example
- "2014-08-09T08:02:04+12:00"
author
object (author) or null
required
Information about the Git author
name
string
required
Name of the commit's author
- Example
- "Monalisa Octocat"
string
required
Git email address of the commit's author
- Example
- "monalisa.octocat@example.com"
committer
object (committer) or null
required
Information about the Git committer
name
string
required
Name of the commit's committer
- Example
- "Monalisa Octocat"
string
required
Git email address of the commit's committer
- Example
- "monalisa.octocat@example.com"
repository
object (repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
head_repository
object (head_repository)
required
Minimal Repository
id
int
required
- Example
- 1296269
node_id
string
required
- Example
- "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
name
string
required
- Example
- "Hello-World"
full_name
string
required
- Example
- "octocat/Hello-World"
owner
object (owner)
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
private
boolean
required
html_url
string
uri
required
- Example
- "https://github.com/octocat/Hello-World"
description
string or null
required
- Example
- "This your first repo!"
fork
boolean
required
url
string
uri
required
- Example
- "https://api.github.com/repos/octocat/Hello-World"
archive_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
assignees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
blobs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
branches_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
collaborators_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
comments_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
compare_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
contents_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
contributors_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/contributors"
deployments_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/deployments"
downloads_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/downloads"
events_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/events"
forks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/forks"
git_commits_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
git_refs_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
git_tags_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
git_url
string
issue_comment_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
issue_events_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
issues_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
keys_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
labels_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
languages_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/languages"
merges_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/merges"
milestones_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
notifications_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
pulls_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
releases_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
ssh_url
string
stargazers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/stargazers"
statuses_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
subscribers_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscribers"
subscription_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/subscription"
tags_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/tags"
teams_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/teams"
trees_url
string
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
clone_url
string
mirror_url
string or null
hooks_url
string
uri
required
- Example
- "http://api.github.com/repos/octocat/Hello-World/hooks"
svn_url
string
homepage
string or null
language
string or null
forks_count
int
stargazers_count
int
watchers_count
int
size
int
The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
default_branch
string
open_issues_count
int
is_template
boolean
topics
array[string]
string
has_issues
boolean
has_projects
boolean
has_wiki
boolean
has_pages
boolean
has_downloads
boolean
has_discussions
boolean
archived
boolean
disabled
boolean
visibility
string
pushed_at
string or null
date-time
- Example
- "2011-01-26T19:06:43Z"
created_at
string or null
date-time
- Example
- "2011-01-26T19:01:12Z"
updated_at
string or null
date-time
- Example
- "2011-01-26T19:14:43Z"
permissions
object (permissions)
admin
boolean
maintain
boolean
push
boolean
triage
boolean
pull
boolean
role_name
string
- Example
- "admin"
temp_clone_token
string
delete_branch_on_merge
boolean
subscribers_count
int
network_count
int
code_of_conduct
object (code_of_conduct)
Code Of Conduct
key
string
required
- Example
- "contributor_covenant"
name
string
required
- Example
- "Contributor Covenant"
url
string
uri
required
- Example
- "https://api.github.com/codes_of_conduct/contributor_covenant"
body
string
- Example
- "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n"
html_url
string or null
uri
required
license
object (license) or null
key
string
name
string
spdx_id
string
url
string
node_id
string
forks
int
- Example
- 0
open_issues
int
- Example
- 0
watchers
int
- Example
- 0
allow_forking
boolean
web_commit_signoff_required
boolean
- Example
- false
security_and_analysis
object (security_and_analysis) or null
advanced_security
object (advanced_security)
status
string
- Enum
-
- enabled
- disabled
secret_scanning
object (secret_scanning)
status
string
- Enum
-
- enabled
- disabled
secret_scanning_push_protection
object (secret_scanning_push_protection)
status
string
- Enum
-
- enabled
- disabled
head_repository_id
int
- Example
- 5
display_title
string
required
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.
- Example
- "Simple Workflow"
Link
string
List environment secrets
Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
repository_id
int
required
The unique identifier of the repository.
environment_name
string
required
The name of the environment.
Response
Response
{
"total_count": 2,
"secrets": [
{
"name": "GH_TOKEN",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z"
},
{
"name": "GIST_ID",
"created_at": "2020-01-10T10:59:22Z",
"updated_at": "2020-01-11T11:59:22Z"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
secrets
array[object (Actions Secret)]
required
Actions Secret
object (Actions Secret)
Set secrets for GitHub Actions.
name
string
required
The name of the secret.
- Example
- "SECRET_TOKEN"
created_at
string
date-time
required
updated_at
string
date-time
required
Link
string
Get an environment public key
Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the secrets
repository permission to use this endpoint.
repository_id
int
required
The unique identifier of the repository.
environment_name
string
required
The name of the environment.
Response
Response
{
"key_id": "012345678912345678",
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
key_id
string
required
The identifier for the key.
- Example
- "1234567"
key
string
required
The Base64 encoded public key.
- Example
- "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs="
id
int
- Example
- 2
url
string
- Example
- "https://api.github.com/user/keys/2"
title
string
- Example
- "ssh-rsa AAAAB3NzaC1yc2EAAA"
created_at
string
- Example
- "2011-01-26T19:01:12Z"
Get an environment secret
Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
repository_id
int
required
The unique identifier of the repository.
environment_name
string
required
The name of the environment.
secret_name
string
required
The name of the secret.
Response
Response
{
"name": "GH_TOKEN",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
name
string
required
The name of the secret.
- Example
- "SECRET_TOKEN"
created_at
string
date-time
required
updated_at
string
date-time
required
Create or update an environment secret
Creates or updates an environment secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use
this endpoint.
Example encrypting a secret using Node.js
Encrypt your secret using the libsodium-wrappers library.
const sodium = require('libsodium-wrappers')
const secret = 'plain-text-secret' // replace with the secret you want to encrypt
const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
//Check if libsodium is ready and then proceed.
sodium.ready.then(() => {
// Convert Secret & Base64 key to Uint8Array.
let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
let binsec = sodium.from_string(secret)
//Encrypt the secret using LibSodium
let encBytes = sodium.crypto_box_seal(binsec, binkey)
// Convert encrypted Uint8Array to Base64
let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
console.log(output)
});
Example encrypting a secret using Python
Encrypt your secret using pynacl with Python 3.
from base64 import b64encode
from nacl import encoding, public
def encrypt(public_key: str, secret_value: str) -> str:
"""Encrypt a Unicode string using the public key."""
public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
sealed_box = public.SealedBox(public_key)
encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
return b64encode(encrypted).decode("utf-8")
Example encrypting a secret using C#
Encrypt your secret using the Sodium.Core package.
var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
Example encrypting a secret using Ruby
Encrypt your secret using the rbnacl gem.
require "rbnacl"
require "base64"
key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)
box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")
# Print the base64 encoded secret
puts Base64.strict_encode64(encrypted_secret)
encrypted_value
string
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$
required
Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.
key_id
string
required
ID of the key you used to encrypt the secret.
repository_id
int
required
The unique identifier of the repository.
environment_name
string
required
The name of the environment.
secret_name
string
required
The name of the secret.
Request
{
"encrypted_value": "c2VjcmV0",
"key_id": "012345678912345678"
}
Response
Response when creating a secret
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
No schema
Response when updating a secret
Empty response
Delete an environment secret
Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
repository_id
int
required
The unique identifier of the repository.
environment_name
string
required
The name of the environment.
secret_name
string
required
The name of the secret.
Response
Default response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
List environment variables
Lists all environment variables. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the environments:read
repository permission to use this endpoint.
per_page
int
The number of results per page (max 30).
- Default
- 10
page
int
Page number of the results to fetch.
- Default
- 1
repository_id
int
required
The unique identifier of the repository.
environment_name
string
required
The name of the environment.
Response
Response
{
"total_count": 2,
"variables": [
{
"name": "USERNAME",
"value": "octocat",
"created_at": "2019-08-10T14:59:22Z",
"updated_at": "2020-01-10T14:59:22Z"
},
{
"name": "EMAIL",
"value": "octocat@github.com",
"created_at": "2020-01-10T10:59:22Z",
"updated_at": "2020-01-11T11:59:22Z"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
total_count
int
required
variables
array[object (Actions Variable)]
required
Actions Variable
object (Actions Variable)
name
string
required
The name of the variable.
- Example
- "USERNAME"
value
string
required
The value of the variable.
- Example
- "octocat"
created_at
string
date-time
required
The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
updated_at
string
date-time
required
The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
Link
string
Create an environment variable
Create an environment variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub Apps must have the environment:write
repository permission to use this endpoint.
name
string
required
The name of the variable.
value
string
required
The value of the variable.
repository_id
int
required
The unique identifier of the repository.
environment_name
string
required
The name of the environment.
Request
{
"name": "USERNAME",
"value": "octocat"
}
Response
Response
null
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Get an environment variable
Gets a specific variable in an environment. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the environments:read
repository permission to use this endpoint.
repository_id
int
required
The unique identifier of the repository.
environment_name
string
required
The name of the environment.
name
string
required
The name of the variable.
Response
Response
{
"name": "USERNAME",
"value": "octocat",
"created_at": "2021-08-10T14:59:22Z",
"updated_at": "2022-01-10T14:59:22Z"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
name
string
required
The name of the variable.
- Example
- "USERNAME"
value
string
required
The value of the variable.
- Example
- "octocat"
created_at
string
date-time
required
The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
updated_at
string
date-time
required
The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
- Example
- "2019-01-24T22:45:36.000Z"
Delete an environment variable
Deletes an environment variable using the variable name.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub Apps must have the environment:write
repository permission to use this endpoint.
repository_id
int
required
The unique identifier of the repository.
name
string
required
The name of the variable.
environment_name
string
required
The name of the environment.
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Update an environment variable
Updates an environment variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub Apps must have the environment:write
repository permission to use this endpoint.
name
string
The name of the variable.
value
string
The value of the variable.
repository_id
int
required
The unique identifier of the repository.
name
string
required
The name of the variable.
environment_name
string
required
The name of the environment.
Request
{
"name": "USERNAME",
"value": "octocat"
}
Response
Response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Was this page helpful?