GitHub (version v3.*.*)

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#

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.

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: 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

Accept#

Is used to set specified media type.

Type: string

X-GitHub-Media-Type#

You can check the current version of media type in responses.

Type: string

X-GitHub-Request-Id#

Type: string

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#

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.

Type: string

X-GitHub-Request-Id#

Type: string

X-GitHub-Request-Id#

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: string

X-GitHub-Request-Id#

Type: string

X-GitHub-Request-Id#

Type: string

X-GitHub-Request-Id#

Type: string

X-GitHub-Request-Id#

Type: string

X-GitHub-Request-Id#

Type: string

X-GitHub-Request-Id#

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: string

X-GitHub-Request-Id#

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) -&gt; 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)

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) -&gt; 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)

Type: string

X-GitHub-Request-Id#

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: 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

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#

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

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

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)#

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

You can check the current version of media type in responses.

Type: string

Type: string

You can check the current version of media type in responses.

Type: string

You can check the current version of media type in responses.

Type: string

Type: string

You can check the current version of media type in responses.

Type: string

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

You can check the current version of media type in responses.

Type: string

You can check the current version of media type in responses.

Type: string

Type: string

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.

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

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

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

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#

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.

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

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.

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#

edit_collaborator_for_repo#

X-GitHub-Request-Id#

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#

You can check the current version of media type in responses.

Type: string

X-GitHub-Request-Id#

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#

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

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.

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: string

X-GitHub-Request-Id#

Type: string

X-GitHub-Request-Id#

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

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

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

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

You can check the current version of media type in responses.

Type: string

You can check the current version of media type in responses.

Type: string

You can check the current version of media type in responses.

Type: string

Type: string

You can check the current version of media type in responses.

Type: string

You can check the current version of media type in responses.

Type: string

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

You can check the current version of media type in responses.

Type: string

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

You can check the current version of media type in responses.

Type: string

You can check the current version of media type in responses.

Type: string

You can check the current version of media type in responses.

Type: string

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

You can check the current version of media type in responses.

Type: string

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

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

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

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

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

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

Type: integer

get_team#

Get team.

Parameters

teamId (required)#

Id of team.

Type: integer

Accept#

Is used to set specified media type.

You can check the current version of media type in responses.

Type: string

X-GitHub-Request-Id#

Type: integer

get_user#

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#

Accept#

Is used to set specified media type.

Type: string

X-GitHub-Media-Type#

You can check the current version of media type in responses.

Type: string

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

Type: string

You can check the current version of media type in responses.

Type: string

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.

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

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

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

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

You can check the current version of media type in responses.

Type: string

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

You can check the current version of media type in responses.

Type: string

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#

Accept#

Is used to set specified media type.

Type: 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#

X-GitHub-Media-Type#

You can check the current version of media type in responses.

Type: string

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

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

You can check the current version of media type in responses.

Type: string

You can check the current version of media type in responses.

Type: string

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

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: 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: 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: 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

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

You can check the current version of media type in responses.

Type: string

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

Type: integer

direction#

Ignored without 'sort' parameter.

Type: string

sort#

Type: string

Potential values: due_date, completeness

state#

String to filter by state.

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.

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

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#

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

Is used to set specified media type.

Type: 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

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

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

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)#

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

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

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

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."

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: 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#

List requested reviewers for a pull request

Parameters

owner (required)#

Name of repository owner.

Type: string

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)#

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: 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

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.

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

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

You can check the current version of media type in responses.

Type: string

X-GitHub-Request-Id#

Type: integer

rerun_workflow#

Accept#

Is used to set specified media type.

Type: string

X-GitHub-Media-Type#

You can check the current version of media type in responses.

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.

Search repositories.

Parameters

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.

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.

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.

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#

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

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

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.

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

Type: integer