add_email_to_user
Add email address(es). You can post a single email address or an array of addresses.
Parameters
$body
Type: array
[ "string" ]
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
add_file_to_repo
Create a file.
Parameters
owner (required)
Name of repository owner.
Type: string
path (required)
The file path or directory. Set this to an empty string to get the contents of all files in the repository.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"committer" : {
"name" : "string",
"email" : "string"
},
"author" : {
"name" : "string",
"email" : "string"
},
"message" : "string",
"sha" : "string",
"branch" : "string",
"content" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
add_label_for_issue
Add labels to an issue.
Parameters
number (required)
Number of issue.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: array
[ "string" ]
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
add_repo_access_to_runner_group_in_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
repository_id (required)
Type: integer
runner_group_id (required)
Unique identifier of the self-hosted runner group.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
add_repo_for_team
In order to add a repository to a team, the authenticated user must be an owner of the org that the team is associated with. Also, the repository must be owned by the organization, or a direct fork of a repository owned by the organization.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
teamId (required)
Id of team.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
add_repo_to_org_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.
Parameters
org (required)
Name of organisation.
Type: string
repository_id (required)
Type: integer
secret_name (required)
secret_name parameter
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
add_runner_to_group_for_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
runner_group_id (required)
Unique identifier of the self-hosted runner group.
Type: integer
runner_id (required)
Unique identifier of the self-hosted runner.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
add_topic_to_repo
Parameters
owner (required)
Type: STRING
repo (required)
Type: STRING
topic (required)
Type: STRING
add_update_file_in_repo
Add or update file in repo if changes have been made. Do nothing if files are identical.
Parameters
content (required)
The new file content. This will be encoded during the operation in Base64.
Type: STRING
message (required)
The commit message.
Type: STRING
owner (required)
Name of repository owner.
Type: STRING
path (required)
Path to file.
Type: STRING
repo (required)
Name of repository.
Type: STRING
author
The author of the file. Default: The committer or the authenticated user if you omit committer.
Type: OBJECT
committer
The person that committed the file. Default: the authenticated user.
Type: OBJECT
ref
The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
Type: STRING
add_update_member_in_org
Add or update organization membership.
Parameters
org (required)
Name of organisation.
Type: string
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
role
Type: string
Potential values: admin, member
cancel_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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
run_id (required)
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
compare_commits
Compare two commits
Parameters
baseId (required)
Type: string
headId (required)
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_blob
Create a Blob.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"size" : "integer",
"encoding" : { },
"sha" : "string",
"content" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_branch_for_repo
Create a branch from another named branch. Default is from master.
Parameters
new_branch (required)
Name of new branch to create.
Type: STRING
owner (required)
Name of repository owner.
Type: STRING
repo (required)
Name of repository.
Type: STRING
from_branch
Branch to branch from.
Type: STRING
create_comment_for_commit
Create a commit comment.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
shaCode (required)
SHA-1 code of the commit.
Type: string
$body
Type: object
{
"number" : "Line number in the file to comment on. Defaults to null.",
"path" : "Relative path of the file to comment on.",
"line" : "Deprecated - Use position parameter instead.",
"position" : "Line index in the diff to comment on.",
"body" : "Required string",
"sha" : "SHA of the commit to comment on."
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_comment_for_gist
Create a comment
Parameters
id (required)
Id of gist.
Type: string
$body
Type: object
{
"body" : "Required string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_comment_for_issue
Create a comment.
Parameters
number (required)
Number of issue.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"body" : "Required string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_comment_for_pull_request
Create a comment. #TODO Alternative input ( http://developer.github.com/v3/pulls/comments/ ) description: | Alternative Input. Instead of passing commit_id, path, and position you can reply to an existing Pull Request Comment like this:
body Required string in_reply_to Required number - Comment id to reply to.
Parameters
number (required)
Id of pull.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"path" : "string",
"position" : "number",
"body" : "string",
"commit_id" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_deployment
Users with push access can create a deployment for a given ref
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"ref" : "string",
"payload" : {
"room_id" : "number",
"environment" : "string",
"deploy_user" : "string"
},
"description" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_fork
Create a fork. Forking a Repository happens asynchronously. Therefore, you may have to wai a short period before accessing the git objects. If this takes longer than 5 minutes, be sure to contact Support.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"organization" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_gists
Create a gist.
Parameters
$body
Type: object
{
"public" : "boolean",
"files" : {
"file1.txt" : {
"content" : "string"
}
},
"description" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_git_commit
Create a Commit.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"author" : {
"date" : "string",
"name" : "string",
"email" : "string"
},
"tree" : "Required string",
"message" : "Required string",
"parents" : [ "string" ]
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_git_ref
Create a Reference
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"ref" : "string",
"sha" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_git_tag
Create a Tag Object. Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"tagger" : {
"date" : "ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ",
"name" : "string",
"email" : "string"
},
"tag" : "string",
"message" : "string",
"sha" : "string",
"url" : "string",
"object" : {
"type" : "string",
"sha" : "string",
"url" : "string"
}
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_git_tree
Create a Tree. The tree creation API will take nested entries as well. If both a tree and a nested path modifying that tree are specified, it will overwrite the contents of that tree with the new path contents and write a new tree out.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"tree" : [ {
"mode" : "string",
"path" : "string",
"size" : "integer",
"type" : "string",
"sha" : "string",
"url" : "string"
} ],
"sha" : "string",
"url" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_hook_for_repo
Create a hook.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"active" : "boolean",
"add_events" : [ "string" ]
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_issue
Create an issue. Any user with pull access to a repository can create an issue.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"milestone" : "number",
"assignees" : [ "string" ],
"assignee" : "Deprecated. Use assignees instead.",
"body" : "string",
"title" : "string",
"labels" : [ "string" ]
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_key_for_repo
Create a key.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"title" : "string",
"key" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_key_for_user
Create a public key.
Parameters
$body
Type: object
{
"title" : "string",
"key" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_label_for_repo
Create a label.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: array
[ "string" ]
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_milestone
Create a milestone.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"description" : "string",
"state" : "string",
"title" : "string",
"due_on" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_or_update_org_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 tweetsodium library.
const sodium = require('tweetsodium');
const key = "base64-encoded-public-key";
const value = "plain-text-secret";
// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');
// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);
// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');
console.log(encrypted);
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)
Parameters
org (required)
Name of organisation.
Type: string
secret_name (required)
secret_name parameter
Type: string
$body
Type: object
{
"selected_repository_ids" : [ "string" ],
"visibility" : "Configures the access that repositories have to the organization secret. Can be one of: \n\\- `all` - All repositories in an organization can access the secret. \n\\- `private` - Private repositories in an organization can access the secret. \n\\- `selected` - Only specific repositories can access the secret.",
"key_id" : "ID of the key you used to encrypt the secret.",
"encrypted_value" : "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint."
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_or_update_repo_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 tweetsodium library.
const sodium = require('tweetsodium');
const key = "base64-encoded-public-key";
const value = "plain-text-secret";
// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');
// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);
// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');
console.log(encrypted);
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)
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
secret_name (required)
secret_name parameter
Type: string
$body
Type: object
{
"key_id" : "ID of the key you used to encrypt the secret.",
"encrypted_value" : "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint."
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_pull_request
Create a pull request.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"head" : "string",
"body" : "string",
"title" : "string",
"base" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_registration_token_for_org
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
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_registration_token_for_repo
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
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_release
Create a release Users with push access to the repository can create a release.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"tag_name" : "string",
"prerelease" : "boolean",
"target_commitish" : "string",
"draft" : "boolean",
"name" : "string",
"body" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_remove_token_for_org
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
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_remove_token_for_repo
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
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_repo_for_user
Create a new repository for the authenticated user. OAuth users must supply repo scope.
Parameters
$body
Type: object
{
"auto_init" : "True to create an initial commit with empty README. Default is false.",
"gitignore_template" : "Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\" Ignored if auto_init parameter is not provided.",
"private" : "True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account.",
"has_wiki" : "True to enable the wiki for this repository, false to disable it. Default is true.",
"has_downloads" : "True to enable downloads for this repository, false to disable them. Default is true.",
"name" : "Required string",
"description" : "string",
"team_id" : "The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization.",
"has_issues" : "True to enable issues for this repository, false to disable them. Default is true.",
"homepage" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_repo_in_org
Create a new repository for the authenticated user. OAuth users must supply repo scope.
Parameters
org (required)
Name of organisation.
Type: string
$body
Type: object
{
"auto_init" : "True to create an initial commit with empty README. Default is false.",
"gitignore_template" : "Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\" Ignored if auto_init parameter is not provided.",
"private" : "True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account.",
"has_wiki" : "True to enable the wiki for this repository, false to disable it. Default is true.",
"has_downloads" : "True to enable downloads for this repository, false to disable them. Default is true.",
"name" : "Required string",
"description" : "string",
"team_id" : "The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization.",
"has_issues" : "True to enable issues for this repository, false to disable them. Default is true.",
"homepage" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_runner_group_for_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
$body
Type: object
{
"selected_repository_ids" : [ "Unique identifier of the repository." ],
"visibility" : "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`.",
"name" : "Name of the runner group.",
"runners" : [ "Unique identifier of the runner." ]
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_status_for_deployment
Create a Deployment Status Users with push access can create deployment statuses for a given deployment:
Parameters
id (required)
The Deployment ID to list the statuses from.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"target_url" : "string",
"description" : "string",
"state" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_status_for_ref
Create a Status.
Parameters
owner (required)
Name of repository owner.
Type: string
ref (required)
Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"ref" : "string",
"url" : "string",
"object" : {
"type" : "string",
"sha" : "string",
"url" : "string"
}
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_team_in_org
Create team. In order to create a team, the authenticated user must be an owner of organization.
Parameters
org (required)
Name of organisation.
Type: string
$body
Type: object
{
"repo_names" : [ "string" ],
"name" : "Required string",
"permission" : { }
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_test_for_hook
Test a push hook. This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated. Note: Previously /repos/:owner/:repo/hooks/:id/tes
Parameters
hookId (required)
Id of hook.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
create_workflow_dispatch
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."
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
workflow_id (required)
The ID of the workflow. You can also pass the workflow file name as a string.
Type: object
{ }
$body
Type: object
{
"ref" : "The git reference for the workflow. The reference can be a branch or tag name.",
"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."
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_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.
Parameters
artifact_id (required)
artifact_id parameter
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_asset_for_release
Delete a release asset
Parameters
id (required)
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_branch_from_repo
Delete a branch.
Parameters
owner (required)
Name of repository owner.
Type: STRING
repo (required)
Name of repository.
Type: STRING
branch
Branch to delete.
Type: STRING
delete_collaborator_for_repo
Remove collaborator.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
user (required)
Login of the user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_comment_for_commit_in_repo
Delete a commit comment
Parameters
commentId (required)
Id of comment.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_comment_for_gist
Delete a comment.
Parameters
commentId (required)
Id of comment.
Type: integer
id (required)
Id of gist.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_comment_for_issue
Delete a comment.
Parameters
commentId (required)
Id of comment.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_comment_for_pull_request
Delete a comment.
Parameters
commentId (required)
Id of comment.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_file_in_repo
Delete a file. This method deletes a file in a repository.
Parameters
owner (required)
Name of repository owner.
Type: string
path (required)
The file path or directory. Set this to an empty string to get the contents of all files in the repository.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
branch
The branch name. Defaults to the repository’s default branch (usually master)
Type: string
message
The commit message.
Type: string
sha
The blob SHA of the file being replaced.
Type: string
delete_gist
Delete a gist.
Parameters
id (required)
Id of gist.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_git_ref
Delete a Reference Example: Deleting a branch: DELETE /repos/octocat/Hello-World/git/refs/heads/feature-a Example: Deleting a tag: DELETE /repos/octocat/Hello-World/git/refs/tags/v1.0
Parameters
owner (required)
Name of repository owner.
Type: string
ref (required)
Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_hook_for_repo
Delete a hook.
Parameters
hookId (required)
Id of hook.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_key_for_repo
Delete a key.
Parameters
keyId (required)
Id of key.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_key_for_user
Delete a public key. Removes a public key. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.
Parameters
keyId (required)
Id of key.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_label_for_repo
Delete a label.
Parameters
name (required)
Name of the label.
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_labels_for_issue
Remove all labels from an issue.
Parameters
number (required)
Number of issue.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_member_of_org
Remove a member. Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
Parameters
org (required)
Name of organisation.
Type: string
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_milestone
Delete a milestone.
Parameters
number (required)
Number of milestone.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_org_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.
Parameters
org (required)
Name of organisation.
Type: string
secret_name (required)
secret_name parameter
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_public_member_of_org
Conceal a user's membership.
Parameters
org (required)
Name of organisation.
Type: string
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_release
Users with push access to the repository can delete a release.
Parameters
id (required)
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_repo
Delete a Repository. Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_repo_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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
secret_name (required)
secret_name parameter
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_runner_from_org
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.
Parameters
org (required)
Name of organisation.
Type: string
runner_id (required)
Unique identifier of the self-hosted runner.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_runner_from_repo
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
runner_id (required)
Unique identifier of the self-hosted runner.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_runner_group_from_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
runner_group_id (required)
Unique identifier of the self-hosted runner group.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_subscription_for_repo
Delete a Repository Subscription.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_team
Delete team. In order to delete a team, the authenticated user must be an owner of the org that the team is associated with.
Parameters
teamId (required)
Id of team.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
delete_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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
run_id (required)
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
run_id (required)
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
disable_repo_for_actions_in_org
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.
Parameters
org (required)
Name of organisation.
Type: string
repository_id (required)
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
disable_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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
workflow_id (required)
The ID of the workflow. You can also pass the workflow file name as a string.
Type: object
{ }
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
download_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.
Parameters
archive_format (required)
Type: string
artifact_id (required)
artifact_id parameter
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
download_job_logs_for_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.
Parameters
job_id (required)
job_id parameter
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
run_id (required)
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_asset_for_release
Edit a release asset Users with push access to the repository can edit a release asset.
Parameters
id (required)
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"name" : "Required string",
"label" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_branch_protection_rules
update branch protection rules
Parameters
branch (required)
Name of the branch.
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"required_pull_request_reviews" : { },
"required_status_checks" : { },
"restrictions" : { },
"enforce_admins" : "boolean"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_collaborator_for_repo
Add collaborator.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
user (required)
Login of the user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_comment_for_commit_in_repo
Update a commit comment.
Parameters
commentId (required)
Id of comment.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"body" : "Required string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_comment_for_gist
Edit a comment.
Parameters
commentId (required)
Id of comment.
Type: integer
id (required)
Id of gist.
Type: string
$body
Type: object
{
"body" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_comment_for_issue
Edit a comment.
Parameters
commentId (required)
Id of comment.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"body" : "Required string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_comment_for_pull_request
Edit a comment.
Parameters
commentId (required)
Id of comment.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"body" : "Required string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_gist
Edit a gist.
Parameters
id (required)
Id of gist.
Type: string
$body
Type: object
{
"files" : {
"delete_this_file.txt" : "string",
"new_file.txt" : {
"content" : "string"
},
"file1.txt" : {
"content" : "string"
},
"old_name.txt" : {
"filename" : "string",
"content" : "string"
}
},
"description" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_git_ref
Update a Reference
Parameters
owner (required)
Name of repository owner.
Type: string
ref (required)
Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"force" : "boolean",
"sha" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_hook_for_repo
Edit a hook.
Parameters
hookId (required)
Id of hook.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"active" : "boolean",
"add_events" : [ "string" ]
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_issue
Edit an issue. Issue owners and users with push access can edit an issue.
Parameters
number (required)
Number of issue.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"milestone" : "number",
"assignees" : [ "string" ],
"assignee" : "Deprecated. Use assignees instead.",
"body" : "string",
"title" : "string",
"labels" : [ "string" ]
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_label_for_repo
Update a label.
Parameters
name (required)
Name of the label.
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: array
[ "string" ]
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_labels_for_issue
Replace all labels for an issue. Sending an empty array ([]) will remove all Labels from the Issue.
Parameters
number (required)
Number of issue.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: array
[ "string" ]
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_membership_for_user_on_team
Add team membership. In order to add a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with.
If the user is already a part of the team's organization (meaning they're on at least one other team in the organization), this endpoint will add the user to the team.
If the user is completely unaffiliated with the team's organization (meaning they're on none of the organization's teams), this endpoint will send an invitation to the user via email. This newly-created membership will be in the 'pending' state until the user accepts the invitation, at which point the membership will transition to the 'active' state and the user will be added as a member of the team.
Parameters
teamId (required)
Id of team.
Type: integer
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_milestone
Update a milestone.
Parameters
number (required)
Number of milestone.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"description" : "string",
"state" : "string",
"title" : "string",
"due_on" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_notification_thread_subscription
Set a Thread Subscription. This lets you subscribe to a thread, or ignore it. Subscribing to a thread is unnecessary if the user is already subscribed to the repository. Ignoring a thread will mute all future notifications (until you comment or get @mentioned).
Parameters
id (required)
Id of thread.
Type: integer
$body
Type: object
{
"ignored" : "boolean",
"subscribed" : "boolean",
"reason" : { },
"created_at" : "string",
"thread_url" : "string",
"url" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_org
Edit an Organization.
Parameters
org (required)
Name of organisation.
Type: string
$body
Type: object
{
"billing_email" : "Billing email address. This address is not publicized.",
"name" : "string",
"company" : "string",
"location" : "string",
"email" : "Publicly visible email address."
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_public_member_of_org
Publicize a user's membership.
Parameters
org (required)
Name of organisation.
Type: string
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_pull_request
Update a pull request.
Parameters
number (required)
Id of pull.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"state" : "string",
"body" : "string",
"title" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_release
Users with push access to the repository can edit a release
Parameters
id (required)
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"tag_name" : "string",
"prerelease" : "boolean",
"target_commitish" : "string",
"draft" : "boolean",
"name" : "string",
"body" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_repo
Edit repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"private" : "boolean",
"has_wiki" : "boolean",
"has_downloads" : "boolean",
"name" : "string",
"description" : "string",
"has_issues" : "boolean",
"homepage" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_subscription_for_repo
Set a Repository Subscription
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"ignored" : "boolean",
"subscribed" : "boolean"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_team
Edit team. In order to edit a team, the authenticated user must be an owner of the org that the team is associated with.
Parameters
teamId (required)
Id of team.
Type: integer
$body
Type: object
{
"name" : "Required string",
"permission" : { }
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
edit_user
Update the authenticated user.
Parameters
$body
Type: object
{
"hireable" : "boolean",
"name" : "string",
"bio" : "string",
"company" : "string",
"location" : "string",
"blog" : "string",
"email" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
enable_repos_for_actions_in_org
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.
Parameters
org (required)
Name of organisation.
Type: string
repository_id (required)
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
enable_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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
workflow_id (required)
The ID of the workflow. You can also pass the workflow file name as a string.
Type: object
{ }
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
follow_user
Follow a user. Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
fork_gist
Fork a gist.
Parameters
id (required)
Id of gist.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_actions_permissions_for_org
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.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_actions_permissions_for_repo
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_allowed_actions_for_org
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.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_allowed_actions_for_repo
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_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.
Parameters
artifact_id (required)
artifact_id parameter
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_asset_for_release
Get a single release asset
Parameters
id (required)
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_blob
Get a Blob. Since blobs can be any arbitrary binary data, the input and responses for the blob API takes an encoding parameter that can be either utf-8 or base64. If your data cannot be losslessly sent as a UTF-8 string, you can base64 encode it.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
shaCode (required)
SHA-1 code of the commit.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_branch_for_repo
Get Branch
Parameters
branch (required)
Name of the branch.
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_branch_protection_rules
List branch protection rules for a repo
Parameters
branch (required)
Name of the branch.
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_comment
Get a single comment.
Parameters
commentId (required)
Id of comment.
Type: integer
id (required)
Id of gist.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_comment_for_commit_in_repo
Get a single commit comment.
Parameters
commentId (required)
Id of comment.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_comment_for_issue
Get a single comment.
Parameters
commentId (required)
Id of comment.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_comment_for_pull_request
Get a single comment.
Parameters
commentId (required)
Id of comment.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_commit
Get a single commit.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
shaCode (required)
SHA-1 code of the commit.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_create_repo
Parameters
owner (required)
Type: STRING
repo (required)
Type: STRING
private
Type: BOOLEAN
get_emojis
Lists all the emojis available to use on GitHub.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_event_for_issue
Get a single event.
Parameters
eventId (required)
Id of the event.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_events
List public events.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_feeds
List Feeds. GitHub provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticating user.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_file_contents_from_repo
Get the contents of a single file in a repo. Returns an error if the path specified isn't for a single file.
Parameters
owner (required)
Name of repository owner.
Type: STRING
path (required)
Path to file.
Type: STRING
repo (required)
Name of repository.
Type: STRING
ref
The name of the commit/branch/tag. Default: the repository’s default branch (usually master)
Type: STRING
get_files_in_repo
Get contents. This method returns the contents of a file or directory in a repository. Files and symlinks support a custom media type for getting the raw content. Directories and submodules do not support custom media types. Note: This API supports files up to 1 megabyte in size. Here can be many outcomes. For details see "http://developer.github.com/v3/repos/contents/"
Parameters
owner (required)
Name of repository owner.
Type: string
path (required)
The file path or directory. Set this to an empty string to get the contents of all files in the repository.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
ref
The String name of the Commit/Branch/Tag. Defaults to 'master'.
Type: string
get_gist
Get a single gist.
Parameters
id (required)
Id of gist.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_git_commit
Get a Commit.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
shaCode (required)
SHA-1 code of the commit.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_git_ref
Get a Reference
Parameters
owner (required)
Name of repository owner.
Type: string
ref (required)
Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_git_tree
Get a Tree.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
shaCode (required)
SHA-1 code of the commit.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
recursive
Get a Tree Recursively. (0 or 1)
Type: integer
get_github_metadata
This gives some information about GitHub.com, the service.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_hook_for_repo
Get single hook.
Parameters
hookId (required)
Id of hook.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_issue
Get a single issue
Parameters
number (required)
Number of issue.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_job_for_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.
Parameters
job_id (required)
job_id parameter
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_key_for_repo
Get a key
Parameters
keyId (required)
Id of key.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_key_for_user
Get a single public key.
Parameters
keyId (required)
Id of key.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_label_for_repo
Get a single label.
Parameters
name (required)
Name of the label.
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_labels_for_issue
List labels on an issue.
Parameters
number (required)
Number of issue.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_members_of_team
List team members. In order to list members in a team, the authenticated user must be a member of the team.
Parameters
teamId (required)
Id of team.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_membership_for_user_on_team
Get team membership. In order to get a user's membership with a team, the authenticated user must be a member of the team or an owner of the team's organization.
Parameters
teamId (required)
Id of team.
Type: integer
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_milestone
Get a single milestone.
Parameters
number (required)
Number of milestone.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_notification_thread
View a single thread.
Parameters
id (required)
Id of thread.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_org
Get an Organization.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_org_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.
Parameters
org (required)
Name of organisation.
Type: string
secret_name (required)
secret_name parameter
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_public_key_for_org
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.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_public_key_for_repo
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_pull_request
Get a single pull request.
Parameters
number (required)
Id of pull.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_rate_limit
Get your current rate limit status Note: Accessing this endpoint does not count against your rate limit.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_readme
Get the README. This method returns the preferred README for a repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
ref
The String name of the Commit/Branch/Tag. Defaults to master.
Type: string
get_release
Get a single release
Parameters
id (required)
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_repo
Get repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_repo_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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
secret_name (required)
secret_name parameter
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_runner_for_org
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.
Parameters
org (required)
Name of organisation.
Type: string
runner_id (required)
Unique identifier of the self-hosted runner.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_runner_for_repo
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
runner_id (required)
Unique identifier of the self-hosted runner.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_runner_group_for_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
runner_group_id (required)
Unique identifier of the self-hosted runner group.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_subscription_for_repo
Get a Repository Subscription.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_team
Get team.
Parameters
teamId (required)
Id of team.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_template
Get a single template.
Parameters
language (required)
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_user
Get a single user.
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_user_authenticated
Get the authenticated user.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
workflow_id (required)
The ID of the workflow. You can also pass the workflow file name as a string.
Type: object
{ }
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
run_id (required)
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_workflow_run_usage
Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "Managing billing for GitHub Actions".
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
run_id (required)
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
get_workflow_usage
Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "Managing billing for GitHub Actions".
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
workflow_id (required)
The ID of the workflow. You can also pass the workflow file name as a string.
Type: object
{ }
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
is_collaborator_for_repo
Check if user is a collaborator
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
user (required)
Login of the user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
is_gist_starred
Check if a gist is starred.
Parameters
id (required)
Id of gist.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
is_member_of_org
Check if a user is, publicly or privately, a member of the organization.
Parameters
org (required)
Name of organisation.
Type: string
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
is_notification_thread_subscribed
Get a Thread Subscription.
Parameters
id (required)
Id of thread.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
is_public_member_of_org
Check public membership.
Parameters
org (required)
Name of organisation.
Type: string
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
is_pull_request_merged
Get if a pull request has been merged.
Parameters
number (required)
Id of pull.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
is_repo_managed_by_team
Check if a team manages a repository
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
teamId (required)
Id of team.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
is_repo_starred
Check if you are starring a repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
is_repo_watched
Check if you are watching a repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
is_user_assigned_to_repo
Check assignee. You may also check to see if a particular user is an assignee for a repository.
Parameters
assignee (required)
Login of the assignee.
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
is_user_following_target_user
Check if one user follows another.
Parameters
targetUser (required)
Name of user.
Type: string
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_all_notifications
List your notifications. List all notifications for the current user, grouped by repository.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
all
True to show notifications marked as read.
Type: boolean
participating
True to show only notifications in which the user is directly participating or mentioned.
Type: boolean
since
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Example: "2012-10-09T23:39:01Z".
Type: string
list_all_repos
List all public repositories. This provides a dump of every public repository, in the order that they were created. Note: Pagination is powered exclusively by the since parameter. is the Link header to get the URL for the next page of repositories.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
since
The integer ID of the last Repository that you've seen.
Type: string
list_artifacts_for_repo
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_assets_for_release
List assets for a release
Parameters
id (required)
Type: string
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_assignees_for_repo
List assignees. This call lists all the available assignees (owner + collaborators) to which issues may be assigned.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_branches_for_repo
Get list of branches
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_collaborators_for_repo
List. When authenticating as an organization owner of an organization-owned repository, all organization owners are included in the list of collaborators. Otherwise, only users with access to the repository are returned in the collaborators list.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_comments_for_commit
List comments for a single commitList comments for a single commit.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
shaCode (required)
SHA-1 code of the commit.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_comments_for_commits_in_repo
List commit comments for a repository. Comments are ordered by ascending ID.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_comments_for_gist
List comments on a gist.
Parameters
id (required)
Id of gist.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_comments_for_issue
List comments on an issue.
Parameters
number (required)
Number of issue.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
since
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Example: "2012-10-09T23:39:01Z".
Type: string
list_comments_for_issues_in_repo
List comments in a repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
direction
Ignored without 'sort' parameter.
Type: string
since
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Example: "2012-10-09T23:39:01Z".
Type: string
sort
Type: string
Potential values: created, updated
list_comments_for_pull_request
List comments on a pull request.
Parameters
number (required)
Id of pull.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_comments_for_pull_requests
List comments in a repository. By default, Review Comments are ordered by ascending ID.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
direction
Ignored without 'sort' parameter.
Type: string
since
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Example: "2012-10-09T23:39:01Z".
Type: string
sort
Type: string
Potential values: created, updated
list_commits
List commits on a repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
author
GitHub login, name, or email by which to filter by commit author.
Type: string
path
Only commits containing this file path will be returned.
Type: string
sha
Sha or branch to start listing commits from.
Type: string
since
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Example: "2012-10-09T23:39:01Z".
Type: string
until
ISO 8601 Date - Only commits before this date will be returned.
Type: string
list_commits_for_pull_request
List commits on a pull request.
Parameters
number (required)
Id of pull.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_contributors_to_repo
Get list of contributors.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
anon
Set to 1 or true to include anonymous contributors in results.
Type: string
list_deployments
Users with pull access can view deployments for a repository
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_emails_for_user
List email addresses for a user. In the final version of the API, this method will return an array of hashes with extended information for each email address indicating if the address has been verified and if it's primary email address for GitHub. Until API v3 is finalized, use the application/vnd.github.v3 media type to get other response format.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_events_for_issue
List events for an issue.
Parameters
number (required)
Number of issue.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_events_for_issues_in_repo
List issue events for a repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_events_for_network
List public events for a network of repositories.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_events_for_org
List public events for an organization.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_events_for_repo
Get list of repository events.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_events_performed_for_user
If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_events_received_for_user
These are events that you'll only see public events.
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_events_received_public_for_user
List public events that a user has received
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_files_for_pull_requests
List pull requests files.
Parameters
number (required)
Id of pull.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_followers
List the authenticated user's followers
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_followers_for_user
List a user's followers
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_following
List who the authenticated user is following.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_following_for_user
Check if you are following a user.
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_forks
List forks.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
sort
Type: string
Potential values: newes, oldes, watchers
list_gists
List the authenticated user's gists or if called anonymously, this will return all public gists.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
since
Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.
Type: string
list_gists_for_user
List a users gists.
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
since
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Example: "2012-10-09T23:39:01Z".
Type: string
list_gists_public
List all public gists.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
since
Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.
Type: string
list_gists_starred
List the authenticated user's starred gists.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
since
Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.
Type: string
list_git_refs
Get all References
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_git_tags
Get a Tag.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
shaCode (required)
SHA-1 code of the commit.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_hooks_for_repo
Get list of hooks.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_issues
List issues. List all issues across all the authenticated user's visible repositories.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
direction
Type: string
Potential values: asc, desc
filter
Issues assigned to you / created by you / mentioning you / you're subscribed to updates for / All issues the authenticated user can see
Type: string
Potential values: assigned, created, mentioned, subscribed, all
labels
String list of comma separated Label names. Example - bug,ui,@high.
Type: string
since
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only issues updated at or after this time are returned.
Type: string
sort
Type: string
Potential values: created, updated, comments
state
Type: string
Potential values: open, closed
list_issues_for_org
List issues. List all issues for a given organization for the authenticated user.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
direction
Type: string
Potential values: asc, desc
filter
Issues assigned to you / created by you / mentioning you / you're subscribed to updates for / All issues the authenticated user can see
Type: string
Potential values: assigned, created, mentioned, subscribed, all
labels
String list of comma separated Label names. Example - bug,ui,@high.
Type: string
since
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only issues updated at or after this time are returned.
Type: string
sort
Type: string
Potential values: created, updated, comments
state
Type: string
Potential values: open, closed
list_issues_for_repo
List issues for a repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
direction
Type: string
Potential values: asc, desc
filter
Issues assigned to you / created by you / mentioning you / you're subscribed to updates for / All issues the authenticated user can see
Type: string
Potential values: assigned, created, mentioned, subscribed, all
labels
String list of comma separated Label names. Example - bug,ui,@high.
Type: string
since
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only issues updated at or after this time are returned.
Type: string
sort
Type: string
Potential values: created, updated, comments
state
Type: string
Potential values: open, closed
list_issues_for_user
List issues. List all issues across owned and member repositories for the authenticated user.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
direction
Type: string
Potential values: asc, desc
filter
Issues assigned to you / created by you / mentioning you / you're subscribed to updates for / All issues the authenticated user can see
Type: string
Potential values: assigned, created, mentioned, subscribed, all
labels
String list of comma separated Label names. Example - bug,ui,@high.
Type: string
since
Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only issues updated at or after this time are returned.
Type: string
sort
Type: string
Potential values: created, updated, comments
state
Type: string
Potential values: open, closed
list_jobs_for_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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
run_id (required)
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
filter
Filters jobs by their completed_at
timestamp. Can be one of:
* 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.
Type: string
Potential values: latest, all
list_keys
List your public keys. Lists the current user's keys. Management of public keys via the API requires that you are authenticated through basic auth, or OAuth with the 'user', 'write:public_key' scopes.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_keys_for_repo
Get list of keys.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_keys_for_user
List public keys for a user. Lists the verified public keys for a user. This is accessible by anyone.
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_labels_for_milestone
Get labels for every issue in a milestone.
Parameters
number (required)
Number of milestone.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_labels_for_repo
List all labels for this repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_languages
List languages. List languages for the specified repository. The value on the right of a language is the number of bytes of code written in that language.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_members_for_org
Members list. List all users who are members of an organization. A member is a user that belongs to at least 1 team in the organization. If the authenticated user is also an owner of this organization then both concealed and public members will be returned. If the requester is not an owner of the organization the query will be redirected to the public members list.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_milestones
List milestones for a repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
direction
Ignored without 'sort' parameter.
Type: string
sort
Type: string
Potential values: due_date, completeness
state
String to filter by state.
Type: string
Potential values: open, closed
list_notifications_for_repo
List your notifications in a repository List all notifications for the current user.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
all
True to show notifications marked as read.
Type: boolean
participating
True to show only notifications in which the user is directly participating or mentioned.
Type: boolean
since
The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Example: "2012-10-09T23:39:01Z".
Type: string
list_org_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.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_orgs
List public and private organizations for the authenticated user.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_orgs_for_user
List all public organizations for a user.
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_public_members_of_org
Public members list. Members of an organization can choose to have their membership publicized or not.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_pull_requests
List pull requests.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
base
Filter pulls by base branch name. Example - gh-pages.
Type: string
head
Filter pulls by head user and branch name in the format of 'user:ref-name'. Example: github:new-script-format.
Type: string
state
String to filter by state.
Type: string
Potential values: open, closed
list_releases
Users with push access to the repository will receive all releases (i.e., published releases and draft releases). Users with pull access will receive published releases only
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_repo_access_to_runner_group_in_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
runner_group_id (required)
Unique identifier of the self-hosted runner group.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_repo_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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_repos
List repositories for the authenticated user. Note that this does not include repositories owned by organizations which the user can access. You can lis user organizations and list organization repositories separately.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
affiliation
Comma-separated list of values. Can include:
- owner: Repositories that are owned by the authenticated user.
- collaborator: Repositories that the user has been added to as a collaborator.
- organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
Type: string
direction
Can be one of asc or desc. Default: when using full_name: asc; otherwise desc
Type: string
sort
Type: string
Potential values: created, updated, pushed, full_name
type
Will cause a 422 error if used in the same request as visibility or affiliation.
Type: string
Potential values: all, owner, public, private, member
visibility
Type: string
Potential values: all, public, private
list_repos_enabled_for_actions_in_org
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.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_repos_for_org_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.
Parameters
org (required)
Name of organisation.
Type: string
secret_name (required)
secret_name parameter
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_repos_for_team
List team repos
Parameters
teamId (required)
Id of team.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_repos_for_user
List public repositories for the specified user.
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
direction
Can be one of asc or desc. Default: when using full_name: asc, otherwise desc.
Type: string
sort
Type: string
Potential values: created, updated, pushed, full_name
type
Type: string
Potential values: all, owner, member
list_repos_in_org
List repositories for the specified org.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
type
Type: string
Potential values: all, public, private, forks, sources, member
list_runner_applications_for_org
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.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_runner_applications_for_repo
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_runner_groups_for_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_runners_for_org
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.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_runners_for_repo
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo
scope to use this endpoint.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_runners_in_group_for_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
runner_group_id (required)
Unique identifier of the self-hosted runner group.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_stargazers_for_repo
List Stargazers.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_starred_repos_for_user
List repositories being starred by a user.
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_stars
List repositories being starred by the authenticated user.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
direction
Ignored without 'sort' parameter.
Type: string
sort
Type: string
Potential values: created, updated
list_statuses_for_deployment
Users with pull access can view deployment statuses for a deployment
Parameters
id (required)
The Deployment ID to list the statuses from.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_statuses_for_ref
List Statuses for a specific Ref.
Parameters
owner (required)
Name of repository owner.
Type: string
ref (required)
Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_subscribers_for_repo
List watchers.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_tags_for_repo
Get list of tags.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
X-GitHub-Request-Id
Type: integer
list_teams_for_repo
Get list of teams
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_teams_for_user
List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user or repo scope when authenticating via OAuth.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_teams_in_org
List teams.
Parameters
org (required)
Name of organisation.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_templates
Listing available templates. List all templates available to pass as an option when creating a repository.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_topics_for_repo
Get all repository topics.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_users
Get all users. This provides a dump of every user, in the order that they signed up for GitHub. Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
since
The integer ID of the last User that you've seen.
Type: integer
list_watched_repos
List repositories being watched by a user.
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_watched_repos_for_user
List repositories being watched by the authenticated user.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_watchers_for_repo
List Stargazers. New implementation.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
run_id (required)
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
list_workflow_runs
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
workflow_id (required)
The ID of the workflow. You can also pass the workflow file name as a string.
Type: object
{ }
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
actor
Returns someone's workflow runs. Use the login for the user who created the push
associated with the check suite or workflow run.
Type: string
branch
Returns workflow runs associated with a branch. Use the name of the branch of the push
.
Type: string
event
Returns workflow run triggered by the event you specify. For example, push
, pull_request
or issue
. For more information, see "Events that trigger workflows."
Type: string
status
Returns workflow runs associated with the check run status
or conclusion
you specify. For example, a conclusion can be success
or a status can be completed
. For more information, see the status
and conclusion
options available in "Create a check run."
Type: string
Potential values: completed, status, conclusion
list_workflow_runs_for_repo
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
actor
Returns someone's workflow runs. Use the login for the user who created the push
associated with the check suite or workflow run.
Type: string
branch
Returns workflow runs associated with a branch. Use the name of the branch of the push
.
Type: string
event
Returns workflow run triggered by the event you specify. For example, push
, pull_request
or issue
. For more information, see "Events that trigger workflows."
Type: string
status
Returns workflow runs associated with the check run status
or conclusion
you specify. For example, a conclusion can be success
or a status can be completed
. For more information, see the status
and conclusion
options available in "Create a check run."
Type: string
Potential values: completed, status, conclusion
list_workflows_for_repo
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
mark_notification_as_read
Mark as read. Marking a notification as "read" removes it from the default view on GitHub.com.
Parameters
$body
Type: object
{
"last_read_at" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
mark_notification_in_repo_as_read
Mark notifications as read in a repository. Marking all notifications in a repository as "read" removes them from the default view on GitHub.com.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"last_read_at" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
mark_notification_thread_as_read
Mark a thread as read
Parameters
id (required)
Id of thread.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
merge_pull_request
Merge a pull request (Merge Button's)
Parameters
number (required)
Id of pull.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"commit_message" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
merge_repo
Perform a merge.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"head" : "string",
"commit_message" : "string",
"base" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
mute_notification_thread_subscription
Delete a Thread Subscription.
Parameters
id (required)
Id of thread.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
post_markdown
Render an arbitrary Markdown document
Parameters
$body
Type: object
{
"mode" : "string",
"context" : "string",
"text" : "string"
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
post_markdown_raw
Render a Markdown document in raw mode
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
pr_list_requested_reviewer
List requested reviewers for a pull request
Parameters
owner (required)
Name of repository owner.
Type: string
pull_number (required)
Type: integer
repo (required)
Name of repository.
Type: string
page
What page to return. Starts at 1.
Type: integer
per_page
How many results to return per API call. Max 100.
Type: integer
pr_remove_requested_reviewers
Remove requested reviewers from a pull request
Parameters
owner (required)
Name of repository owner.
Type: string
pull_number (required)
Type: integer
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"team_reviewers" : [ "string" ],
"reviewers" : [ "string" ]
}
pr_request_reviewers
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.
Parameters
owner (required)
Name of repository owner.
Type: string
pull_number (required)
Type: integer
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"team_reviewers" : [ "string" ],
"reviewers" : [ "string" ]
}
remove_email_from_user
Delete email address(es). You can include a single email address or an array of addresses.
Parameters
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
remove_label_for_issue
Remove a label from an issue.
Parameters
name (required)
Name of the label.
Type: string
number (required)
Number of issue.
Type: integer
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
remove_membership_for_user_on_team
Remove team membership. In order to remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. NOTE: This does not delete the user, it just removes their membership from the team.
Parameters
teamId (required)
Id of team.
Type: integer
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
remove_repo_access_to_runner_group_in_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
repository_id (required)
Type: integer
runner_group_id (required)
Unique identifier of the self-hosted runner group.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
remove_repo_from_org_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.
Parameters
org (required)
Name of organisation.
Type: string
repository_id (required)
Type: integer
secret_name (required)
secret_name parameter
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
remove_repo_from_team
In order to remove a repository from a team, the authenticated user must be an owner of the org that the team is associated with. NOTE: This does not delete the repository, it just removes it from the team.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
teamId (required)
Id of team.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
remove_runner_from_group_for_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
runner_group_id (required)
Unique identifier of the self-hosted runner group.
Type: integer
runner_id (required)
Unique identifier of the self-hosted runner.
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
remove_topic_from_repo
Parameters
owner (required)
Type: STRING
repo (required)
Type: STRING
topic (required)
Type: STRING
replace_all_topics_for_repo
Replace all repository topics.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"names" : [ "string" ]
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
report_code_frequency_for_repo
Get the number of additions and deletions per week. Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
report_commit_activity_for_repo
Get the last year of commit activity data. Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
report_contributors_for_repo
Get contributors list with additions, deletions, and commit counts.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
report_org_dashboard_for_user
This is the user's organization dashboard. You must be authenticated as the user to view this.
Parameters
org (required)
Name of organisation.
Type: string
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
report_participation_for_repo
Get the weekly commit count for the repo owner and everyone else.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
report_punch_card_for_repo
Get the number of commits per hour in each day. Each array contains the day number, hour number, and number of commits 0-6 Sunday - Saturday 0-23 Hour of day Number of commits
For example, [2, 14, 25] indicates that there were 25 total commits, during the 2.00pm hour on Tuesdays. All times are based on the time zone of individual commits.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
report_status_combined_for_ref
Get the combined Status for a specific Ref The Combined status endpoint is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access this endpoint during the preview period, you must provide a custom media type in the Accept header: application/vnd.github.she-hulk-preview+json
Parameters
owner (required)
Name of repository owner.
Type: string
ref (required)
Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
rerun_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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
run_id (required)
Type: integer
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
search_code
Search code.
Parameters
q (required)
The search terms. This can be any combination of the supported code search parameters: 'Search In' Qualifies which fields are searched. With this qualifier you can restrict the search to just the file contents, the file path, or both. 'Languages' Searches code based on the language it's written in. 'Forks' Filters repositories based on the number of forks, and/or whether code from forked repositories should be included in the results at all. 'Size' Finds files that match a certain size (in bytes). 'Path' Specifies the path that the resulting file must be at. 'Extension' Matches files with a certain extension. 'Users' or 'Repositories' Limits searches to a specific user or repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
order
The sort field. if sort param is provided. Can be either asc or desc.
Type: string
Potential values: desc, asc
sort
Can only be 'indexed', which indicates how recently a file has been indexed by the GitHub search infrastructure. If not provided, results are sorted by best match.
Type: string
Potential values: indexed
search_issues
Find issues by state and keyword. (This method returns up to 100 results per page.)
Parameters
q (required)
The q search term can also contain any combination of the supported issue search qualifiers:
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
order
The sort field. if sort param is provided. Can be either asc or desc.
Type: string
Potential values: desc, asc
sort
The sort field. Can be comments, created, or updated. Default: results are sorted by best match.
Type: string
Potential values: updated, created, comments
search_repos
Search repositories.
Parameters
q (required)
The search terms. This can be any combination of the supported repository search parameters: 'Search In' Qualifies which fields are searched. With this qualifier you can restrict the search to just the repository name, description, readme, or any combination of these. 'Size' Finds repositories that match a certain size (in kilobytes). 'Forks' Filters repositories based on the number of forks, and/or whether forked repositories should be included in the results at all. 'Created' and 'Last Updated' Filters repositories based on times of creation, or when they were last updated. 'Users or Repositories' Limits searches to a specific user or repository. 'Languages' Searches repositories based on the language they are written in. 'Stars' Searches repositories based on the number of stars.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
order
The sort field. if sort param is provided. Can be either asc or desc.
Type: string
Potential values: desc, asc
per_page
How many results to return per API call. Max 100.
Type: integer
sort
If not provided, results are sorted by best match.
Type: string
Potential values: stars, forks, updated
search_users
Search users.
Parameters
q (required)
The search terms. This can be any combination of the supported user search parameters: 'Search In' Qualifies which fields are searched. With this qualifier you can restrict the search to just the username, public email, full name, location, or any combination of these. 'Repository count' Filters users based on the number of repositories they have. 'Location' Filter users by the location indicated in their profile. 'Language' Search for users that have repositories that match a certain language. 'Created' Filter users based on when they joined. 'Followers' Filter users based on the number of followers they have.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
order
The sort field. if sort param is provided. Can be either asc or desc.
Type: string
Potential values: desc, asc
sort
If not provided, results are sorted by best match.
Type: string
Potential values: followers, repositories, joined
set_actions_permissions_for_org
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.
Parameters
org (required)
Name of organisation.
Type: string
$body
Type: object
{
"enabled_repositories" : "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.",
"allowed_actions" : "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`."
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
set_actions_permissions_for_repo
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"allowed_actions" : "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.",
"enabled" : "Whether GitHub Actions is enabled on the repository."
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
set_allowed_actions_for_org
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.
Parameters
org (required)
Name of organisation.
Type: string
$body
Type: object
{
"patterns_allowed" : [ "string" ],
"verified_allowed" : "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.",
"github_owned_allowed" : "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
set_allowed_actions_for_repo
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.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
$body
Type: object
{
"patterns_allowed" : [ "string" ],
"verified_allowed" : "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.",
"github_owned_allowed" : "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
set_repo_access_to_runner_group_in_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
runner_group_id (required)
Unique identifier of the self-hosted runner group.
Type: integer
$body
Type: object
{
"selected_repository_ids" : [ "Unique identifier of the repository." ]
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
set_repos_enabled_for_actions_in_org
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.
Parameters
org (required)
Name of organisation.
Type: string
$body
Type: object
{
"selected_repository_ids" : [ "Unique identifier of the repository." ]
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
set_repos_for_org_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.
Parameters
org (required)
Name of organisation.
Type: string
secret_name (required)
secret_name parameter
Type: string
$body
Type: object
{
"selected_repository_ids" : [ "integer" ]
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
set_runners_in_group_for_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
runner_group_id (required)
Unique identifier of the self-hosted runner group.
Type: integer
$body
Type: object
{
"runners" : [ "Unique identifier of the runner." ]
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
star_gist
Star a gist.
Parameters
id (required)
Id of gist.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
star_repo
Star a repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
transfer_repo
Transfer a repository. This API is currently available for developers to preview. see https://developer.github.com/changes/2017-11-09-repository-transfer-api-preview/
Parameters
owner (required)
The original owner of the repo
Type: string
repo (required)
The repository name
Type: string
$body
Type: object
{
"new_owner" : "The username or organization name the repository will be transferred to.",
"team_ids" : [ "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories." ]
}
Accept
Is used to set specified media type.
Type: string
unfollow_user
Unfollow a user. Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
Parameters
username (required)
Name of user.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
unstar_gist
Unstar a gist.
Parameters
id (required)
Id of gist.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
unstar_repo
Unstar a repository
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
unwatch_repo
Stop watching a repository
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
update_runner_group_for_org
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products."
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.
Parameters
org (required)
Name of organisation.
Type: string
runner_group_id (required)
Unique identifier of the self-hosted runner group.
Type: integer
$body
Type: object
{
"visibility" : "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`.",
"name" : "Name of the runner group."
}
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer
watch_repo
Watch a repository.
Parameters
owner (required)
Name of repository owner.
Type: string
repo (required)
Name of repository.
Type: string
Accept
Is used to set specified media type.
Type: string
X-GitHub-Media-Type
You can check the current version of media type in responses.
Type: string
X-GitHub-Request-Id
Type: integer