View Source GitHub.Actions (GitHub REST API Client v0.3.3)

@type get_actions_cache_usage_by_repo_for_org_200_json_resp() :: %{
  __info__: map(),
  repository_cache_usages: [GitHub.Actions.CacheUsageByRepository.t()],
  total_count: integer()
}

list_artifacts_for_repo_200_json_resp()

@type list_artifacts_for_repo_200_json_resp() :: %{
  __info__: map(),
  artifacts: [GitHub.Artifact.t()],
  total_count: integer()
}

list_environment_secrets_200_json_resp()

@type list_environment_secrets_200_json_resp() :: %{
  __info__: map(),
  secrets: [GitHub.Actions.Secret.t()],
  total_count: integer()
}

list_environment_variables_200_json_resp()

@type list_environment_variables_200_json_resp() :: %{
  __info__: map(),
  total_count: integer(),
  variables: [GitHub.Actions.Variable.t()]
}

list_jobs_for_workflow_run_200_json_resp()

@type list_jobs_for_workflow_run_200_json_resp() :: %{
  __info__: map(),
  jobs: [GitHub.Actions.Job.t()],
  total_count: integer()
}

list_jobs_for_workflow_run_attempt_200_json_resp()

@type list_jobs_for_workflow_run_attempt_200_json_resp() :: %{
  __info__: map(),
  jobs: [GitHub.Actions.Job.t()],
  total_count: integer()
}

list_org_secrets_200_json_resp()

@type list_org_secrets_200_json_resp() :: %{
  __info__: map(),
  secrets: [GitHub.Organization.ActionsSecret.t()],
  total_count: integer()
}

list_org_variables_200_json_resp()

@type list_org_variables_200_json_resp() :: %{
  __info__: map(),
  total_count: integer(),
  variables: [GitHub.Organization.ActionsVariable.t()]
}

list_repo_organization_secrets_200_json_resp()

@type list_repo_organization_secrets_200_json_resp() :: %{
  __info__: map(),
  secrets: [GitHub.Actions.Secret.t()],
  total_count: integer()
}

list_repo_organization_variables_200_json_resp()

@type list_repo_organization_variables_200_json_resp() :: %{
  __info__: map(),
  total_count: integer(),
  variables: [GitHub.Actions.Variable.t()]
}

list_repo_secrets_200_json_resp()

@type list_repo_secrets_200_json_resp() :: %{
  __info__: map(),
  secrets: [GitHub.Actions.Secret.t()],
  total_count: integer()
}

list_repo_variables_200_json_resp()

@type list_repo_variables_200_json_resp() :: %{
  __info__: map(),
  total_count: integer(),
  variables: [GitHub.Actions.Variable.t()]
}

list_repo_workflows_200_json_resp()

@type list_repo_workflows_200_json_resp() :: %{
  __info__: map(),
  total_count: integer(),
  workflows: [GitHub.Actions.Workflow.t()]
}

list_selected_repos_for_org_secret_200_json_resp()

@type list_selected_repos_for_org_secret_200_json_resp() :: %{
  __info__: map(),
  repositories: [GitHub.Repository.minimal()],
  total_count: integer()
}

list_selected_repos_for_org_variable_200_json_resp()

@type list_selected_repos_for_org_variable_200_json_resp() :: %{
  __info__: map(),
  repositories: [GitHub.Repository.minimal()],
  total_count: integer()
}

list_selected_repositories_enabled_github_actions_organization_200_json_resp()

@type list_selected_repositories_enabled_github_actions_organization_200_json_resp() ::
  %{
    __info__: map(),
    repositories: [GitHub.Repository.t()],
    total_count: number()
  }

list_self_hosted_runners_for_org_200_json_resp()

@type list_self_hosted_runners_for_org_200_json_resp() :: %{
  __info__: map(),
  runners: [GitHub.Actions.Runner.t()],
  total_count: integer()
}

list_self_hosted_runners_for_repo_200_json_resp()

@type list_self_hosted_runners_for_repo_200_json_resp() :: %{
  __info__: map(),
  runners: [GitHub.Actions.Runner.t()],
  total_count: integer()
}

list_workflow_run_artifacts_200_json_resp()

@type list_workflow_run_artifacts_200_json_resp() :: %{
  __info__: map(),
  artifacts: [GitHub.Artifact.t()],
  total_count: integer()
}

list_workflow_runs_200_json_resp()

@type list_workflow_runs_200_json_resp() :: %{
  __info__: map(),
  total_count: integer(),
  workflow_runs: [GitHub.Actions.Workflow.Run.t()]
}

list_workflow_runs_for_repo_200_json_resp()

@type list_workflow_runs_for_repo_200_json_resp() :: %{
  __info__: map(),
  total_count: integer(),
  workflow_runs: [GitHub.Actions.Workflow.Run.t()]
}

Link to this section Functions

add_custom_labels_to_self_hosted_runner_for_org(org, runner_id, body, opts \\ [])

@spec add_custom_labels_to_self_hosted_runner_for_org(
  String.t(),
  integer(),
  map(),
  keyword()
) ::
  {:ok, GitHub.Actions.Runner.Labels.json_resp()} | {:error, GitHub.Error.t()}

Add custom labels to a self-hosted runner for an organization

Adds custom labels to a self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

resources
Resources

API method documentation

add_custom_labels_to_self_hosted_runner_for_repo(owner, repo, runner_id, body, opts \\ [])

@spec add_custom_labels_to_self_hosted_runner_for_repo(
  String.t(),
  String.t(),
  integer(),
  map(),
  keyword()
) ::
  {:ok, GitHub.Actions.Runner.Labels.json_resp()} | {:error, GitHub.Error.t()}

Add custom labels to a self-hosted runner for a repository

Adds custom labels to a self-hosted runner configured in a repository.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

add_selected_repo_to_org_secret(org, secret_name, repository_id, opts \\ [])

@spec add_selected_repo_to_org_secret(String.t(), String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Add selected repository to an organization secret

Adds a repository to an organization secret when the visibility for repository access is set to selected. For more information about setting the visibility, see Create or update an organization secret.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

add_selected_repo_to_org_variable(org, name, repository_id, opts \\ [])

@spec add_selected_repo_to_org_variable(String.t(), String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Add selected repository to an organization variable

Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

resources
Resources

API method documentation

approve_workflow_run(owner, repo, run_id, opts \\ [])

@spec approve_workflow_run(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Approve a workflow run for a fork pull request

Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see "Approving workflow runs from public forks."

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

cancel_workflow_run(owner, repo, run_id, opts \\ [])

@spec cancel_workflow_run(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Cancel a workflow run

Cancels a workflow run using its id.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

create_environment_variable(owner, repo, environment_name, body, opts \\ [])

@spec create_environment_variable(
  String.t(),
  String.t(),
  String.t(),
  map(),
  keyword()
) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Create an environment variable

Create an environment variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

create_or_update_environment_secret(owner, repo, environment_name, secret_name, body, opts \\ [])

@spec create_or_update_environment_secret(
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  map(),
  keyword()
) :: {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Create or update an environment secret

Creates or updates an environment secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

create_or_update_org_secret(org, secret_name, body, opts \\ [])

@spec create_or_update_org_secret(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Create or update an organization secret

Creates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

create_or_update_repo_secret(owner, repo, secret_name, body, opts \\ [])

@spec create_or_update_repo_secret(
  String.t(),
  String.t(),
  String.t(),
  map(),
  keyword()
) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Create or update a repository secret

Creates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

create_org_variable(org, body, opts \\ [])

@spec create_org_variable(String.t(), map(), keyword()) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Create an organization variable

Creates an organization variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

create_registration_token_for_org(org, opts \\ [])

@spec create_registration_token_for_org(
  String.t(),
  keyword()
) :: {:ok, GitHub.AuthenticationToken.t()} | {:error, GitHub.Error.t()}

Create a registration token for an organization

Returns a token that you can pass to the config script. The token expires after one hour.

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

./config.sh --url https://github.com/octo-org --token TOKEN

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

create_registration_token_for_repo(owner, repo, opts \\ [])

@spec create_registration_token_for_repo(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.AuthenticationToken.t()} | {:error, GitHub.Error.t()}

Create a registration token for a repository

Returns a token that you can pass to the config script. The token expires after one hour.

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

./config.sh --url https://github.com/octo-org --token TOKEN

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

create_remove_token_for_org(org, opts \\ [])

@spec create_remove_token_for_org(
  String.t(),
  keyword()
) :: {:ok, GitHub.AuthenticationToken.t()} | {:error, GitHub.Error.t()}

Create a remove token for an organization

Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

./config.sh remove --token TOKEN

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

create_remove_token_for_repo(owner, repo, opts \\ [])

@spec create_remove_token_for_repo(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.AuthenticationToken.t()} | {:error, GitHub.Error.t()}

Create a remove token for a repository

Returns a token that you can pass to the config script to remove a self-hosted runner from an repository. The token expires after one hour.

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

./config.sh remove --token TOKEN

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

create_repo_variable(owner, repo, body, opts \\ [])

@spec create_repo_variable(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Create a repository variable

Creates a repository variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

create_workflow_dispatch(owner, repo, workflow_id, body, opts \\ [])

@spec create_workflow_dispatch(
  String.t(),
  String.t(),
  integer() | String.t(),
  map(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Create a workflow dispatch event

You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see "Events that trigger workflows."

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

delete_actions_cache_by_id(owner, repo, cache_id, opts \\ [])

@spec delete_actions_cache_by_id(String.t(), String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete a GitHub Actions cache for a repository (using a cache ID)

Deletes a GitHub Actions cache for a repository, using a cache ID.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

delete_actions_cache_by_key(owner, repo, opts \\ [])

@spec delete_actions_cache_by_key(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.CacheList.t()} | {:error, GitHub.Error.t()}

Delete GitHub Actions caches for a repository (using a cache key)

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

options
Options

key: A key for identifying the cache.
ref: The full Git reference for narrowing down the cache. The ref for a branch should be formatted as refs/heads/<branch name>. To reference a pull request use refs/pull/<number>/merge.

resources
Resources

API method documentation

delete_artifact(owner, repo, artifact_id, opts \\ [])

@spec delete_artifact(String.t(), String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete an artifact

Deletes an artifact for a workflow run. OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

delete_environment_secret(owner, repo, environment_name, secret_name, opts \\ [])

@spec delete_environment_secret(
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Delete an environment secret

Deletes a secret in an environment using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

delete_environment_variable(owner, repo, name, environment_name, opts \\ [])

@spec delete_environment_variable(
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Delete an environment variable

Deletes an environment variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

delete_org_secret(org, secret_name, opts \\ [])

@spec delete_org_secret(String.t(), String.t(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete an organization secret

Deletes a secret in an organization using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

delete_org_variable(org, name, opts \\ [])

@spec delete_org_variable(String.t(), String.t(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete an organization variable

Deletes an organization variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

delete_repo_secret(owner, repo, secret_name, opts \\ [])

@spec delete_repo_secret(String.t(), String.t(), String.t(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete a repository secret

Deletes a secret in a repository using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

delete_repo_variable(owner, repo, name, opts \\ [])

@spec delete_repo_variable(String.t(), String.t(), String.t(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete a repository variable

Deletes a repository variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

delete_self_hosted_runner_from_org(org, runner_id, opts \\ [])

@spec delete_self_hosted_runner_from_org(String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete a self-hosted runner from an organization

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

delete_self_hosted_runner_from_repo(owner, repo, runner_id, opts \\ [])

@spec delete_self_hosted_runner_from_repo(
  String.t(),
  String.t(),
  integer(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Delete a self-hosted runner from a repository

Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

delete_workflow_run(owner, repo, run_id, opts \\ [])

@spec delete_workflow_run(String.t(), String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete a workflow run

Deletes a specific workflow run.

Anyone with write access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

delete_workflow_run_logs(owner, repo, run_id, opts \\ [])

@spec delete_workflow_run_logs(String.t(), String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete workflow run logs

Deletes all logs for a workflow run.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

disable_selected_repository_github_actions_organization(org, repository_id, opts \\ [])

@spec disable_selected_repository_github_actions_organization(
  String.t(),
  integer(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Disable a selected repository for GitHub Actions in an organization

Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

resources
Resources

API method documentation

disable_workflow(owner, repo, workflow_id, opts \\ [])

@spec disable_workflow(String.t(), String.t(), integer() | String.t(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Disable a workflow

Disables a workflow and sets the state of the workflow to disabled_manually. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

download_artifact(owner, repo, artifact_id, archive_format, opts \\ [])

@spec download_artifact(String.t(), String.t(), integer(), String.t(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Download an artifact

Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in the response header to find the URL for the download. The :archive_format must be zip.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

download_job_logs_for_workflow_run(owner, repo, job_id, opts \\ [])

@spec download_job_logs_for_workflow_run(String.t(), String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Download job logs for a workflow run

Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for Location: in the response header to find the URL for the download.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

download_workflow_run_attempt_logs(owner, repo, run_id, attempt_number, opts \\ [])

@spec download_workflow_run_attempt_logs(
  String.t(),
  String.t(),
  integer(),
  integer(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Download workflow run attempt logs

Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after 1 minute. Look for Location: in the response header to find the URL for the download.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

download_workflow_run_logs(owner, repo, run_id, opts \\ [])

@spec download_workflow_run_logs(String.t(), String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

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, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

enable_selected_repository_github_actions_organization(org, repository_id, opts \\ [])

@spec enable_selected_repository_github_actions_organization(
  String.t(),
  integer(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Enable a selected repository for GitHub Actions in an organization

Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

resources
Resources

API method documentation

enable_workflow(owner, repo, workflow_id, opts \\ [])

@spec enable_workflow(String.t(), String.t(), integer() | String.t(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Enable a workflow

Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

force_cancel_workflow_run(owner, repo, run_id, opts \\ [])

@spec force_cancel_workflow_run(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Force cancel a workflow run

Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an always() condition on a job. You should only use this endpoint to cancel a workflow run when the workflow run is not responding to POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

generate_runner_jitconfig_for_org(org, body, opts \\ [])

@spec generate_runner_jitconfig_for_org(String.t(), map(), keyword()) ::
  {:ok, GitHub.Actions.Runner.Jitconfig.json_resp()}
  | {:error, GitHub.Error.t()}

Create configuration for a just-in-time runner for an organization

Generates a configuration that can be passed to the runner application at startup.

The authenticated user must have admin access to the organization.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

generate_runner_jitconfig_for_repo(owner, repo, body, opts \\ [])

@spec generate_runner_jitconfig_for_repo(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.Actions.Runner.Jitconfig.json_resp()}
  | {:error, GitHub.Error.t()}

Create configuration for a just-in-time runner for a repository

Generates a configuration that can be passed to the runner application at startup.

The authenticated user must have admin access to the repository.

OAuth tokens and personal access tokens (classic) need therepo scope to use this endpoint.

resources
Resources

API method documentation

get_actions_cache_list(owner, repo, opts \\ [])

@spec get_actions_cache_list(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.CacheList.t()} | {:error, GitHub.Error.t()}

List GitHub Actions caches for a repository

Lists the GitHub Actions caches for a repository.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

options
Options

per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
ref: The full Git reference for narrowing down the cache. The ref for a branch should be formatted as refs/heads/<branch name>. To reference a pull request use refs/pull/<number>/merge.
key: An explicit key or prefix for identifying the cache
sort: The property to sort the results by. created_at means when the cache was created. last_accessed_at means when the cache was last accessed. size_in_bytes is the size of the cache in bytes.
direction: The direction to sort the results by.

resources
Resources

API method documentation

get_actions_cache_usage(owner, repo, opts \\ [])

@spec get_actions_cache_usage(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.CacheUsageByRepository.t()} | {:error, GitHub.Error.t()}

Get GitHub Actions cache usage for a repository

Gets GitHub Actions cache usage for a repository. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_actions_cache_usage_by_repo_for_org(org, opts \\ [])

@spec get_actions_cache_usage_by_repo_for_org(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, GitHub.Error.t()}

List repositories with GitHub Actions cache usage for an organization

Lists repositories and their GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

OAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

options
Options

per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

get_actions_cache_usage_for_org(org, opts \\ [])

@spec get_actions_cache_usage_for_org(
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.CacheUsageOrgEnterprise.t()} | {:error, GitHub.Error.t()}

Get GitHub Actions cache usage for an organization

Gets the total GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

OAuth tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

resources
Resources

API method documentation

get_allowed_actions_organization(org, opts \\ [])

@spec get_allowed_actions_organization(
  String.t(),
  keyword()
) :: {:ok, GitHub.SelectedActions.t()} | {:error, GitHub.Error.t()}

Get allowed actions and reusable workflows for an organization

Gets the selected actions and reusable workflows 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."

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

resources
Resources

API method documentation

get_allowed_actions_repository(owner, repo, opts \\ [])

@spec get_allowed_actions_repository(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.SelectedActions.t()} | {:error, GitHub.Error.t()}

Get allowed actions and reusable workflows for a repository

Gets the settings for selected actions and reusable workflows 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."

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_artifact(owner, repo, artifact_id, opts \\ [])

@spec get_artifact(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.Artifact.t()} | {:error, GitHub.Error.t()}

Get an artifact

Gets a specific artifact for a workflow run.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_custom_oidc_sub_claim_for_repo(owner, repo, opts \\ [])

@spec get_custom_oidc_sub_claim_for_repo(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.OIDCCustomSubRepo.t()} | {:error, GitHub.Error.t()}

Get the customization template for an OIDC subject claim for a repository

Gets the customization template for an OpenID Connect (OIDC) subject claim.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_environment_public_key(owner, repo, environment_name, opts \\ [])

@spec get_environment_public_key(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.PublicKey.t()} | {:error, GitHub.Error.t()}

Get an environment public key

Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_environment_secret(owner, repo, environment_name, secret_name, opts \\ [])

@spec get_environment_secret(
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.Secret.t()} | {:error, GitHub.Error.t()}

Get an environment secret

Gets a single environment secret without revealing its encrypted value.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_environment_variable(owner, repo, environment_name, name, opts \\ [])

@spec get_environment_variable(
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.Variable.t()} | {:error, GitHub.Error.t()}

Get an environment variable

Gets a specific variable in an environment.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_github_actions_default_workflow_permissions_organization(org, opts \\ [])

@spec get_github_actions_default_workflow_permissions_organization(
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.GetDefaultWorkflowPermissions.t()}
  | {:error, GitHub.Error.t()}

Get default workflow permissions for an organization

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, as well as whether GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your organization."

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

resources
Resources

API method documentation

get_github_actions_default_workflow_permissions_repository(owner, repo, opts \\ [])

@spec get_github_actions_default_workflow_permissions_repository(
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.GetDefaultWorkflowPermissions.t()}
  | {:error, GitHub.Error.t()}

Get default workflow permissions for a repository

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, as well as if GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your repository."

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_github_actions_permissions_organization(org, opts \\ [])

@spec get_github_actions_permissions_organization(
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.OrganizationPermissions.t()} | {:error, GitHub.Error.t()}

Get GitHub Actions permissions for an organization

Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

resources
Resources

API method documentation

get_github_actions_permissions_repository(owner, repo, opts \\ [])

@spec get_github_actions_permissions_repository(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.RepositoryPermissions.t()} | {:error, GitHub.Error.t()}

Get GitHub Actions permissions for a repository

Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_job_for_workflow_run(owner, repo, job_id, opts \\ [])

@spec get_job_for_workflow_run(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.Actions.Job.t()} | {:error, GitHub.Error.t()}

Get a job for a workflow run

Gets a specific job in a workflow run.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_org_public_key(org, opts \\ [])

@spec get_org_public_key(
  String.t(),
  keyword()
) :: {:ok, GitHub.Actions.PublicKey.t()} | {:error, GitHub.Error.t()}

Get an organization public key

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_org_secret(org, secret_name, opts \\ [])

@spec get_org_secret(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Organization.ActionsSecret.t()} | {:error, GitHub.Error.t()}

Get an organization secret

Gets a single organization secret without revealing its encrypted value.

The authenticated user must have collaborator access to a repository to create, update, or read secrets

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_org_variable(org, name, opts \\ [])

@spec get_org_variable(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Organization.ActionsVariable.t()} | {:error, GitHub.Error.t()}

Get an organization variable

Gets a specific variable in an organization.

The authenticated user must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_pending_deployments_for_run(owner, repo, run_id, opts \\ [])

@spec get_pending_deployments_for_run(String.t(), String.t(), integer(), keyword()) ::
  {:ok, [GitHub.PendingDeployment.t()]} | {:error, GitHub.Error.t()}

Get pending deployments for a workflow run

Get all deployment environments for a workflow run that are waiting for protection rules to pass.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_repo_public_key(owner, repo, opts \\ [])

@spec get_repo_public_key(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.PublicKey.t()} | {:error, GitHub.Error.t()}

Get a repository public key

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_repo_secret(owner, repo, secret_name, opts \\ [])

@spec get_repo_secret(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.Secret.t()} | {:error, GitHub.Error.t()}

Get a repository secret

Gets a single repository secret without revealing its encrypted value.

The authenticated user must have collaborator access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_repo_variable(owner, repo, name, opts \\ [])

@spec get_repo_variable(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.Variable.t()} | {:error, GitHub.Error.t()}

Get a repository variable

Gets a specific variable in a repository.

The authenticated user must have collaborator access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_reviews_for_run(owner, repo, run_id, opts \\ [])

@spec get_reviews_for_run(String.t(), String.t(), integer(), keyword()) ::
  {:ok, [GitHub.EnvironmentApprovals.t()]} | {:error, GitHub.Error.t()}

Get the review history for a workflow run

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

resources
Resources

API method documentation

get_self_hosted_runner_for_org(org, runner_id, opts \\ [])

@spec get_self_hosted_runner_for_org(String.t(), integer(), keyword()) ::
  {:ok, GitHub.Actions.Runner.t()} | {:error, GitHub.Error.t()}

Get a self-hosted runner for an organization

Gets a specific self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

resources
Resources

API method documentation

get_self_hosted_runner_for_repo(owner, repo, runner_id, opts \\ [])

@spec get_self_hosted_runner_for_repo(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.Actions.Runner.t()} | {:error, GitHub.Error.t()}

Get a self-hosted runner for a repository

Gets a specific self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_workflow(owner, repo, workflow_id, opts \\ [])

@spec get_workflow(String.t(), String.t(), integer() | String.t(), keyword()) ::
  {:ok, GitHub.Actions.Workflow.t()} | {:error, GitHub.Error.t()}

Get a workflow

Gets a specific workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

resources
Resources

API method documentation

get_workflow_access_to_repository(owner, repo, opts \\ [])

@spec get_workflow_access_to_repository(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Actions.Workflow.AccessToRepository.t()}
  | {:error, GitHub.Error.t()}

Get the level of access for workflows outside of the repository

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to private repositories. For more information, see "Allowing access to components in a private repository."

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

get_workflow_run(owner, repo, run_id, opts \\ [])

@spec get_workflow_run(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.Actions.Workflow.Run.t()} | {:error, GitHub.Error.t()}

Get a workflow run

Gets a specific workflow run.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

options
Options

exclude_pull_requests: If true pull requests are omitted from the response (empty array).

resources
Resources

API method documentation

get_workflow_run_attempt(owner, repo, run_id, attempt_number, opts \\ [])

@spec get_workflow_run_attempt(
  String.t(),
  String.t(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, GitHub.Actions.Workflow.Run.t()} | {:error, GitHub.Error.t()}

Get a workflow run attempt

Gets a specific workflow run attempt.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

options
Options

exclude_pull_requests: If true pull requests are omitted from the response (empty array).

resources
Resources

API method documentation

get_workflow_run_usage(owner, repo, run_id, opts \\ [])

@spec get_workflow_run_usage(String.t(), String.t(), integer(), keyword()) ::
  {:ok, GitHub.Actions.Workflow.RunUsage.t()} | {:error, GitHub.Error.t()}

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.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

resources
Resources

API method documentation

get_workflow_usage(owner, repo, workflow_id, opts \\ [])

@spec get_workflow_usage(String.t(), String.t(), integer() | String.t(), keyword()) ::
  {:ok, GitHub.Actions.Workflow.Usage.t()} | {:error, GitHub.Error.t()}

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.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

resources
Resources

API method documentation

list_artifacts_for_repo(owner, repo, opts \\ [])

@spec list_artifacts_for_repo(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List artifacts for a repository

Lists all artifacts for a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

options
Options

per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
name: The name field of an artifact. When specified, only artifacts with this name will be returned.

resources
Resources

API method documentation

list_environment_secrets(owner, repo, environment_name, opts \\ [])

@spec list_environment_secrets(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List environment secrets

Lists all secrets available in an environment without revealing their encrypted values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

options
Options

per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_environment_variables(owner, repo, environment_name, opts \\ [])

@spec list_environment_variables(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List environment variables

Lists all environment variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

options
Options

per_page: The number of results per page (max 30). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_jobs_for_workflow_run(owner, repo, run_id, opts \\ [])

@spec list_jobs_for_workflow_run(String.t(), String.t(), integer(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List jobs for a workflow run

Lists jobs for a workflow run. 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.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

options
Options

filter: Filters jobs by their completed_at timestamp. latest returns jobs from the most recent execution of the workflow run. all returns all jobs for a workflow run, including from old executions of the workflow run.
per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_jobs_for_workflow_run_attempt(owner, repo, run_id, attempt_number, opts \\ [])

@spec list_jobs_for_workflow_run_attempt(
  String.t(),
  String.t(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List jobs for a workflow run attempt

Lists jobs for a specific workflow run attempt. 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.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

options
Options

per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_labels_for_self_hosted_runner_for_org(org, runner_id, opts \\ [])

@spec list_labels_for_self_hosted_runner_for_org(String.t(), integer(), keyword()) ::
  {:ok, GitHub.Actions.Runner.Labels.json_resp()} | {:error, GitHub.Error.t()}

List labels for a self-hosted runner for an organization

Lists all labels for a self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

resources
Resources

API method documentation

list_labels_for_self_hosted_runner_for_repo(owner, repo, runner_id, opts \\ [])

@spec list_labels_for_self_hosted_runner_for_repo(
  String.t(),
  String.t(),
  integer(),
  keyword()
) ::
  {:ok, GitHub.Actions.Runner.Labels.json_resp()} | {:error, GitHub.Error.t()}

List labels for a self-hosted runner for a repository

Lists all labels for a self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

list_org_secrets(org, opts \\ [])

@spec list_org_secrets(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, GitHub.Error.t()}

List organization secrets

Lists all secrets available in an organization without revealing their encrypted values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

options
Options

per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_org_variables(org, opts \\ [])

@spec list_org_variables(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, GitHub.Error.t()}

List organization variables

Lists all organization variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

options
Options

per_page: The number of results per page (max 30). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_repo_organization_secrets(owner, repo, opts \\ [])

@spec list_repo_organization_secrets(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List repository organization secrets

Lists all organization secrets shared with a repository without revealing their encrypted values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

options
Options

per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_repo_organization_variables(owner, repo, opts \\ [])

@spec list_repo_organization_variables(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List repository organization variables

Lists all organization variables shared with a repository.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

options
Options

per_page: The number of results per page (max 30). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_repo_secrets(owner, repo, opts \\ [])

@spec list_repo_secrets(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List repository secrets

Lists all secrets available in a repository without revealing their encrypted values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

options
Options

per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_repo_variables(owner, repo, opts \\ [])

@spec list_repo_variables(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List repository variables

Lists all repository variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

options
Options

per_page: The number of results per page (max 30). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_repo_workflows(owner, repo, opts \\ [])

@spec list_repo_workflows(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List repository workflows

Lists the workflows in a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

options
Options

per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_runner_applications_for_org(org, opts \\ [])

@spec list_runner_applications_for_org(
  String.t(),
  keyword()
) :: {:ok, [GitHub.Actions.Runner.Application.t()]} | {:error, GitHub.Error.t()}

List runner applications for an organization

Lists binaries for the runner application that you can download and run.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

resources
Resources

API method documentation

list_runner_applications_for_repo(owner, repo, opts \\ [])

@spec list_runner_applications_for_repo(String.t(), String.t(), keyword()) ::
  {:ok, [GitHub.Actions.Runner.Application.t()]} | {:error, GitHub.Error.t()}

List runner applications for a repository

Lists binaries for the runner application that you can download and run.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

list_selected_repos_for_org_secret(org, secret_name, opts \\ [])

@spec list_selected_repos_for_org_secret(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List selected repositories for an organization secret

Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

options
Options

page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_selected_repos_for_org_variable(org, name, opts \\ [])

@spec list_selected_repos_for_org_variable(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List selected repositories for an organization variable

Lists all repositories that can access an organization variable that is available to selected repositories.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

options
Options

page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_selected_repositories_enabled_github_actions_organization(org, opts \\ [])

@spec list_selected_repositories_enabled_github_actions_organization(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, GitHub.Error.t()}

List selected repositories enabled for GitHub Actions in an organization

Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

options
Options

per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_self_hosted_runners_for_org(org, opts \\ [])

@spec list_self_hosted_runners_for_org(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, GitHub.Error.t()}

List self-hosted runners for an organization

Lists all self-hosted runners configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

options
Options

name: The name of a self-hosted runner.
per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_self_hosted_runners_for_repo(owner, repo, opts \\ [])

@spec list_self_hosted_runners_for_repo(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List self-hosted runners for a repository

Lists all self-hosted runners configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

options
Options

name: The name of a self-hosted runner.
per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."

resources
Resources

API method documentation

list_workflow_run_artifacts(owner, repo, run_id, opts \\ [])

@spec list_workflow_run_artifacts(String.t(), String.t(), integer(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List workflow run artifacts

Lists artifacts for a workflow run.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

options
Options

per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
name: The name field of an artifact. When specified, only artifacts with this name will be returned.

resources
Resources

API method documentation

list_workflow_runs(owner, repo, workflow_id, opts \\ [])

@spec list_workflow_runs(String.t(), String.t(), integer() | String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List workflow runs for a workflow

List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

Anyone with read access to the repository can use this endpoint

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

options
Options

actor: Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
branch: Returns workflow runs associated with a branch. Use the name of the branch of the push.
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."
status: Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub Actions can set a status of waiting, pending, or requested.
per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
created: Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."
exclude_pull_requests: If true pull requests are omitted from the response (empty array).
check_suite_id: Returns workflow runs with the check_suite_id that you specify.
head_sha: Only returns workflow runs that are associated with the specified head_sha.

resources
Resources

API method documentation

list_workflow_runs_for_repo(owner, repo, opts \\ [])

@spec list_workflow_runs_for_repo(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List workflow runs for a repository

Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

This API will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

options
Options

actor: Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.
branch: Returns workflow runs associated with a branch. Use the name of the branch of the push.
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."
status: Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub Actions can set a status of waiting, pending, or requested.
per_page: The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page: The page number of the results to fetch. For more information, see "Using pagination in the REST API."
created: Returns workflow runs created within the given date-time range. For more information on the syntax, see "Understanding the search syntax."
exclude_pull_requests: If true pull requests are omitted from the response (empty array).
check_suite_id: Returns workflow runs with the check_suite_id that you specify.
head_sha: Only returns workflow runs that are associated with the specified head_sha.

resources
Resources

API method documentation

re_run_job_for_workflow_run(owner, repo, job_id, body, opts \\ [])

@spec re_run_job_for_workflow_run(
  String.t(),
  String.t(),
  integer(),
  map() | nil,
  keyword()
) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Re-run a job from a workflow run

Re-run a job and its dependent jobs in a workflow run.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

re_run_workflow(owner, repo, run_id, body, opts \\ [])

@spec re_run_workflow(String.t(), String.t(), integer(), map() | nil, keyword()) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Re-run a workflow

Re-runs your workflow run using its id.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

re_run_workflow_failed_jobs(owner, repo, run_id, body, opts \\ [])

@spec re_run_workflow_failed_jobs(
  String.t(),
  String.t(),
  integer(),
  map() | nil,
  keyword()
) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Re-run failed jobs from a workflow run

Re-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

remove_all_custom_labels_from_self_hosted_runner_for_org(org, runner_id, opts \\ [])

@spec remove_all_custom_labels_from_self_hosted_runner_for_org(
  String.t(),
  integer(),
  keyword()
) ::
  {:ok, GitHub.Actions.Runner.LabelsReadonly.json_resp()}
  | {:error, GitHub.Error.t()}

Remove all custom labels from a self-hosted runner for an organization

Remove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

resources
Resources

API method documentation

remove_all_custom_labels_from_self_hosted_runner_for_repo(owner, repo, runner_id, opts \\ [])

@spec remove_all_custom_labels_from_self_hosted_runner_for_repo(
  String.t(),
  String.t(),
  integer(),
  keyword()
) ::
  {:ok, GitHub.Actions.Runner.LabelsReadonly.json_resp()}
  | {:error, GitHub.Error.t()}

Remove all custom labels from a self-hosted runner for a repository

Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

remove_custom_label_from_self_hosted_runner_for_org(org, runner_id, name, opts \\ [])

@spec remove_custom_label_from_self_hosted_runner_for_org(
  String.t(),
  integer(),
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.Runner.Labels.json_resp()} | {:error, GitHub.Error.t()}

Remove a custom label from a self-hosted runner for an organization

Remove a custom label from a self-hosted runner configured in an organization. Returns the remaining labels from the runner.

This endpoint returns a 404 Not Found status if the custom label is not present on the runner.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

resources
Resources

API method documentation

remove_custom_label_from_self_hosted_runner_for_repo(owner, repo, runner_id, name, opts \\ [])

@spec remove_custom_label_from_self_hosted_runner_for_repo(
  String.t(),
  String.t(),
  integer(),
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.Runner.Labels.json_resp()} | {:error, GitHub.Error.t()}

Remove a custom label from a self-hosted runner for a repository

Remove a custom label from a self-hosted runner configured in a repository. Returns the remaining labels from the runner.

This endpoint returns a 404 Not Found status if the custom label is not present on the runner.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

remove_selected_repo_from_org_secret(org, secret_name, repository_id, opts \\ [])

@spec remove_selected_repo_from_org_secret(
  String.t(),
  String.t(),
  integer(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Remove selected repository from an organization secret

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

resources
Resources

API method documentation

remove_selected_repo_from_org_variable(org, name, repository_id, opts \\ [])

@spec remove_selected_repo_from_org_variable(
  String.t(),
  String.t(),
  integer(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Remove selected repository from an organization variable

Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

resources
Resources

API method documentation

review_custom_gates_for_run(owner, repo, run_id, body, opts \\ [])

@spec review_custom_gates_for_run(
  String.t(),
  String.t(),
  integer(),
  GitHub.Actions.ReviewCustomGates.CommentRequired.t()
  | GitHub.Actions.ReviewCustomGates.StateRequired.t(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Review custom deployment protection rules for a workflow run

Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "Using environments for deployment."

Note: GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

resources
Resources

API method documentation

review_pending_deployments_for_run(owner, repo, run_id, body, opts \\ [])

@spec review_pending_deployments_for_run(
  String.t(),
  String.t(),
  integer(),
  map(),
  keyword()
) ::
  {:ok, [GitHub.Deployment.t()]} | {:error, GitHub.Error.t()}

Review pending deployments for a workflow run

Approve or reject pending deployments that are waiting on approval by a required reviewer.

Required reviewers with read access to the repository contents and deployments can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

set_allowed_actions_organization(org, body, opts \\ [])

@spec set_allowed_actions_organization(
  String.t(),
  GitHub.SelectedActions.t(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Set allowed actions and reusable workflows for an organization

Sets the actions and reusable workflows 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."

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

resources
Resources

API method documentation

set_allowed_actions_repository(owner, repo, body, opts \\ [])

@spec set_allowed_actions_repository(
  String.t(),
  String.t(),
  GitHub.SelectedActions.t(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Set allowed actions and reusable workflows for a repository

Sets the actions and reusable workflows 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."

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

set_custom_labels_for_self_hosted_runner_for_org(org, runner_id, body, opts \\ [])

@spec set_custom_labels_for_self_hosted_runner_for_org(
  String.t(),
  integer(),
  map(),
  keyword()
) ::
  {:ok, GitHub.Actions.Runner.Labels.json_resp()} | {:error, GitHub.Error.t()}

Set custom labels for a self-hosted runner for an organization

Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

resources
Resources

API method documentation

set_custom_labels_for_self_hosted_runner_for_repo(owner, repo, runner_id, body, opts \\ [])

@spec set_custom_labels_for_self_hosted_runner_for_repo(
  String.t(),
  String.t(),
  integer(),
  map(),
  keyword()
) ::
  {:ok, GitHub.Actions.Runner.Labels.json_resp()} | {:error, GitHub.Error.t()}

Set custom labels for a self-hosted runner for a repository

Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

set_custom_oidc_sub_claim_for_repo(owner, repo, body, opts \\ [])

@spec set_custom_oidc_sub_claim_for_repo(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.EmptyObject.t()} | {:error, GitHub.Error.t()}

Set the customization template for an OIDC subject claim for a repository

Sets the customization template and opt-in or opt-out flag for an OpenID Connect (OIDC) subject claim for a repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

set_github_actions_default_workflow_permissions_organization(org, body, opts \\ [])

@spec set_github_actions_default_workflow_permissions_organization(
  String.t(),
  GitHub.Actions.SetDefaultWorkflowPermissions.t(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Set default workflow permissions for an organization

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your organization."

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

resources
Resources

API method documentation

set_github_actions_default_workflow_permissions_repository(owner, repo, body, opts \\ [])

@spec set_github_actions_default_workflow_permissions_repository(
  String.t(),
  String.t(),
  GitHub.Actions.SetDefaultWorkflowPermissions.t(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Set default workflow permissions for a repository

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your repository."

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

set_github_actions_permissions_organization(org, body, opts \\ [])

@spec set_github_actions_permissions_organization(String.t(), map(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Set GitHub Actions permissions for an organization

Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

resources
Resources

API method documentation

set_github_actions_permissions_repository(owner, repo, body, opts \\ [])

@spec set_github_actions_permissions_repository(
  String.t(),
  String.t(),
  map(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Set GitHub Actions permissions for a repository

Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

set_selected_repos_for_org_secret(org, secret_name, body, opts \\ [])

@spec set_selected_repos_for_org_secret(String.t(), String.t(), map(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Set selected repositories for an organization secret

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

resources
Resources

API method documentation

set_selected_repos_for_org_variable(org, name, body, opts \\ [])

@spec set_selected_repos_for_org_variable(String.t(), String.t(), map(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Set selected repositories for an organization variable

Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

resources
Resources

API method documentation

set_selected_repositories_enabled_github_actions_organization(org, body, opts \\ [])

@spec set_selected_repositories_enabled_github_actions_organization(
  String.t(),
  map(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Set selected repositories enabled for GitHub Actions in an organization

Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

resources
Resources

API method documentation

set_workflow_access_to_repository(owner, repo, body, opts \\ [])

@spec set_workflow_access_to_repository(
  String.t(),
  String.t(),
  GitHub.Actions.Workflow.AccessToRepository.t(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Set the level of access for workflows outside of the repository

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to private repositories. For more information, see "Allowing access to components in a private repository".

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

update_environment_variable(owner, repo, name, environment_name, body, opts \\ [])

@spec update_environment_variable(
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  map(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Update an environment variable

Updates an environment variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

update_org_variable(org, name, body, opts \\ [])

@spec update_org_variable(String.t(), String.t(), map(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Update an organization variable

Updates an organization variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

resources
Resources

API method documentation

update_repo_variable(owner, repo, name, body, opts \\ [])

@spec update_repo_variable(String.t(), String.t(), String.t(), map(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Update a repository variable

Updates a repository variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

resources
Resources

API method documentation

Settings View Source GitHub.Actions (GitHub REST API Client v0.3.3)

Link to this section Summary

Types

Functions

Link to this section Types

get_actions_cache_usage_by_repo_for_org_200_json_resp()

list_artifacts_for_repo_200_json_resp()

list_environment_secrets_200_json_resp()

list_environment_variables_200_json_resp()

list_jobs_for_workflow_run_200_json_resp()

list_jobs_for_workflow_run_attempt_200_json_resp()

list_org_secrets_200_json_resp()

list_org_variables_200_json_resp()

list_repo_organization_secrets_200_json_resp()

list_repo_organization_variables_200_json_resp()

list_repo_secrets_200_json_resp()

list_repo_variables_200_json_resp()

list_repo_workflows_200_json_resp()

list_selected_repos_for_org_secret_200_json_resp()

list_selected_repos_for_org_variable_200_json_resp()

list_selected_repositories_enabled_github_actions_organization_200_json_resp()

list_self_hosted_runners_for_org_200_json_resp()

list_self_hosted_runners_for_repo_200_json_resp()

list_workflow_run_artifacts_200_json_resp()

list_workflow_runs_200_json_resp()

list_workflow_runs_for_repo_200_json_resp()

Link to this section Functions

add_custom_labels_to_self_hosted_runner_for_org(org, runner_id, body, opts \\ [])

resources Resources

add_custom_labels_to_self_hosted_runner_for_repo(owner, repo, runner_id, body, opts \\ [])

resources Resources

add_selected_repo_to_org_secret(org, secret_name, repository_id, opts \\ [])

resources Resources

add_selected_repo_to_org_variable(org, name, repository_id, opts \\ [])

resources Resources

approve_workflow_run(owner, repo, run_id, opts \\ [])

resources Resources

cancel_workflow_run(owner, repo, run_id, opts \\ [])

resources Resources

create_environment_variable(owner, repo, environment_name, body, opts \\ [])

resources Resources

create_or_update_environment_secret(owner, repo, environment_name, secret_name, body, opts \\ [])

resources Resources

create_or_update_org_secret(org, secret_name, body, opts \\ [])

resources Resources

create_or_update_repo_secret(owner, repo, secret_name, body, opts \\ [])

resources Resources

create_org_variable(org, body, opts \\ [])

resources Resources

create_registration_token_for_org(org, opts \\ [])

resources Resources

create_registration_token_for_repo(owner, repo, opts \\ [])

resources Resources

create_remove_token_for_org(org, opts \\ [])

resources Resources

create_remove_token_for_repo(owner, repo, opts \\ [])

resources Resources

create_repo_variable(owner, repo, body, opts \\ [])

resources Resources

create_workflow_dispatch(owner, repo, workflow_id, body, opts \\ [])

resources Resources

delete_actions_cache_by_id(owner, repo, cache_id, opts \\ [])

resources Resources

delete_actions_cache_by_key(owner, repo, opts \\ [])

options Options

resources Resources

delete_artifact(owner, repo, artifact_id, opts \\ [])

resources Resources

delete_environment_secret(owner, repo, environment_name, secret_name, opts \\ [])

resources Resources

delete_environment_variable(owner, repo, name, environment_name, opts \\ [])

resources Resources

delete_org_secret(org, secret_name, opts \\ [])

resources Resources

delete_org_variable(org, name, opts \\ [])

resources Resources

delete_repo_secret(owner, repo, secret_name, opts \\ [])

resources Resources

delete_repo_variable(owner, repo, name, opts \\ [])

resources Resources

View Source GitHub.Actions (GitHub REST API Client v0.3.3)

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

options
Options

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

options
Options

resources
Resources

resources
Resources

options
Options

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources

resources
Resources