Struct roctogen::endpoints::actions::Actions [−][src]
pub struct Actions<'api> { /* fields omitted */ }
Implementations
Add custom labels to a self-hosted runner for an organization
Add custom labels to a self-hosted runner configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for add_custom_labels_to_self_hosted_runner_for_org
Add custom labels to a self-hosted runner for an organization
Add custom labels to a self-hosted runner configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for add_custom_labels_to_self_hosted_runner_for_org
pub async fn add_custom_labels_to_self_hosted_runner_for_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32,
body: PostActionsAddCustomLabelsToSelfHostedRunnerForRepo
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsAddCustomLabelsToSelfHostedRunnerForRepoError>
pub async fn add_custom_labels_to_self_hosted_runner_for_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32,
body: PostActionsAddCustomLabelsToSelfHostedRunnerForRepo
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsAddCustomLabelsToSelfHostedRunnerForRepoError>
Add custom labels to a self-hosted runner for a repository
Add custom labels to a self-hosted runner configured in a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint.
GitHub API docs for add_custom_labels_to_self_hosted_runner_for_repo
pub fn add_custom_labels_to_self_hosted_runner_for_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32,
body: PostActionsAddCustomLabelsToSelfHostedRunnerForRepo
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsAddCustomLabelsToSelfHostedRunnerForRepoError>
pub fn add_custom_labels_to_self_hosted_runner_for_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32,
body: PostActionsAddCustomLabelsToSelfHostedRunnerForRepo
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsAddCustomLabelsToSelfHostedRunnerForRepoError>
Add custom labels to a self-hosted runner for a repository
Add custom labels to a self-hosted runner configured in a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint.
GitHub API docs for add_custom_labels_to_self_hosted_runner_for_repo
pub async fn add_repo_access_to_self_hosted_runner_group_in_org_async(
&self,
org: &str,
runner_group_id: i32,
repository_id: i32
) -> Result<(), ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgError>
pub async fn add_repo_access_to_self_hosted_runner_group_in_org_async(
&self,
org: &str,
runner_group_id: i32,
repository_id: i32
) -> Result<(), ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgError>
Add repository access to a self-hosted runner group in an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Adds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see “Create a self-hosted runner group for an organization.”
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for add_repo_access_to_self_hosted_runner_group_in_org
pub fn add_repo_access_to_self_hosted_runner_group_in_org(
&self,
org: &str,
runner_group_id: i32,
repository_id: i32
) -> Result<(), ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgError>
pub fn add_repo_access_to_self_hosted_runner_group_in_org(
&self,
org: &str,
runner_group_id: i32,
repository_id: i32
) -> Result<(), ActionsAddRepoAccessToSelfHostedRunnerGroupInOrgError>
Add repository access to a self-hosted runner group in an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Adds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see “Create a self-hosted runner group for an organization.”
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for add_repo_access_to_self_hosted_runner_group_in_org
pub async fn add_selected_repo_to_org_secret_async(
&self,
org: &str,
secret_name: &str,
repository_id: i32
) -> Result<(), ActionsAddSelectedRepoToOrgSecretError>
pub async fn add_selected_repo_to_org_secret_async(
&self,
org: &str,
secret_name: &str,
repository_id: i32
) -> Result<(), ActionsAddSelectedRepoToOrgSecretError>
Add selected repository to an organization secret
Adds a repository to an organization secret when the visibility
for repository access is set to selected
. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for add_selected_repo_to_org_secret
pub fn add_selected_repo_to_org_secret(
&self,
org: &str,
secret_name: &str,
repository_id: i32
) -> Result<(), ActionsAddSelectedRepoToOrgSecretError>
pub fn add_selected_repo_to_org_secret(
&self,
org: &str,
secret_name: &str,
repository_id: i32
) -> Result<(), ActionsAddSelectedRepoToOrgSecretError>
Add selected repository to an organization secret
Adds a repository to an organization secret when the visibility
for repository access is set to selected
. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for add_selected_repo_to_org_secret
pub async fn add_self_hosted_runner_to_group_for_org_async(
&self,
org: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), ActionsAddSelfHostedRunnerToGroupForOrgError>
pub async fn add_self_hosted_runner_to_group_for_org_async(
&self,
org: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), ActionsAddSelfHostedRunnerToGroupForOrgError>
Add a self-hosted runner to a group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Adds a self-hosted runner to a runner group configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for add_self_hosted_runner_to_group_for_org
pub fn add_self_hosted_runner_to_group_for_org(
&self,
org: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), ActionsAddSelfHostedRunnerToGroupForOrgError>
pub fn add_self_hosted_runner_to_group_for_org(
&self,
org: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), ActionsAddSelfHostedRunnerToGroupForOrgError>
Add a self-hosted runner to a group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Adds a self-hosted runner to a runner group configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for add_self_hosted_runner_to_group_for_org
pub async fn approve_workflow_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<EmptyObject, ActionsApproveWorkflowRunError>
pub async fn approve_workflow_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<EmptyObject, ActionsApproveWorkflowRunError>
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.“
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for approve_workflow_run
pub fn approve_workflow_run(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<EmptyObject, ActionsApproveWorkflowRunError>
pub fn approve_workflow_run(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<EmptyObject, ActionsApproveWorkflowRunError>
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.“
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for approve_workflow_run
pub async fn cancel_workflow_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<HashMap<String, Value>, ActionsCancelWorkflowRunError>
pub async fn cancel_workflow_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<HashMap<String, Value>, ActionsCancelWorkflowRunError>
Cancel a workflow run
Cancels a workflow run using its id
. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for cancel_workflow_run
pub fn cancel_workflow_run(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<HashMap<String, Value>, ActionsCancelWorkflowRunError>
pub fn cancel_workflow_run(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<HashMap<String, Value>, ActionsCancelWorkflowRunError>
Cancel a workflow run
Cancels a workflow run using its id
. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for cancel_workflow_run
pub async fn create_or_update_environment_secret_async(
&self,
repository_id: i32,
environment_name: &str,
secret_name: &str,
body: PutActionsCreateOrUpdateEnvironmentSecret
) -> Result<EmptyObject, ActionsCreateOrUpdateEnvironmentSecretError>
pub async fn create_or_update_environment_secret_async(
&self,
repository_id: i32,
environment_name: &str,
secret_name: &str,
body: PutActionsCreateOrUpdateEnvironmentSecret
) -> Result<EmptyObject, ActionsCreateOrUpdateEnvironmentSecretError>
Create or update an environment secret
Creates or updates an environment secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use
this endpoint.
Example encrypting a secret using Node.js
Encrypt your secret using the tweetsodium library.
const sodium = require('tweetsodium');
const key = "base64-encoded-public-key";
const value = "plain-text-secret";
// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');
// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);
// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');
console.log(encrypted);
Example encrypting a secret using Python
Encrypt your secret using pynacl with Python 3.
from base64 import b64encode
from nacl import encoding, public
def encrypt(public_key: str, secret_value: str) -> str:
"""Encrypt a Unicode string using the public key."""
public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
sealed_box = public.SealedBox(public_key)
encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
return b64encode(encrypted).decode("utf-8")
Example encrypting a secret using C#
Encrypt your secret using the Sodium.Core package.
var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
Example encrypting a secret using Ruby
Encrypt your secret using the rbnacl gem.
require "rbnacl"
require "base64"
key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)
box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")
puts Base64.strict_encode64(encrypted_secret)
GitHub API docs for create_or_update_environment_secret
pub fn create_or_update_environment_secret(
&self,
repository_id: i32,
environment_name: &str,
secret_name: &str,
body: PutActionsCreateOrUpdateEnvironmentSecret
) -> Result<EmptyObject, ActionsCreateOrUpdateEnvironmentSecretError>
pub fn create_or_update_environment_secret(
&self,
repository_id: i32,
environment_name: &str,
secret_name: &str,
body: PutActionsCreateOrUpdateEnvironmentSecret
) -> Result<EmptyObject, ActionsCreateOrUpdateEnvironmentSecretError>
Create or update an environment secret
Creates or updates an environment secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use
this endpoint.
Example encrypting a secret using Node.js
Encrypt your secret using the tweetsodium library.
const sodium = require('tweetsodium');
const key = "base64-encoded-public-key";
const value = "plain-text-secret";
// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');
// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);
// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');
console.log(encrypted);
Example encrypting a secret using Python
Encrypt your secret using pynacl with Python 3.
from base64 import b64encode
from nacl import encoding, public
def encrypt(public_key: str, secret_value: str) -> str:
"""Encrypt a Unicode string using the public key."""
public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
sealed_box = public.SealedBox(public_key)
encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
return b64encode(encrypted).decode("utf-8")
Example encrypting a secret using C#
Encrypt your secret using the Sodium.Core package.
var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
Example encrypting a secret using Ruby
Encrypt your secret using the rbnacl gem.
require "rbnacl"
require "base64"
key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)
box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")
puts Base64.strict_encode64(encrypted_secret)
GitHub API docs for create_or_update_environment_secret
pub async fn create_or_update_org_secret_async(
&self,
org: &str,
secret_name: &str,
body: PutActionsCreateOrUpdateOrgSecret
) -> Result<EmptyObject, ActionsCreateOrUpdateOrgSecretError>
pub async fn create_or_update_org_secret_async(
&self,
org: &str,
secret_name: &str,
body: PutActionsCreateOrUpdateOrgSecret
) -> Result<EmptyObject, ActionsCreateOrUpdateOrgSecretError>
Create or update an organization secret
Creates or updates an organization secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to
use this endpoint.
Example encrypting a secret using Node.js
Encrypt your secret using the tweetsodium library.
const sodium = require('tweetsodium');
const key = "base64-encoded-public-key";
const value = "plain-text-secret";
// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');
// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);
// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');
console.log(encrypted);
Example encrypting a secret using Python
Encrypt your secret using pynacl with Python 3.
from base64 import b64encode
from nacl import encoding, public
def encrypt(public_key: str, secret_value: str) -> str:
"""Encrypt a Unicode string using the public key."""
public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
sealed_box = public.SealedBox(public_key)
encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
return b64encode(encrypted).decode("utf-8")
Example encrypting a secret using C#
Encrypt your secret using the Sodium.Core package.
var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
Example encrypting a secret using Ruby
Encrypt your secret using the rbnacl gem.
require "rbnacl"
require "base64"
key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)
box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")
puts Base64.strict_encode64(encrypted_secret)
GitHub API docs for create_or_update_org_secret
pub fn create_or_update_org_secret(
&self,
org: &str,
secret_name: &str,
body: PutActionsCreateOrUpdateOrgSecret
) -> Result<EmptyObject, ActionsCreateOrUpdateOrgSecretError>
pub fn create_or_update_org_secret(
&self,
org: &str,
secret_name: &str,
body: PutActionsCreateOrUpdateOrgSecret
) -> Result<EmptyObject, ActionsCreateOrUpdateOrgSecretError>
Create or update an organization secret
Creates or updates an organization secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to
use this endpoint.
Example encrypting a secret using Node.js
Encrypt your secret using the tweetsodium library.
const sodium = require('tweetsodium');
const key = "base64-encoded-public-key";
const value = "plain-text-secret";
// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');
// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);
// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');
console.log(encrypted);
Example encrypting a secret using Python
Encrypt your secret using pynacl with Python 3.
from base64 import b64encode
from nacl import encoding, public
def encrypt(public_key: str, secret_value: str) -> str:
"""Encrypt a Unicode string using the public key."""
public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
sealed_box = public.SealedBox(public_key)
encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
return b64encode(encrypted).decode("utf-8")
Example encrypting a secret using C#
Encrypt your secret using the Sodium.Core package.
var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
Example encrypting a secret using Ruby
Encrypt your secret using the rbnacl gem.
require "rbnacl"
require "base64"
key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)
box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")
puts Base64.strict_encode64(encrypted_secret)
GitHub API docs for create_or_update_org_secret
pub async fn create_or_update_repo_secret_async(
&self,
owner: &str,
repo: &str,
secret_name: &str,
body: PutActionsCreateOrUpdateRepoSecret
) -> Result<HashMap<String, Value>, ActionsCreateOrUpdateRepoSecretError>
pub async fn create_or_update_repo_secret_async(
&self,
owner: &str,
repo: &str,
secret_name: &str,
body: PutActionsCreateOrUpdateRepoSecret
) -> Result<HashMap<String, Value>, ActionsCreateOrUpdateRepoSecretError>
Create or update a repository secret
Creates or updates a repository secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use
this endpoint.
Example encrypting a secret using Node.js
Encrypt your secret using the tweetsodium library.
const sodium = require('tweetsodium');
const key = "base64-encoded-public-key";
const value = "plain-text-secret";
// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');
// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);
// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');
console.log(encrypted);
Example encrypting a secret using Python
Encrypt your secret using pynacl with Python 3.
from base64 import b64encode
from nacl import encoding, public
def encrypt(public_key: str, secret_value: str) -> str:
"""Encrypt a Unicode string using the public key."""
public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
sealed_box = public.SealedBox(public_key)
encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
return b64encode(encrypted).decode("utf-8")
Example encrypting a secret using C#
Encrypt your secret using the Sodium.Core package.
var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
Example encrypting a secret using Ruby
Encrypt your secret using the rbnacl gem.
require "rbnacl"
require "base64"
key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)
box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")
puts Base64.strict_encode64(encrypted_secret)
GitHub API docs for create_or_update_repo_secret
pub fn create_or_update_repo_secret(
&self,
owner: &str,
repo: &str,
secret_name: &str,
body: PutActionsCreateOrUpdateRepoSecret
) -> Result<HashMap<String, Value>, ActionsCreateOrUpdateRepoSecretError>
pub fn create_or_update_repo_secret(
&self,
owner: &str,
repo: &str,
secret_name: &str,
body: PutActionsCreateOrUpdateRepoSecret
) -> Result<HashMap<String, Value>, ActionsCreateOrUpdateRepoSecretError>
Create or update a repository secret
Creates or updates a repository secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use
this endpoint.
Example encrypting a secret using Node.js
Encrypt your secret using the tweetsodium library.
const sodium = require('tweetsodium');
const key = "base64-encoded-public-key";
const value = "plain-text-secret";
// Convert the message and key to Uint8Array's (Buffer implements that interface)
const messageBytes = Buffer.from(value);
const keyBytes = Buffer.from(key, 'base64');
// Encrypt using LibSodium.
const encryptedBytes = sodium.seal(messageBytes, keyBytes);
// Base64 the encrypted secret
const encrypted = Buffer.from(encryptedBytes).toString('base64');
console.log(encrypted);
Example encrypting a secret using Python
Encrypt your secret using pynacl with Python 3.
from base64 import b64encode
from nacl import encoding, public
def encrypt(public_key: str, secret_value: str) -> str:
"""Encrypt a Unicode string using the public key."""
public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())
sealed_box = public.SealedBox(public_key)
encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))
return b64encode(encrypted).decode("utf-8")
Example encrypting a secret using C#
Encrypt your secret using the Sodium.Core package.
var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");
var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");
var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);
Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));
Example encrypting a secret using Ruby
Encrypt your secret using the rbnacl gem.
require "rbnacl"
require "base64"
key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")
public_key = RbNaCl::PublicKey.new(key)
box = RbNaCl::Boxes::Sealed.from_public_key(public_key)
encrypted_secret = box.encrypt("my_secret")
puts Base64.strict_encode64(encrypted_secret)
GitHub API docs for create_or_update_repo_secret
pub async fn create_registration_token_for_org_async(
&self,
org: &str
) -> Result<AuthenticationToken, ActionsCreateRegistrationTokenForOrgError>
pub async fn create_registration_token_for_org_async(
&self,
org: &str
) -> Result<AuthenticationToken, ActionsCreateRegistrationTokenForOrgError>
Create a registration token for an organization
Returns a token that you can pass to the config
script. The token expires after one hour.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
Example using registration token
Configure your self-hosted runner, replacing TOKEN
with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN
GitHub API docs for create_registration_token_for_org
pub fn create_registration_token_for_org(
&self,
org: &str
) -> Result<AuthenticationToken, ActionsCreateRegistrationTokenForOrgError>
pub fn create_registration_token_for_org(
&self,
org: &str
) -> Result<AuthenticationToken, ActionsCreateRegistrationTokenForOrgError>
Create a registration token for an organization
Returns a token that you can pass to the config
script. The token expires after one hour.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
Example using registration token
Configure your self-hosted runner, replacing TOKEN
with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN
GitHub API docs for create_registration_token_for_org
pub async fn create_registration_token_for_repo_async(
&self,
owner: &str,
repo: &str
) -> Result<AuthenticationToken, ActionsCreateRegistrationTokenForRepoError>
pub async fn create_registration_token_for_repo_async(
&self,
owner: &str,
repo: &str
) -> Result<AuthenticationToken, ActionsCreateRegistrationTokenForRepoError>
Create a registration token for a repository
Returns a token that you can pass to the config
script. The token expires after one hour. You must authenticate
using an access token with the repo
scope to use this endpoint.
Example using registration token
Configure your self-hosted runner, replacing TOKEN
with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
GitHub API docs for create_registration_token_for_repo
pub fn create_registration_token_for_repo(
&self,
owner: &str,
repo: &str
) -> Result<AuthenticationToken, ActionsCreateRegistrationTokenForRepoError>
pub fn create_registration_token_for_repo(
&self,
owner: &str,
repo: &str
) -> Result<AuthenticationToken, ActionsCreateRegistrationTokenForRepoError>
Create a registration token for a repository
Returns a token that you can pass to the config
script. The token expires after one hour. You must authenticate
using an access token with the repo
scope to use this endpoint.
Example using registration token
Configure your self-hosted runner, replacing TOKEN
with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
GitHub API docs for create_registration_token_for_repo
pub async fn create_remove_token_for_org_async(
&self,
org: &str
) -> Result<AuthenticationToken, ActionsCreateRemoveTokenForOrgError>
pub async fn create_remove_token_for_org_async(
&self,
org: &str
) -> Result<AuthenticationToken, ActionsCreateRemoveTokenForOrgError>
Create a remove token for an organization
Returns a token that you can pass to the config
script to remove a self-hosted runner from an organization. The token expires after one hour.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
Example using remove token
To remove your self-hosted runner from an organization, replace TOKEN
with the remove token provided by this
endpoint.
./config.sh remove --token TOKEN
GitHub API docs for create_remove_token_for_org
pub fn create_remove_token_for_org(
&self,
org: &str
) -> Result<AuthenticationToken, ActionsCreateRemoveTokenForOrgError>
pub fn create_remove_token_for_org(
&self,
org: &str
) -> Result<AuthenticationToken, ActionsCreateRemoveTokenForOrgError>
Create a remove token for an organization
Returns a token that you can pass to the config
script to remove a self-hosted runner from an organization. The token expires after one hour.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
Example using remove token
To remove your self-hosted runner from an organization, replace TOKEN
with the remove token provided by this
endpoint.
./config.sh remove --token TOKEN
GitHub API docs for create_remove_token_for_org
pub async fn create_remove_token_for_repo_async(
&self,
owner: &str,
repo: &str
) -> Result<AuthenticationToken, ActionsCreateRemoveTokenForRepoError>
pub async fn create_remove_token_for_repo_async(
&self,
owner: &str,
repo: &str
) -> Result<AuthenticationToken, ActionsCreateRemoveTokenForRepoError>
Create a remove token for a repository
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.
Example using remove token
To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
./config.sh remove --token TOKEN
GitHub API docs for create_remove_token_for_repo
pub fn create_remove_token_for_repo(
&self,
owner: &str,
repo: &str
) -> Result<AuthenticationToken, ActionsCreateRemoveTokenForRepoError>
pub fn create_remove_token_for_repo(
&self,
owner: &str,
repo: &str
) -> Result<AuthenticationToken, ActionsCreateRemoveTokenForRepoError>
Create a remove token for a repository
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.
You must authenticate using an access token with the repo
scope to use this endpoint.
Example using remove token
To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
./config.sh remove --token TOKEN
GitHub API docs for create_remove_token_for_repo
pub async fn create_self_hosted_runner_group_for_org_async(
&self,
org: &str,
body: PostActionsCreateSelfHostedRunnerGroupForOrg
) -> Result<RunnerGroupsOrg, ActionsCreateSelfHostedRunnerGroupForOrgError>
pub async fn create_self_hosted_runner_group_for_org_async(
&self,
org: &str,
body: PostActionsCreateSelfHostedRunnerGroupForOrg
) -> Result<RunnerGroupsOrg, ActionsCreateSelfHostedRunnerGroupForOrgError>
Create a self-hosted runner group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see “GitHub’s products.”
Creates a new self-hosted runner group for an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for create_self_hosted_runner_group_for_org
Create a self-hosted runner group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see “GitHub’s products.”
Creates a new self-hosted runner group for an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for create_self_hosted_runner_group_for_org
pub async fn create_workflow_dispatch_async(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId,
body: PostActionsCreateWorkflowDispatch
) -> Result<(), ActionsCreateWorkflowDispatchError>
pub async fn create_workflow_dispatch_async(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId,
body: PostActionsCreateWorkflowDispatch
) -> Result<(), ActionsCreateWorkflowDispatchError>
Create a workflow dispatch event
You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must configure your GitHub Actions workflow to run when the workflow_dispatch
webhook event occurs. The inputs
are configured in the workflow file. For more information about how to configure the workflow_dispatch
event in the workflow file, see “Events that trigger workflows.”
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint. For more information, see “Creating a personal access token for the command line.”
GitHub API docs for create_workflow_dispatch
pub fn create_workflow_dispatch(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId,
body: PostActionsCreateWorkflowDispatch
) -> Result<(), ActionsCreateWorkflowDispatchError>
pub fn create_workflow_dispatch(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId,
body: PostActionsCreateWorkflowDispatch
) -> Result<(), ActionsCreateWorkflowDispatchError>
Create a workflow dispatch event
You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must configure your GitHub Actions workflow to run when the workflow_dispatch
webhook event occurs. The inputs
are configured in the workflow file. For more information about how to configure the workflow_dispatch
event in the workflow file, see “Events that trigger workflows.”
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint. For more information, see “Creating a personal access token for the command line.”
GitHub API docs for create_workflow_dispatch
pub async fn delete_artifact_async(
&self,
owner: &str,
repo: &str,
artifact_id: i32
) -> Result<(), ActionsDeleteArtifactError>
pub async fn delete_artifact_async(
&self,
owner: &str,
repo: &str,
artifact_id: i32
) -> Result<(), ActionsDeleteArtifactError>
Delete an artifact
Deletes an artifact for a workflow run. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for delete_artifact
pub fn delete_artifact(
&self,
owner: &str,
repo: &str,
artifact_id: i32
) -> Result<(), ActionsDeleteArtifactError>
pub fn delete_artifact(
&self,
owner: &str,
repo: &str,
artifact_id: i32
) -> Result<(), ActionsDeleteArtifactError>
Delete an artifact
Deletes an artifact for a workflow run. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for delete_artifact
pub async fn delete_environment_secret_async(
&self,
repository_id: i32,
environment_name: &str,
secret_name: &str
) -> Result<(), ActionsDeleteEnvironmentSecretError>
pub async fn delete_environment_secret_async(
&self,
repository_id: i32,
environment_name: &str,
secret_name: &str
) -> Result<(), ActionsDeleteEnvironmentSecretError>
Delete an environment secret
Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for delete_environment_secret
pub fn delete_environment_secret(
&self,
repository_id: i32,
environment_name: &str,
secret_name: &str
) -> Result<(), ActionsDeleteEnvironmentSecretError>
pub fn delete_environment_secret(
&self,
repository_id: i32,
environment_name: &str,
secret_name: &str
) -> Result<(), ActionsDeleteEnvironmentSecretError>
Delete an environment secret
Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for delete_environment_secret
pub async fn delete_org_secret_async(
&self,
org: &str,
secret_name: &str
) -> Result<(), ActionsDeleteOrgSecretError>
pub async fn delete_org_secret_async(
&self,
org: &str,
secret_name: &str
) -> Result<(), ActionsDeleteOrgSecretError>
Delete an organization secret
Deletes a secret in an organization using the secret name. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for delete_org_secret
pub fn delete_org_secret(
&self,
org: &str,
secret_name: &str
) -> Result<(), ActionsDeleteOrgSecretError>
pub fn delete_org_secret(
&self,
org: &str,
secret_name: &str
) -> Result<(), ActionsDeleteOrgSecretError>
Delete an organization secret
Deletes a secret in an organization using the secret name. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for delete_org_secret
pub async fn delete_repo_secret_async(
&self,
owner: &str,
repo: &str,
secret_name: &str
) -> Result<(), ActionsDeleteRepoSecretError>
pub async fn delete_repo_secret_async(
&self,
owner: &str,
repo: &str,
secret_name: &str
) -> Result<(), ActionsDeleteRepoSecretError>
Delete a repository secret
Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for delete_repo_secret
pub fn delete_repo_secret(
&self,
owner: &str,
repo: &str,
secret_name: &str
) -> Result<(), ActionsDeleteRepoSecretError>
pub fn delete_repo_secret(
&self,
owner: &str,
repo: &str,
secret_name: &str
) -> Result<(), ActionsDeleteRepoSecretError>
Delete a repository secret
Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for delete_repo_secret
pub async fn delete_self_hosted_runner_from_org_async(
&self,
org: &str,
runner_id: i32
) -> Result<(), ActionsDeleteSelfHostedRunnerFromOrgError>
pub async fn delete_self_hosted_runner_from_org_async(
&self,
org: &str,
runner_id: i32
) -> Result<(), ActionsDeleteSelfHostedRunnerFromOrgError>
Delete a self-hosted runner from an organization
Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for delete_self_hosted_runner_from_org
pub fn delete_self_hosted_runner_from_org(
&self,
org: &str,
runner_id: i32
) -> Result<(), ActionsDeleteSelfHostedRunnerFromOrgError>
pub fn delete_self_hosted_runner_from_org(
&self,
org: &str,
runner_id: i32
) -> Result<(), ActionsDeleteSelfHostedRunnerFromOrgError>
Delete a self-hosted runner from an organization
Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for delete_self_hosted_runner_from_org
pub async fn delete_self_hosted_runner_from_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<(), ActionsDeleteSelfHostedRunnerFromRepoError>
pub async fn delete_self_hosted_runner_from_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<(), ActionsDeleteSelfHostedRunnerFromRepoError>
Delete a self-hosted runner from a repository
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub API docs for delete_self_hosted_runner_from_repo
pub fn delete_self_hosted_runner_from_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<(), ActionsDeleteSelfHostedRunnerFromRepoError>
pub fn delete_self_hosted_runner_from_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<(), ActionsDeleteSelfHostedRunnerFromRepoError>
Delete a self-hosted runner from a repository
Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub API docs for delete_self_hosted_runner_from_repo
pub async fn delete_self_hosted_runner_group_from_org_async(
&self,
org: &str,
runner_group_id: i32
) -> Result<(), ActionsDeleteSelfHostedRunnerGroupFromOrgError>
pub async fn delete_self_hosted_runner_group_from_org_async(
&self,
org: &str,
runner_group_id: i32
) -> Result<(), ActionsDeleteSelfHostedRunnerGroupFromOrgError>
Delete a self-hosted runner group from an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Deletes a self-hosted runner group for an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for delete_self_hosted_runner_group_from_org
pub fn delete_self_hosted_runner_group_from_org(
&self,
org: &str,
runner_group_id: i32
) -> Result<(), ActionsDeleteSelfHostedRunnerGroupFromOrgError>
pub fn delete_self_hosted_runner_group_from_org(
&self,
org: &str,
runner_group_id: i32
) -> Result<(), ActionsDeleteSelfHostedRunnerGroupFromOrgError>
Delete a self-hosted runner group from an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Deletes a self-hosted runner group for an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for delete_self_hosted_runner_group_from_org
pub async fn delete_workflow_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<(), ActionsDeleteWorkflowRunError>
pub async fn delete_workflow_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<(), ActionsDeleteWorkflowRunError>
Delete a workflow run
Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is
private you must use an access token with the repo
scope. GitHub Apps must have the actions:write
permission to use
this endpoint.
GitHub API docs for delete_workflow_run
pub fn delete_workflow_run(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<(), ActionsDeleteWorkflowRunError>
pub fn delete_workflow_run(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<(), ActionsDeleteWorkflowRunError>
Delete a workflow run
Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is
private you must use an access token with the repo
scope. GitHub Apps must have the actions:write
permission to use
this endpoint.
GitHub API docs for delete_workflow_run
pub async fn delete_workflow_run_logs_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<(), ActionsDeleteWorkflowRunLogsError>
pub async fn delete_workflow_run_logs_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<(), ActionsDeleteWorkflowRunLogsError>
Delete workflow run logs
Deletes all logs for a workflow run. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for delete_workflow_run_logs
pub fn delete_workflow_run_logs(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<(), ActionsDeleteWorkflowRunLogsError>
pub fn delete_workflow_run_logs(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<(), ActionsDeleteWorkflowRunLogsError>
Delete workflow run logs
Deletes all logs for a workflow run. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for delete_workflow_run_logs
pub async fn disable_selected_repository_github_actions_organization_async(
&self,
org: &str,
repository_id: i32
) -> Result<(), ActionsDisableSelectedRepositoryGithubActionsOrganizationError>
pub async fn disable_selected_repository_github_actions_organization_async(
&self,
org: &str,
repository_id: i32
) -> Result<(), ActionsDisableSelectedRepositoryGithubActionsOrganizationError>
Disable a selected repository for GitHub Actions in an organization
Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an organization.”
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for disable_selected_repository_github_actions_organization
pub fn disable_selected_repository_github_actions_organization(
&self,
org: &str,
repository_id: i32
) -> Result<(), ActionsDisableSelectedRepositoryGithubActionsOrganizationError>
pub fn disable_selected_repository_github_actions_organization(
&self,
org: &str,
repository_id: i32
) -> Result<(), ActionsDisableSelectedRepositoryGithubActionsOrganizationError>
Disable a selected repository for GitHub Actions in an organization
Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an organization.”
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for disable_selected_repository_github_actions_organization
pub async fn disable_workflow_async(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<(), ActionsDisableWorkflowError>
pub async fn disable_workflow_async(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<(), ActionsDisableWorkflowError>
Disable a workflow
Disables a workflow and sets the state
of the workflow to disabled_manually
. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for disable_workflow
pub fn disable_workflow(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<(), ActionsDisableWorkflowError>
pub fn disable_workflow(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<(), ActionsDisableWorkflowError>
Disable a workflow
Disables a workflow and sets the state
of the workflow to disabled_manually
. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for disable_workflow
pub async fn download_artifact_async(
&self,
owner: &str,
repo: &str,
artifact_id: i32,
archive_format: &str
) -> Result<(), ActionsDownloadArtifactError>
pub async fn download_artifact_async(
&self,
owner: &str,
repo: &str,
artifact_id: i32,
archive_format: &str
) -> Result<(), ActionsDownloadArtifactError>
Download an artifact
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location:
in
the response header to find the URL for the download. The :archive_format
must be zip
. Anyone with read access to
the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope.
GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for download_artifact
pub fn download_artifact(
&self,
owner: &str,
repo: &str,
artifact_id: i32,
archive_format: &str
) -> Result<(), ActionsDownloadArtifactError>
pub fn download_artifact(
&self,
owner: &str,
repo: &str,
artifact_id: i32,
archive_format: &str
) -> Result<(), ActionsDownloadArtifactError>
Download an artifact
Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location:
in
the response header to find the URL for the download. The :archive_format
must be zip
. Anyone with read access to
the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope.
GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for download_artifact
pub async fn download_job_logs_for_workflow_run_async(
&self,
owner: &str,
repo: &str,
job_id: i32
) -> Result<(), ActionsDownloadJobLogsForWorkflowRunError>
pub async fn download_job_logs_for_workflow_run_async(
&self,
owner: &str,
repo: &str,
job_id: i32
) -> Result<(), ActionsDownloadJobLogsForWorkflowRunError>
Download job logs for a workflow run
Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
for Location:
in the response header to find the URL for the download. Anyone with read access to the repository can
use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must
have the actions:read
permission to use this endpoint.
GitHub API docs for download_job_logs_for_workflow_run
pub fn download_job_logs_for_workflow_run(
&self,
owner: &str,
repo: &str,
job_id: i32
) -> Result<(), ActionsDownloadJobLogsForWorkflowRunError>
pub fn download_job_logs_for_workflow_run(
&self,
owner: &str,
repo: &str,
job_id: i32
) -> Result<(), ActionsDownloadJobLogsForWorkflowRunError>
Download job logs for a workflow run
Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
for Location:
in the response header to find the URL for the download. Anyone with read access to the repository can
use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must
have the actions:read
permission to use this endpoint.
GitHub API docs for download_job_logs_for_workflow_run
pub async fn download_workflow_run_attempt_logs_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
attempt_number: i32
) -> Result<(), ActionsDownloadWorkflowRunAttemptLogsError>
pub async fn download_workflow_run_attempt_logs_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
attempt_number: i32
) -> Result<(), ActionsDownloadWorkflowRunAttemptLogsError>
Download workflow run attempt logs
Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
1 minute. Look for Location:
in the response header to find the URL for the download. Anyone with read access to
the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope.
GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for download_workflow_run_attempt_logs
pub fn download_workflow_run_attempt_logs(
&self,
owner: &str,
repo: &str,
run_id: i32,
attempt_number: i32
) -> Result<(), ActionsDownloadWorkflowRunAttemptLogsError>
pub fn download_workflow_run_attempt_logs(
&self,
owner: &str,
repo: &str,
run_id: i32,
attempt_number: i32
) -> Result<(), ActionsDownloadWorkflowRunAttemptLogsError>
Download workflow run attempt logs
Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
1 minute. Look for Location:
in the response header to find the URL for the download. Anyone with read access to
the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope.
GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for download_workflow_run_attempt_logs
pub async fn download_workflow_run_logs_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<(), ActionsDownloadWorkflowRunLogsError>
pub async fn download_workflow_run_logs_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<(), ActionsDownloadWorkflowRunLogsError>
Download workflow run logs
Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
Location:
in the response header to find the URL for the download. Anyone with read access to the repository can use
this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have
the actions:read
permission to use this endpoint.
GitHub API docs for download_workflow_run_logs
pub fn download_workflow_run_logs(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<(), ActionsDownloadWorkflowRunLogsError>
pub fn download_workflow_run_logs(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<(), ActionsDownloadWorkflowRunLogsError>
Download workflow run logs
Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
Location:
in the response header to find the URL for the download. Anyone with read access to the repository can use
this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have
the actions:read
permission to use this endpoint.
GitHub API docs for download_workflow_run_logs
pub async fn enable_selected_repository_github_actions_organization_async(
&self,
org: &str,
repository_id: i32
) -> Result<(), ActionsEnableSelectedRepositoryGithubActionsOrganizationError>
pub async fn enable_selected_repository_github_actions_organization_async(
&self,
org: &str,
repository_id: i32
) -> Result<(), ActionsEnableSelectedRepositoryGithubActionsOrganizationError>
Enable a selected repository for GitHub Actions in an organization
Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be must be configured to selected
. For more information, see “Set GitHub Actions permissions for an organization.”
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for enable_selected_repository_github_actions_organization
pub fn enable_selected_repository_github_actions_organization(
&self,
org: &str,
repository_id: i32
) -> Result<(), ActionsEnableSelectedRepositoryGithubActionsOrganizationError>
pub fn enable_selected_repository_github_actions_organization(
&self,
org: &str,
repository_id: i32
) -> Result<(), ActionsEnableSelectedRepositoryGithubActionsOrganizationError>
Enable a selected repository for GitHub Actions in an organization
Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be must be configured to selected
. For more information, see “Set GitHub Actions permissions for an organization.”
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for enable_selected_repository_github_actions_organization
pub async fn enable_workflow_async(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<(), ActionsEnableWorkflowError>
pub async fn enable_workflow_async(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<(), ActionsEnableWorkflowError>
Enable a workflow
Enables a workflow and sets the state
of the workflow to active
. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for enable_workflow
pub fn enable_workflow(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<(), ActionsEnableWorkflowError>
pub fn enable_workflow(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<(), ActionsEnableWorkflowError>
Enable a workflow
Enables a workflow and sets the state
of the workflow to active
. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for enable_workflow
pub async fn get_allowed_actions_organization_async(
&self,
org: &str
) -> Result<PutActionsSetAllowedActionsRepository, ActionsGetAllowedActionsOrganizationError>
pub async fn get_allowed_actions_organization_async(
&self,
org: &str
) -> Result<PutActionsSetAllowedActionsRepository, ActionsGetAllowedActionsOrganizationError>
Get allowed actions for an organization
Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an organization.”“
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for get_allowed_actions_organization
pub fn get_allowed_actions_organization(
&self,
org: &str
) -> Result<PutActionsSetAllowedActionsRepository, ActionsGetAllowedActionsOrganizationError>
pub fn get_allowed_actions_organization(
&self,
org: &str
) -> Result<PutActionsSetAllowedActionsRepository, ActionsGetAllowedActionsOrganizationError>
Get allowed actions for an organization
Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an organization.”“
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for get_allowed_actions_organization
pub async fn get_allowed_actions_repository_async(
&self,
owner: &str,
repo: &str
) -> Result<PutActionsSetAllowedActionsRepository, ActionsGetAllowedActionsRepositoryError>
pub async fn get_allowed_actions_repository_async(
&self,
owner: &str,
repo: &str
) -> Result<PutActionsSetAllowedActionsRepository, ActionsGetAllowedActionsRepositoryError>
Get allowed actions for a repository
Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions
must be configured to selected
. For more information, see “Set GitHub Actions permissions for a repository.”
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration
repository permission to use this API.
GitHub API docs for get_allowed_actions_repository
pub fn get_allowed_actions_repository(
&self,
owner: &str,
repo: &str
) -> Result<PutActionsSetAllowedActionsRepository, ActionsGetAllowedActionsRepositoryError>
pub fn get_allowed_actions_repository(
&self,
owner: &str,
repo: &str
) -> Result<PutActionsSetAllowedActionsRepository, ActionsGetAllowedActionsRepositoryError>
Get allowed actions for a repository
Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions
must be configured to selected
. For more information, see “Set GitHub Actions permissions for a repository.”
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration
repository permission to use this API.
GitHub API docs for get_allowed_actions_repository
pub async fn get_artifact_async(
&self,
owner: &str,
repo: &str,
artifact_id: i32
) -> Result<Artifact, ActionsGetArtifactError>
pub async fn get_artifact_async(
&self,
owner: &str,
repo: &str,
artifact_id: i32
) -> Result<Artifact, ActionsGetArtifactError>
Get an artifact
Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_artifact
pub fn get_artifact(
&self,
owner: &str,
repo: &str,
artifact_id: i32
) -> Result<Artifact, ActionsGetArtifactError>
pub fn get_artifact(
&self,
owner: &str,
repo: &str,
artifact_id: i32
) -> Result<Artifact, ActionsGetArtifactError>
Get an artifact
Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_artifact
pub async fn get_environment_public_key_async(
&self,
repository_id: i32,
environment_name: &str
) -> Result<ActionsPublicKey, ActionsGetEnvironmentPublicKeyError>
pub async fn get_environment_public_key_async(
&self,
repository_id: i32,
environment_name: &str
) -> Result<ActionsPublicKey, ActionsGetEnvironmentPublicKeyError>
Get an environment public key
Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for get_environment_public_key
pub fn get_environment_public_key(
&self,
repository_id: i32,
environment_name: &str
) -> Result<ActionsPublicKey, ActionsGetEnvironmentPublicKeyError>
pub fn get_environment_public_key(
&self,
repository_id: i32,
environment_name: &str
) -> Result<ActionsPublicKey, ActionsGetEnvironmentPublicKeyError>
Get an environment public key
Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for get_environment_public_key
pub async fn get_environment_secret_async(
&self,
repository_id: i32,
environment_name: &str,
secret_name: &str
) -> Result<ActionsSecret, ActionsGetEnvironmentSecretError>
pub async fn get_environment_secret_async(
&self,
repository_id: i32,
environment_name: &str,
secret_name: &str
) -> Result<ActionsSecret, ActionsGetEnvironmentSecretError>
Get an environment secret
Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for get_environment_secret
pub fn get_environment_secret(
&self,
repository_id: i32,
environment_name: &str,
secret_name: &str
) -> Result<ActionsSecret, ActionsGetEnvironmentSecretError>
pub fn get_environment_secret(
&self,
repository_id: i32,
environment_name: &str,
secret_name: &str
) -> Result<ActionsSecret, ActionsGetEnvironmentSecretError>
Get an environment secret
Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for get_environment_secret
pub async fn get_github_actions_permissions_organization_async(
&self,
org: &str
) -> Result<ActionsOrganizationPermissions, ActionsGetGithubActionsPermissionsOrganizationError>
pub async fn get_github_actions_permissions_organization_async(
&self,
org: &str
) -> Result<ActionsOrganizationPermissions, ActionsGetGithubActionsPermissionsOrganizationError>
Get GitHub Actions permissions for an organization
Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for get_github_actions_permissions_organization
Get GitHub Actions permissions for an organization
Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for get_github_actions_permissions_organization
pub async fn get_github_actions_permissions_repository_async(
&self,
owner: &str,
repo: &str
) -> Result<ActionsRepositoryPermissions, ActionsGetGithubActionsPermissionsRepositoryError>
pub async fn get_github_actions_permissions_repository_async(
&self,
owner: &str,
repo: &str
) -> Result<ActionsRepositoryPermissions, ActionsGetGithubActionsPermissionsRepositoryError>
Get GitHub Actions permissions for a repository
Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
You must authenticate using an access token with the repo
scope to use this
endpoint. GitHub Apps must have the administration
repository permission to use this API.
GitHub API docs for get_github_actions_permissions_repository
pub fn get_github_actions_permissions_repository(
&self,
owner: &str,
repo: &str
) -> Result<ActionsRepositoryPermissions, ActionsGetGithubActionsPermissionsRepositoryError>
pub fn get_github_actions_permissions_repository(
&self,
owner: &str,
repo: &str
) -> Result<ActionsRepositoryPermissions, ActionsGetGithubActionsPermissionsRepositoryError>
Get GitHub Actions permissions for a repository
Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.
You must authenticate using an access token with the repo
scope to use this
endpoint. GitHub Apps must have the administration
repository permission to use this API.
GitHub API docs for get_github_actions_permissions_repository
pub async fn get_job_for_workflow_run_async(
&self,
owner: &str,
repo: &str,
job_id: i32
) -> Result<Job, ActionsGetJobForWorkflowRunError>
pub async fn get_job_for_workflow_run_async(
&self,
owner: &str,
repo: &str,
job_id: i32
) -> Result<Job, ActionsGetJobForWorkflowRunError>
Get a job for a workflow run
Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_job_for_workflow_run
pub fn get_job_for_workflow_run(
&self,
owner: &str,
repo: &str,
job_id: i32
) -> Result<Job, ActionsGetJobForWorkflowRunError>
pub fn get_job_for_workflow_run(
&self,
owner: &str,
repo: &str,
job_id: i32
) -> Result<Job, ActionsGetJobForWorkflowRunError>
Get a job for a workflow run
Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_job_for_workflow_run
pub async fn get_org_public_key_async(
&self,
org: &str
) -> Result<ActionsPublicKey, ActionsGetOrgPublicKeyError>
pub async fn get_org_public_key_async(
&self,
org: &str
) -> Result<ActionsPublicKey, ActionsGetOrgPublicKeyError>
Get an organization public key
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for get_org_public_key
pub fn get_org_public_key(
&self,
org: &str
) -> Result<ActionsPublicKey, ActionsGetOrgPublicKeyError>
pub fn get_org_public_key(
&self,
org: &str
) -> Result<ActionsPublicKey, ActionsGetOrgPublicKeyError>
Get an organization public key
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for get_org_public_key
pub async fn get_org_secret_async(
&self,
org: &str,
secret_name: &str
) -> Result<OrganizationActionsSecret, ActionsGetOrgSecretError>
pub async fn get_org_secret_async(
&self,
org: &str,
secret_name: &str
) -> Result<OrganizationActionsSecret, ActionsGetOrgSecretError>
Get an organization secret
Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for get_org_secret
pub fn get_org_secret(
&self,
org: &str,
secret_name: &str
) -> Result<OrganizationActionsSecret, ActionsGetOrgSecretError>
pub fn get_org_secret(
&self,
org: &str,
secret_name: &str
) -> Result<OrganizationActionsSecret, ActionsGetOrgSecretError>
Get an organization secret
Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for get_org_secret
pub async fn get_pending_deployments_for_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<Vec<PendingDeployment>, ActionsGetPendingDeploymentsForRunError>
pub async fn get_pending_deployments_for_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<Vec<PendingDeployment>, ActionsGetPendingDeploymentsForRunError>
Get pending deployments for a workflow run
Get all deployment environments for a workflow run that are waiting for protection rules to pass.
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_pending_deployments_for_run
pub fn get_pending_deployments_for_run(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<Vec<PendingDeployment>, ActionsGetPendingDeploymentsForRunError>
pub fn get_pending_deployments_for_run(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<Vec<PendingDeployment>, ActionsGetPendingDeploymentsForRunError>
Get pending deployments for a workflow run
Get all deployment environments for a workflow run that are waiting for protection rules to pass.
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_pending_deployments_for_run
pub async fn get_repo_public_key_async(
&self,
owner: &str,
repo: &str
) -> Result<ActionsPublicKey, ActionsGetRepoPublicKeyError>
pub async fn get_repo_public_key_async(
&self,
owner: &str,
repo: &str
) -> Result<ActionsPublicKey, ActionsGetRepoPublicKeyError>
Get a repository public key
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for get_repo_public_key
pub fn get_repo_public_key(
&self,
owner: &str,
repo: &str
) -> Result<ActionsPublicKey, ActionsGetRepoPublicKeyError>
pub fn get_repo_public_key(
&self,
owner: &str,
repo: &str
) -> Result<ActionsPublicKey, ActionsGetRepoPublicKeyError>
Get a repository public key
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for get_repo_public_key
pub async fn get_repo_secret_async(
&self,
owner: &str,
repo: &str,
secret_name: &str
) -> Result<ActionsSecret, ActionsGetRepoSecretError>
pub async fn get_repo_secret_async(
&self,
owner: &str,
repo: &str,
secret_name: &str
) -> Result<ActionsSecret, ActionsGetRepoSecretError>
Get a repository secret
Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for get_repo_secret
pub fn get_repo_secret(
&self,
owner: &str,
repo: &str,
secret_name: &str
) -> Result<ActionsSecret, ActionsGetRepoSecretError>
pub fn get_repo_secret(
&self,
owner: &str,
repo: &str,
secret_name: &str
) -> Result<ActionsSecret, ActionsGetRepoSecretError>
Get a repository secret
Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for get_repo_secret
pub async fn get_reviews_for_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<Vec<EnvironmentApprovals>, ActionsGetReviewsForRunError>
pub async fn get_reviews_for_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<Vec<EnvironmentApprovals>, ActionsGetReviewsForRunError>
Get the review history for a workflow run
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_reviews_for_run
pub fn get_reviews_for_run(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<Vec<EnvironmentApprovals>, ActionsGetReviewsForRunError>
pub fn get_reviews_for_run(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<Vec<EnvironmentApprovals>, ActionsGetReviewsForRunError>
Get the review history for a workflow run
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_reviews_for_run
pub async fn get_self_hosted_runner_for_org_async(
&self,
org: &str,
runner_id: i32
) -> Result<Runner, ActionsGetSelfHostedRunnerForOrgError>
pub async fn get_self_hosted_runner_for_org_async(
&self,
org: &str,
runner_id: i32
) -> Result<Runner, ActionsGetSelfHostedRunnerForOrgError>
Get a self-hosted runner for an organization
Gets a specific self-hosted runner configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for get_self_hosted_runner_for_org
pub fn get_self_hosted_runner_for_org(
&self,
org: &str,
runner_id: i32
) -> Result<Runner, ActionsGetSelfHostedRunnerForOrgError>
pub fn get_self_hosted_runner_for_org(
&self,
org: &str,
runner_id: i32
) -> Result<Runner, ActionsGetSelfHostedRunnerForOrgError>
Get a self-hosted runner for an organization
Gets a specific self-hosted runner configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for get_self_hosted_runner_for_org
pub async fn get_self_hosted_runner_for_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<Runner, ActionsGetSelfHostedRunnerForRepoError>
pub async fn get_self_hosted_runner_for_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<Runner, ActionsGetSelfHostedRunnerForRepoError>
Get a self-hosted runner for a repository
Gets a specific self-hosted runner configured in a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint.
GitHub API docs for get_self_hosted_runner_for_repo
pub fn get_self_hosted_runner_for_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<Runner, ActionsGetSelfHostedRunnerForRepoError>
pub fn get_self_hosted_runner_for_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<Runner, ActionsGetSelfHostedRunnerForRepoError>
Get a self-hosted runner for a repository
Gets a specific self-hosted runner configured in a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint.
GitHub API docs for get_self_hosted_runner_for_repo
pub async fn get_self_hosted_runner_group_for_org_async(
&self,
org: &str,
runner_group_id: i32
) -> Result<RunnerGroupsOrg, ActionsGetSelfHostedRunnerGroupForOrgError>
pub async fn get_self_hosted_runner_group_for_org_async(
&self,
org: &str,
runner_group_id: i32
) -> Result<RunnerGroupsOrg, ActionsGetSelfHostedRunnerGroupForOrgError>
Get a self-hosted runner group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Gets a specific self-hosted runner group for an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for get_self_hosted_runner_group_for_org
pub fn get_self_hosted_runner_group_for_org(
&self,
org: &str,
runner_group_id: i32
) -> Result<RunnerGroupsOrg, ActionsGetSelfHostedRunnerGroupForOrgError>
pub fn get_self_hosted_runner_group_for_org(
&self,
org: &str,
runner_group_id: i32
) -> Result<RunnerGroupsOrg, ActionsGetSelfHostedRunnerGroupForOrgError>
Get a self-hosted runner group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Gets a specific self-hosted runner group for an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for get_self_hosted_runner_group_for_org
pub async fn get_workflow_async(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<Workflow, ActionsGetWorkflowError>
pub async fn get_workflow_async(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<Workflow, ActionsGetWorkflowError>
Get a workflow
Gets a specific workflow. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_workflow
pub fn get_workflow(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<Workflow, ActionsGetWorkflowError>
pub fn get_workflow(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<Workflow, ActionsGetWorkflowError>
Get a workflow
Gets a specific workflow. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_workflow
pub async fn get_workflow_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
query_params: Option<impl Into<ActionsGetWorkflowRunParams>>
) -> Result<WorkflowRun, ActionsGetWorkflowRunError>
pub async fn get_workflow_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
query_params: Option<impl Into<ActionsGetWorkflowRunParams>>
) -> Result<WorkflowRun, ActionsGetWorkflowRunError>
Get a workflow run
Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_workflow_run
pub fn get_workflow_run(
&self,
owner: &str,
repo: &str,
run_id: i32,
query_params: Option<impl Into<ActionsGetWorkflowRunParams>>
) -> Result<WorkflowRun, ActionsGetWorkflowRunError>
pub fn get_workflow_run(
&self,
owner: &str,
repo: &str,
run_id: i32,
query_params: Option<impl Into<ActionsGetWorkflowRunParams>>
) -> Result<WorkflowRun, ActionsGetWorkflowRunError>
Get a workflow run
Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_workflow_run
pub async fn get_workflow_run_attempt_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
attempt_number: i32,
query_params: Option<impl Into<ActionsGetWorkflowRunAttemptParams>>
) -> Result<WorkflowRun, ActionsGetWorkflowRunAttemptError>
pub async fn get_workflow_run_attempt_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
attempt_number: i32,
query_params: Option<impl Into<ActionsGetWorkflowRunAttemptParams>>
) -> Result<WorkflowRun, ActionsGetWorkflowRunAttemptError>
Get a workflow run attempt
Gets a specific workflow run attempt. Anyone with read access to the repository
can use this endpoint. If the repository is private you must use an access token
with the repo
scope. GitHub Apps must have the actions:read
permission to
use this endpoint.
GitHub API docs for get_workflow_run_attempt
pub fn get_workflow_run_attempt(
&self,
owner: &str,
repo: &str,
run_id: i32,
attempt_number: i32,
query_params: Option<impl Into<ActionsGetWorkflowRunAttemptParams>>
) -> Result<WorkflowRun, ActionsGetWorkflowRunAttemptError>
pub fn get_workflow_run_attempt(
&self,
owner: &str,
repo: &str,
run_id: i32,
attempt_number: i32,
query_params: Option<impl Into<ActionsGetWorkflowRunAttemptParams>>
) -> Result<WorkflowRun, ActionsGetWorkflowRunAttemptError>
Get a workflow run attempt
Gets a specific workflow run attempt. Anyone with read access to the repository
can use this endpoint. If the repository is private you must use an access token
with the repo
scope. GitHub Apps must have the actions:read
permission to
use this endpoint.
GitHub API docs for get_workflow_run_attempt
pub async fn get_workflow_run_usage_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<WorkflowRunUsage, ActionsGetWorkflowRunUsageError>
pub async fn get_workflow_run_usage_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<WorkflowRunUsage, ActionsGetWorkflowRunUsageError>
Get workflow run usage
Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see “Managing billing for GitHub Actions”.
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_workflow_run_usage
pub fn get_workflow_run_usage(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<WorkflowRunUsage, ActionsGetWorkflowRunUsageError>
pub fn get_workflow_run_usage(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<WorkflowRunUsage, ActionsGetWorkflowRunUsageError>
Get workflow run usage
Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see “Managing billing for GitHub Actions”.
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_workflow_run_usage
pub async fn get_workflow_usage_async(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<WorkflowUsage, ActionsGetWorkflowUsageError>
pub async fn get_workflow_usage_async(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<WorkflowUsage, ActionsGetWorkflowUsageError>
Get workflow usage
Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see “Managing billing for GitHub Actions”.
You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_workflow_usage
pub fn get_workflow_usage(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<WorkflowUsage, ActionsGetWorkflowUsageError>
pub fn get_workflow_usage(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId
) -> Result<WorkflowUsage, ActionsGetWorkflowUsageError>
Get workflow usage
Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see “Managing billing for GitHub Actions”.
You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for get_workflow_usage
pub async fn list_artifacts_for_repo_async(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListArtifactsForRepoParams>>
) -> Result<GetActionsListWorkflowRunArtifactsResponse200, ActionsListArtifactsForRepoError>
pub async fn list_artifacts_for_repo_async(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListArtifactsForRepoParams>>
) -> Result<GetActionsListWorkflowRunArtifactsResponse200, ActionsListArtifactsForRepoError>
List artifacts for a repository
Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for list_artifacts_for_repo
pub fn list_artifacts_for_repo(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListArtifactsForRepoParams>>
) -> Result<GetActionsListWorkflowRunArtifactsResponse200, ActionsListArtifactsForRepoError>
pub fn list_artifacts_for_repo(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListArtifactsForRepoParams>>
) -> Result<GetActionsListWorkflowRunArtifactsResponse200, ActionsListArtifactsForRepoError>
List artifacts for a repository
Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for list_artifacts_for_repo
pub async fn list_environment_secrets_async(
&self,
repository_id: i32,
environment_name: &str,
query_params: Option<impl Into<ActionsListEnvironmentSecretsParams>>
) -> Result<GetActionsListEnvironmentSecretsResponse200, ActionsListEnvironmentSecretsError>
pub async fn list_environment_secrets_async(
&self,
repository_id: i32,
environment_name: &str,
query_params: Option<impl Into<ActionsListEnvironmentSecretsParams>>
) -> Result<GetActionsListEnvironmentSecretsResponse200, ActionsListEnvironmentSecretsError>
List environment secrets
Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for list_environment_secrets
pub fn list_environment_secrets(
&self,
repository_id: i32,
environment_name: &str,
query_params: Option<impl Into<ActionsListEnvironmentSecretsParams>>
) -> Result<GetActionsListEnvironmentSecretsResponse200, ActionsListEnvironmentSecretsError>
pub fn list_environment_secrets(
&self,
repository_id: i32,
environment_name: &str,
query_params: Option<impl Into<ActionsListEnvironmentSecretsParams>>
) -> Result<GetActionsListEnvironmentSecretsResponse200, ActionsListEnvironmentSecretsError>
List environment secrets
Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for list_environment_secrets
pub async fn list_jobs_for_workflow_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
query_params: Option<impl Into<ActionsListJobsForWorkflowRunParams<'api>>>
) -> Result<GetActionsListJobsForWorkflowRunResponse200, ActionsListJobsForWorkflowRunError>
pub async fn list_jobs_for_workflow_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
query_params: Option<impl Into<ActionsListJobsForWorkflowRunParams<'api>>>
) -> Result<GetActionsListJobsForWorkflowRunResponse200, ActionsListJobsForWorkflowRunError>
List jobs for a workflow run
Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
GitHub API docs for list_jobs_for_workflow_run
pub fn list_jobs_for_workflow_run(
&self,
owner: &str,
repo: &str,
run_id: i32,
query_params: Option<impl Into<ActionsListJobsForWorkflowRunParams<'api>>>
) -> Result<GetActionsListJobsForWorkflowRunResponse200, ActionsListJobsForWorkflowRunError>
pub fn list_jobs_for_workflow_run(
&self,
owner: &str,
repo: &str,
run_id: i32,
query_params: Option<impl Into<ActionsListJobsForWorkflowRunParams<'api>>>
) -> Result<GetActionsListJobsForWorkflowRunResponse200, ActionsListJobsForWorkflowRunError>
List jobs for a workflow run
Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
GitHub API docs for list_jobs_for_workflow_run
pub async fn list_jobs_for_workflow_run_attempt_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
attempt_number: i32,
query_params: Option<impl Into<ActionsListJobsForWorkflowRunAttemptParams>>
) -> Result<GetActionsListJobsForWorkflowRunResponse200, ActionsListJobsForWorkflowRunAttemptError>
pub async fn list_jobs_for_workflow_run_attempt_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
attempt_number: i32,
query_params: Option<impl Into<ActionsListJobsForWorkflowRunAttemptParams>>
) -> Result<GetActionsListJobsForWorkflowRunResponse200, ActionsListJobsForWorkflowRunAttemptError>
List jobs for a workflow run attempt
Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
GitHub API docs for list_jobs_for_workflow_run_attempt
pub fn list_jobs_for_workflow_run_attempt(
&self,
owner: &str,
repo: &str,
run_id: i32,
attempt_number: i32,
query_params: Option<impl Into<ActionsListJobsForWorkflowRunAttemptParams>>
) -> Result<GetActionsListJobsForWorkflowRunResponse200, ActionsListJobsForWorkflowRunAttemptError>
pub fn list_jobs_for_workflow_run_attempt(
&self,
owner: &str,
repo: &str,
run_id: i32,
attempt_number: i32,
query_params: Option<impl Into<ActionsListJobsForWorkflowRunAttemptParams>>
) -> Result<GetActionsListJobsForWorkflowRunResponse200, ActionsListJobsForWorkflowRunAttemptError>
List jobs for a workflow run attempt
Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
GitHub API docs for list_jobs_for_workflow_run_attempt
pub async fn list_labels_for_self_hosted_runner_for_org_async(
&self,
org: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsListLabelsForSelfHostedRunnerForOrgError>
pub async fn list_labels_for_self_hosted_runner_for_org_async(
&self,
org: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsListLabelsForSelfHostedRunnerForOrgError>
List labels for a self-hosted runner for an organization
Lists all labels for a self-hosted runner configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for list_labels_for_self_hosted_runner_for_org
pub fn list_labels_for_self_hosted_runner_for_org(
&self,
org: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsListLabelsForSelfHostedRunnerForOrgError>
pub fn list_labels_for_self_hosted_runner_for_org(
&self,
org: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsListLabelsForSelfHostedRunnerForOrgError>
List labels for a self-hosted runner for an organization
Lists all labels for a self-hosted runner configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for list_labels_for_self_hosted_runner_for_org
pub async fn list_labels_for_self_hosted_runner_for_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsListLabelsForSelfHostedRunnerForRepoError>
pub async fn list_labels_for_self_hosted_runner_for_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsListLabelsForSelfHostedRunnerForRepoError>
List labels for a self-hosted runner for a repository
Lists all labels for a self-hosted runner configured in a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint.
GitHub API docs for list_labels_for_self_hosted_runner_for_repo
pub fn list_labels_for_self_hosted_runner_for_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsListLabelsForSelfHostedRunnerForRepoError>
pub fn list_labels_for_self_hosted_runner_for_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsListLabelsForSelfHostedRunnerForRepoError>
List labels for a self-hosted runner for a repository
Lists all labels for a self-hosted runner configured in a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint.
GitHub API docs for list_labels_for_self_hosted_runner_for_repo
pub async fn list_org_secrets_async(
&self,
org: &str,
query_params: Option<impl Into<ActionsListOrgSecretsParams>>
) -> Result<GetActionsListOrgSecretsResponse200, ActionsListOrgSecretsError>
pub async fn list_org_secrets_async(
&self,
org: &str,
query_params: Option<impl Into<ActionsListOrgSecretsParams>>
) -> Result<GetActionsListOrgSecretsResponse200, ActionsListOrgSecretsError>
List organization secrets
Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for list_org_secrets
pub fn list_org_secrets(
&self,
org: &str,
query_params: Option<impl Into<ActionsListOrgSecretsParams>>
) -> Result<GetActionsListOrgSecretsResponse200, ActionsListOrgSecretsError>
pub fn list_org_secrets(
&self,
org: &str,
query_params: Option<impl Into<ActionsListOrgSecretsParams>>
) -> Result<GetActionsListOrgSecretsResponse200, ActionsListOrgSecretsError>
List organization secrets
Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for list_org_secrets
pub async fn list_repo_access_to_self_hosted_runner_group_in_org_async(
&self,
org: &str,
runner_group_id: i32,
query_params: Option<impl Into<ActionsListRepoAccessToSelfHostedRunnerGroupInOrgParams>>
) -> Result<GetActionsListRepoAccessToSelfHostedRunnerGroupInOrgResponse200, ActionsListRepoAccessToSelfHostedRunnerGroupInOrgError>
pub async fn list_repo_access_to_self_hosted_runner_group_in_org_async(
&self,
org: &str,
runner_group_id: i32,
query_params: Option<impl Into<ActionsListRepoAccessToSelfHostedRunnerGroupInOrgParams>>
) -> Result<GetActionsListRepoAccessToSelfHostedRunnerGroupInOrgResponse200, ActionsListRepoAccessToSelfHostedRunnerGroupInOrgError>
List repository access to a self-hosted runner group in an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see “GitHub’s products.”
Lists the repositories with access to a self-hosted runner group configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for list_repo_access_to_self_hosted_runner_group_in_org
pub fn list_repo_access_to_self_hosted_runner_group_in_org(
&self,
org: &str,
runner_group_id: i32,
query_params: Option<impl Into<ActionsListRepoAccessToSelfHostedRunnerGroupInOrgParams>>
) -> Result<GetActionsListRepoAccessToSelfHostedRunnerGroupInOrgResponse200, ActionsListRepoAccessToSelfHostedRunnerGroupInOrgError>
pub fn list_repo_access_to_self_hosted_runner_group_in_org(
&self,
org: &str,
runner_group_id: i32,
query_params: Option<impl Into<ActionsListRepoAccessToSelfHostedRunnerGroupInOrgParams>>
) -> Result<GetActionsListRepoAccessToSelfHostedRunnerGroupInOrgResponse200, ActionsListRepoAccessToSelfHostedRunnerGroupInOrgError>
List repository access to a self-hosted runner group in an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see “GitHub’s products.”
Lists the repositories with access to a self-hosted runner group configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for list_repo_access_to_self_hosted_runner_group_in_org
pub async fn list_repo_secrets_async(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListRepoSecretsParams>>
) -> Result<GetActionsListEnvironmentSecretsResponse200, ActionsListRepoSecretsError>
pub async fn list_repo_secrets_async(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListRepoSecretsParams>>
) -> Result<GetActionsListEnvironmentSecretsResponse200, ActionsListRepoSecretsError>
List repository secrets
Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for list_repo_secrets
pub fn list_repo_secrets(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListRepoSecretsParams>>
) -> Result<GetActionsListEnvironmentSecretsResponse200, ActionsListRepoSecretsError>
pub fn list_repo_secrets(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListRepoSecretsParams>>
) -> Result<GetActionsListEnvironmentSecretsResponse200, ActionsListRepoSecretsError>
List repository secrets
Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the secrets
repository permission to use this endpoint.
GitHub API docs for list_repo_secrets
pub async fn list_repo_workflows_async(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListRepoWorkflowsParams>>
) -> Result<GetActionsListRepoWorkflowsResponse200, ActionsListRepoWorkflowsError>
pub async fn list_repo_workflows_async(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListRepoWorkflowsParams>>
) -> Result<GetActionsListRepoWorkflowsResponse200, ActionsListRepoWorkflowsError>
List repository workflows
Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for list_repo_workflows
pub fn list_repo_workflows(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListRepoWorkflowsParams>>
) -> Result<GetActionsListRepoWorkflowsResponse200, ActionsListRepoWorkflowsError>
pub fn list_repo_workflows(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListRepoWorkflowsParams>>
) -> Result<GetActionsListRepoWorkflowsResponse200, ActionsListRepoWorkflowsError>
List repository workflows
Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for list_repo_workflows
pub async fn list_runner_applications_for_org_async(
&self,
org: &str
) -> Result<Vec<RunnerApplication>, ActionsListRunnerApplicationsForOrgError>
pub async fn list_runner_applications_for_org_async(
&self,
org: &str
) -> Result<Vec<RunnerApplication>, ActionsListRunnerApplicationsForOrgError>
List runner applications for an organization
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for list_runner_applications_for_org
pub fn list_runner_applications_for_org(
&self,
org: &str
) -> Result<Vec<RunnerApplication>, ActionsListRunnerApplicationsForOrgError>
pub fn list_runner_applications_for_org(
&self,
org: &str
) -> Result<Vec<RunnerApplication>, ActionsListRunnerApplicationsForOrgError>
List runner applications for an organization
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for list_runner_applications_for_org
pub async fn list_runner_applications_for_repo_async(
&self,
owner: &str,
repo: &str
) -> Result<Vec<RunnerApplication>, ActionsListRunnerApplicationsForRepoError>
pub async fn list_runner_applications_for_repo_async(
&self,
owner: &str,
repo: &str
) -> Result<Vec<RunnerApplication>, ActionsListRunnerApplicationsForRepoError>
List runner applications for a repository
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub API docs for list_runner_applications_for_repo
pub fn list_runner_applications_for_repo(
&self,
owner: &str,
repo: &str
) -> Result<Vec<RunnerApplication>, ActionsListRunnerApplicationsForRepoError>
pub fn list_runner_applications_for_repo(
&self,
owner: &str,
repo: &str
) -> Result<Vec<RunnerApplication>, ActionsListRunnerApplicationsForRepoError>
List runner applications for a repository
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub API docs for list_runner_applications_for_repo
pub async fn list_selected_repos_for_org_secret_async(
&self,
org: &str,
secret_name: &str,
query_params: Option<impl Into<ActionsListSelectedReposForOrgSecretParams>>
) -> Result<GetCodespacesListRepositoriesForSecretForAuthenticatedUserResponse200, ActionsListSelectedReposForOrgSecretError>
pub async fn list_selected_repos_for_org_secret_async(
&self,
org: &str,
secret_name: &str,
query_params: Option<impl Into<ActionsListSelectedReposForOrgSecretParams>>
) -> Result<GetCodespacesListRepositoriesForSecretForAuthenticatedUserResponse200, ActionsListSelectedReposForOrgSecretError>
List selected repositories for an organization secret
Lists all repositories that have been selected when the visibility
for repository access to a secret is set to selected
. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for list_selected_repos_for_org_secret
pub fn list_selected_repos_for_org_secret(
&self,
org: &str,
secret_name: &str,
query_params: Option<impl Into<ActionsListSelectedReposForOrgSecretParams>>
) -> Result<GetCodespacesListRepositoriesForSecretForAuthenticatedUserResponse200, ActionsListSelectedReposForOrgSecretError>
pub fn list_selected_repos_for_org_secret(
&self,
org: &str,
secret_name: &str,
query_params: Option<impl Into<ActionsListSelectedReposForOrgSecretParams>>
) -> Result<GetCodespacesListRepositoriesForSecretForAuthenticatedUserResponse200, ActionsListSelectedReposForOrgSecretError>
List selected repositories for an organization secret
Lists all repositories that have been selected when the visibility
for repository access to a secret is set to selected
. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for list_selected_repos_for_org_secret
pub async fn list_selected_repositories_enabled_github_actions_organization_async(
&self,
org: &str,
query_params: Option<impl Into<ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationParams>>
) -> Result<GetActionsListSelectedRepositoriesEnabledGithubActionsOrganizationResponse200, ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationError>
pub async fn list_selected_repositories_enabled_github_actions_organization_async(
&self,
org: &str,
query_params: Option<impl Into<ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationParams>>
) -> Result<GetActionsListSelectedRepositoriesEnabledGithubActionsOrganizationResponse200, ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationError>
List selected repositories enabled for GitHub Actions in an organization
Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an organization.”
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for list_selected_repositories_enabled_github_actions_organization
pub fn list_selected_repositories_enabled_github_actions_organization(
&self,
org: &str,
query_params: Option<impl Into<ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationParams>>
) -> Result<GetActionsListSelectedRepositoriesEnabledGithubActionsOrganizationResponse200, ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationError>
pub fn list_selected_repositories_enabled_github_actions_organization(
&self,
org: &str,
query_params: Option<impl Into<ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationParams>>
) -> Result<GetActionsListSelectedRepositoriesEnabledGithubActionsOrganizationResponse200, ActionsListSelectedRepositoriesEnabledGithubActionsOrganizationError>
List selected repositories enabled for GitHub Actions in an organization
Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an organization.”
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for list_selected_repositories_enabled_github_actions_organization
pub async fn list_self_hosted_runner_groups_for_org_async(
&self,
org: &str,
query_params: Option<impl Into<ActionsListSelfHostedRunnerGroupsForOrgParams>>
) -> Result<GetActionsListSelfHostedRunnerGroupsForOrgResponse200, ActionsListSelfHostedRunnerGroupsForOrgError>
pub async fn list_self_hosted_runner_groups_for_org_async(
&self,
org: &str,
query_params: Option<impl Into<ActionsListSelfHostedRunnerGroupsForOrgParams>>
) -> Result<GetActionsListSelfHostedRunnerGroupsForOrgResponse200, ActionsListSelfHostedRunnerGroupsForOrgError>
List self-hosted runner groups for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for list_self_hosted_runner_groups_for_org
pub fn list_self_hosted_runner_groups_for_org(
&self,
org: &str,
query_params: Option<impl Into<ActionsListSelfHostedRunnerGroupsForOrgParams>>
) -> Result<GetActionsListSelfHostedRunnerGroupsForOrgResponse200, ActionsListSelfHostedRunnerGroupsForOrgError>
pub fn list_self_hosted_runner_groups_for_org(
&self,
org: &str,
query_params: Option<impl Into<ActionsListSelfHostedRunnerGroupsForOrgParams>>
) -> Result<GetActionsListSelfHostedRunnerGroupsForOrgResponse200, ActionsListSelfHostedRunnerGroupsForOrgError>
List self-hosted runner groups for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for list_self_hosted_runner_groups_for_org
pub async fn list_self_hosted_runners_for_org_async(
&self,
org: &str,
query_params: Option<impl Into<ActionsListSelfHostedRunnersForOrgParams>>
) -> Result<GetActionsListSelfHostedRunnersForRepoResponse200, ActionsListSelfHostedRunnersForOrgError>
pub async fn list_self_hosted_runners_for_org_async(
&self,
org: &str,
query_params: Option<impl Into<ActionsListSelfHostedRunnersForOrgParams>>
) -> Result<GetActionsListSelfHostedRunnersForRepoResponse200, ActionsListSelfHostedRunnersForOrgError>
List self-hosted runners for an organization
Lists all self-hosted runners configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for list_self_hosted_runners_for_org
pub fn list_self_hosted_runners_for_org(
&self,
org: &str,
query_params: Option<impl Into<ActionsListSelfHostedRunnersForOrgParams>>
) -> Result<GetActionsListSelfHostedRunnersForRepoResponse200, ActionsListSelfHostedRunnersForOrgError>
pub fn list_self_hosted_runners_for_org(
&self,
org: &str,
query_params: Option<impl Into<ActionsListSelfHostedRunnersForOrgParams>>
) -> Result<GetActionsListSelfHostedRunnersForRepoResponse200, ActionsListSelfHostedRunnersForOrgError>
List self-hosted runners for an organization
Lists all self-hosted runners configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for list_self_hosted_runners_for_org
pub async fn list_self_hosted_runners_for_repo_async(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListSelfHostedRunnersForRepoParams>>
) -> Result<GetActionsListSelfHostedRunnersForRepoResponse200, ActionsListSelfHostedRunnersForRepoError>
pub async fn list_self_hosted_runners_for_repo_async(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListSelfHostedRunnersForRepoParams>>
) -> Result<GetActionsListSelfHostedRunnersForRepoResponse200, ActionsListSelfHostedRunnersForRepoError>
List self-hosted runners for a repository
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub API docs for list_self_hosted_runners_for_repo
pub fn list_self_hosted_runners_for_repo(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListSelfHostedRunnersForRepoParams>>
) -> Result<GetActionsListSelfHostedRunnersForRepoResponse200, ActionsListSelfHostedRunnersForRepoError>
pub fn list_self_hosted_runners_for_repo(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListSelfHostedRunnersForRepoParams>>
) -> Result<GetActionsListSelfHostedRunnersForRepoResponse200, ActionsListSelfHostedRunnersForRepoError>
List self-hosted runners for a repository
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo
scope to use this endpoint.
GitHub API docs for list_self_hosted_runners_for_repo
pub async fn list_self_hosted_runners_in_group_for_org_async(
&self,
org: &str,
runner_group_id: i32,
query_params: Option<impl Into<ActionsListSelfHostedRunnersInGroupForOrgParams>>
) -> Result<GetActionsListSelfHostedRunnersInGroupForOrgResponse200, ActionsListSelfHostedRunnersInGroupForOrgError>
pub async fn list_self_hosted_runners_in_group_for_org_async(
&self,
org: &str,
runner_group_id: i32,
query_params: Option<impl Into<ActionsListSelfHostedRunnersInGroupForOrgParams>>
) -> Result<GetActionsListSelfHostedRunnersInGroupForOrgResponse200, ActionsListSelfHostedRunnersInGroupForOrgError>
List self-hosted runners in a group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Lists self-hosted runners that are in a specific organization group.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for list_self_hosted_runners_in_group_for_org
pub fn list_self_hosted_runners_in_group_for_org(
&self,
org: &str,
runner_group_id: i32,
query_params: Option<impl Into<ActionsListSelfHostedRunnersInGroupForOrgParams>>
) -> Result<GetActionsListSelfHostedRunnersInGroupForOrgResponse200, ActionsListSelfHostedRunnersInGroupForOrgError>
pub fn list_self_hosted_runners_in_group_for_org(
&self,
org: &str,
runner_group_id: i32,
query_params: Option<impl Into<ActionsListSelfHostedRunnersInGroupForOrgParams>>
) -> Result<GetActionsListSelfHostedRunnersInGroupForOrgResponse200, ActionsListSelfHostedRunnersInGroupForOrgError>
List self-hosted runners in a group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Lists self-hosted runners that are in a specific organization group.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for list_self_hosted_runners_in_group_for_org
pub async fn list_workflow_run_artifacts_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
query_params: Option<impl Into<ActionsListWorkflowRunArtifactsParams>>
) -> Result<GetActionsListWorkflowRunArtifactsResponse200, ActionsListWorkflowRunArtifactsError>
pub async fn list_workflow_run_artifacts_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
query_params: Option<impl Into<ActionsListWorkflowRunArtifactsParams>>
) -> Result<GetActionsListWorkflowRunArtifactsResponse200, ActionsListWorkflowRunArtifactsError>
List workflow run artifacts
Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for list_workflow_run_artifacts
pub fn list_workflow_run_artifacts(
&self,
owner: &str,
repo: &str,
run_id: i32,
query_params: Option<impl Into<ActionsListWorkflowRunArtifactsParams>>
) -> Result<GetActionsListWorkflowRunArtifactsResponse200, ActionsListWorkflowRunArtifactsError>
pub fn list_workflow_run_artifacts(
&self,
owner: &str,
repo: &str,
run_id: i32,
query_params: Option<impl Into<ActionsListWorkflowRunArtifactsParams>>
) -> Result<GetActionsListWorkflowRunArtifactsResponse200, ActionsListWorkflowRunArtifactsError>
List workflow run artifacts
Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for list_workflow_run_artifacts
pub async fn list_workflow_runs_async(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId,
query_params: Option<impl Into<ActionsListWorkflowRunsParams<'api>>>
) -> Result<GetActionsListWorkflowRunsResponse200, ActionsListWorkflowRunsError>
pub async fn list_workflow_runs_async(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId,
query_params: Option<impl Into<ActionsListWorkflowRunsParams<'api>>>
) -> Result<GetActionsListWorkflowRunsResponse200, ActionsListWorkflowRunsError>
List workflow runs
List all workflow runs for a workflow. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope.
GitHub API docs for list_workflow_runs
pub fn list_workflow_runs(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId,
query_params: Option<impl Into<ActionsListWorkflowRunsParams<'api>>>
) -> Result<GetActionsListWorkflowRunsResponse200, ActionsListWorkflowRunsError>
pub fn list_workflow_runs(
&self,
owner: &str,
repo: &str,
workflow_id: WorkflowId,
query_params: Option<impl Into<ActionsListWorkflowRunsParams<'api>>>
) -> Result<GetActionsListWorkflowRunsResponse200, ActionsListWorkflowRunsError>
List workflow runs
List all workflow runs for a workflow. You can replace workflow_id
with the workflow file name. For example, you could use main.yaml
. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope.
GitHub API docs for list_workflow_runs
pub async fn list_workflow_runs_for_repo_async(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListWorkflowRunsForRepoParams<'api>>>
) -> Result<GetActionsListWorkflowRunsResponse200, ActionsListWorkflowRunsForRepoError>
pub async fn list_workflow_runs_for_repo_async(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListWorkflowRunsForRepoParams<'api>>>
) -> Result<GetActionsListWorkflowRunsResponse200, ActionsListWorkflowRunsForRepoError>
List workflow runs for a repository
Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for list_workflow_runs_for_repo
pub fn list_workflow_runs_for_repo(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListWorkflowRunsForRepoParams<'api>>>
) -> Result<GetActionsListWorkflowRunsResponse200, ActionsListWorkflowRunsForRepoError>
pub fn list_workflow_runs_for_repo(
&self,
owner: &str,
repo: &str,
query_params: Option<impl Into<ActionsListWorkflowRunsForRepoParams<'api>>>
) -> Result<GetActionsListWorkflowRunsResponse200, ActionsListWorkflowRunsForRepoError>
List workflow runs for a repository
Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo
scope. GitHub Apps must have the actions:read
permission to use this endpoint.
GitHub API docs for list_workflow_runs_for_repo
pub async fn re_run_workflow_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<HashMap<String, Value>, ActionsReRunWorkflowError>
pub async fn re_run_workflow_async(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<HashMap<String, Value>, ActionsReRunWorkflowError>
Re-run a workflow
Re-runs your workflow run using its id
. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for re_run_workflow
pub fn re_run_workflow(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<HashMap<String, Value>, ActionsReRunWorkflowError>
pub fn re_run_workflow(
&self,
owner: &str,
repo: &str,
run_id: i32
) -> Result<HashMap<String, Value>, ActionsReRunWorkflowError>
Re-run a workflow
Re-runs your workflow run using its id
. You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the actions:write
permission to use this endpoint.
GitHub API docs for re_run_workflow
Remove all custom labels from a self-hosted runner for an organization
Remove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for remove_all_custom_labels_from_self_hosted_runner_for_org
Remove all custom labels from a self-hosted runner for an organization
Remove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for remove_all_custom_labels_from_self_hosted_runner_for_org
pub async fn remove_all_custom_labels_from_self_hosted_runner_for_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoError>
pub async fn remove_all_custom_labels_from_self_hosted_runner_for_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoError>
Remove all custom labels from a self-hosted runner for a repository
Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner.
You must authenticate using an access token with the repo
scope to use this
endpoint.
GitHub API docs for remove_all_custom_labels_from_self_hosted_runner_for_repo
pub fn remove_all_custom_labels_from_self_hosted_runner_for_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoError>
pub fn remove_all_custom_labels_from_self_hosted_runner_for_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsRemoveAllCustomLabelsFromSelfHostedRunnerForRepoError>
Remove all custom labels from a self-hosted runner for a repository
Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner.
You must authenticate using an access token with the repo
scope to use this
endpoint.
GitHub API docs for remove_all_custom_labels_from_self_hosted_runner_for_repo
pub async fn remove_custom_label_from_self_hosted_runner_for_org_async(
&self,
org: &str,
runner_id: i32,
name: &str
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgError>
pub async fn remove_custom_label_from_self_hosted_runner_for_org_async(
&self,
org: &str,
runner_id: i32,
name: &str
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgError>
Remove a custom label from a self-hosted runner for an organization
Remove a custom label from a self-hosted runner configured in an organization. Returns the remaining labels from the runner.
This endpoint returns a 404 Not Found
status if the custom label is not
present on the runner.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for remove_custom_label_from_self_hosted_runner_for_org
pub fn remove_custom_label_from_self_hosted_runner_for_org(
&self,
org: &str,
runner_id: i32,
name: &str
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgError>
pub fn remove_custom_label_from_self_hosted_runner_for_org(
&self,
org: &str,
runner_id: i32,
name: &str
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsRemoveCustomLabelFromSelfHostedRunnerForOrgError>
Remove a custom label from a self-hosted runner for an organization
Remove a custom label from a self-hosted runner configured in an organization. Returns the remaining labels from the runner.
This endpoint returns a 404 Not Found
status if the custom label is not
present on the runner.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for remove_custom_label_from_self_hosted_runner_for_org
pub async fn remove_custom_label_from_self_hosted_runner_for_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32,
name: &str
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoError>
pub async fn remove_custom_label_from_self_hosted_runner_for_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32,
name: &str
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoError>
Remove a custom label from a self-hosted runner for a repository
Remove a custom label from a self-hosted runner configured in a repository. Returns the remaining labels from the runner.
This endpoint returns a 404 Not Found
status if the custom label is not
present on the runner.
You must authenticate using an access token with the repo
scope to use this
endpoint.
GitHub API docs for remove_custom_label_from_self_hosted_runner_for_repo
pub fn remove_custom_label_from_self_hosted_runner_for_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32,
name: &str
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoError>
pub fn remove_custom_label_from_self_hosted_runner_for_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32,
name: &str
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsRemoveCustomLabelFromSelfHostedRunnerForRepoError>
Remove a custom label from a self-hosted runner for a repository
Remove a custom label from a self-hosted runner configured in a repository. Returns the remaining labels from the runner.
This endpoint returns a 404 Not Found
status if the custom label is not
present on the runner.
You must authenticate using an access token with the repo
scope to use this
endpoint.
GitHub API docs for remove_custom_label_from_self_hosted_runner_for_repo
pub async fn remove_repo_access_to_self_hosted_runner_group_in_org_async(
&self,
org: &str,
runner_group_id: i32,
repository_id: i32
) -> Result<(), ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgError>
pub async fn remove_repo_access_to_self_hosted_runner_group_in_org_async(
&self,
org: &str,
runner_group_id: i32,
repository_id: i32
) -> Result<(), ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgError>
Remove repository access to a self-hosted runner group in an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see “Create a self-hosted runner group for an organization.”
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for remove_repo_access_to_self_hosted_runner_group_in_org
pub fn remove_repo_access_to_self_hosted_runner_group_in_org(
&self,
org: &str,
runner_group_id: i32,
repository_id: i32
) -> Result<(), ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgError>
pub fn remove_repo_access_to_self_hosted_runner_group_in_org(
&self,
org: &str,
runner_group_id: i32,
repository_id: i32
) -> Result<(), ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrgError>
Remove repository access to a self-hosted runner group in an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see “Create a self-hosted runner group for an organization.”
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for remove_repo_access_to_self_hosted_runner_group_in_org
pub async fn remove_selected_repo_from_org_secret_async(
&self,
org: &str,
secret_name: &str,
repository_id: i32
) -> Result<(), ActionsRemoveSelectedRepoFromOrgSecretError>
pub async fn remove_selected_repo_from_org_secret_async(
&self,
org: &str,
secret_name: &str,
repository_id: i32
) -> Result<(), ActionsRemoveSelectedRepoFromOrgSecretError>
Remove selected repository from an organization secret
Removes a repository from an organization secret when the visibility
for repository access is set to selected
. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for remove_selected_repo_from_org_secret
pub fn remove_selected_repo_from_org_secret(
&self,
org: &str,
secret_name: &str,
repository_id: i32
) -> Result<(), ActionsRemoveSelectedRepoFromOrgSecretError>
pub fn remove_selected_repo_from_org_secret(
&self,
org: &str,
secret_name: &str,
repository_id: i32
) -> Result<(), ActionsRemoveSelectedRepoFromOrgSecretError>
Remove selected repository from an organization secret
Removes a repository from an organization secret when the visibility
for repository access is set to selected
. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for remove_selected_repo_from_org_secret
pub async fn remove_self_hosted_runner_from_group_for_org_async(
&self,
org: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), ActionsRemoveSelfHostedRunnerFromGroupForOrgError>
pub async fn remove_self_hosted_runner_from_group_for_org_async(
&self,
org: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), ActionsRemoveSelfHostedRunnerFromGroupForOrgError>
Remove a self-hosted runner from a group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for remove_self_hosted_runner_from_group_for_org
pub fn remove_self_hosted_runner_from_group_for_org(
&self,
org: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), ActionsRemoveSelfHostedRunnerFromGroupForOrgError>
pub fn remove_self_hosted_runner_from_group_for_org(
&self,
org: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), ActionsRemoveSelfHostedRunnerFromGroupForOrgError>
Remove a self-hosted runner from a group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for remove_self_hosted_runner_from_group_for_org
pub async fn review_pending_deployments_for_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
body: PostActionsReviewPendingDeploymentsForRun
) -> Result<Vec<Deployment>, ActionsReviewPendingDeploymentsForRunError>
pub async fn review_pending_deployments_for_run_async(
&self,
owner: &str,
repo: &str,
run_id: i32,
body: PostActionsReviewPendingDeploymentsForRun
) -> Result<Vec<Deployment>, ActionsReviewPendingDeploymentsForRunError>
Review pending deployments for a workflow run
Approve or reject pending deployments that are waiting on approval by a required reviewer.
Anyone with read access to the repository contents and deployments can use this endpoint.
GitHub API docs for review_pending_deployments_for_run
pub fn review_pending_deployments_for_run(
&self,
owner: &str,
repo: &str,
run_id: i32,
body: PostActionsReviewPendingDeploymentsForRun
) -> Result<Vec<Deployment>, ActionsReviewPendingDeploymentsForRunError>
pub fn review_pending_deployments_for_run(
&self,
owner: &str,
repo: &str,
run_id: i32,
body: PostActionsReviewPendingDeploymentsForRun
) -> Result<Vec<Deployment>, ActionsReviewPendingDeploymentsForRunError>
Review pending deployments for a workflow run
Approve or reject pending deployments that are waiting on approval by a required reviewer.
Anyone with read access to the repository contents and deployments can use this endpoint.
GitHub API docs for review_pending_deployments_for_run
pub async fn set_allowed_actions_organization_async(
&self,
org: &str,
body: PutActionsSetAllowedActionsRepository
) -> Result<(), ActionsSetAllowedActionsOrganizationError>
pub async fn set_allowed_actions_organization_async(
&self,
org: &str,
body: PutActionsSetAllowedActionsRepository
) -> Result<(), ActionsSetAllowedActionsOrganizationError>
Set allowed actions for an organization
Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an organization.”
If the organization belongs to an enterprise that has selected
actions set at the enterprise level, then you cannot override any of the enterprise’s allowed actions settings.
To use the patterns_allowed
setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed
setting only applies to public repositories in the organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for set_allowed_actions_organization
pub fn set_allowed_actions_organization(
&self,
org: &str,
body: PutActionsSetAllowedActionsRepository
) -> Result<(), ActionsSetAllowedActionsOrganizationError>
pub fn set_allowed_actions_organization(
&self,
org: &str,
body: PutActionsSetAllowedActionsRepository
) -> Result<(), ActionsSetAllowedActionsOrganizationError>
Set allowed actions for an organization
Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an organization.”
If the organization belongs to an enterprise that has selected
actions set at the enterprise level, then you cannot override any of the enterprise’s allowed actions settings.
To use the patterns_allowed
setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed
setting only applies to public repositories in the organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for set_allowed_actions_organization
pub async fn set_allowed_actions_repository_async(
&self,
owner: &str,
repo: &str,
body: PutActionsSetAllowedActionsRepository
) -> Result<(), ActionsSetAllowedActionsRepositoryError>
pub async fn set_allowed_actions_repository_async(
&self,
owner: &str,
repo: &str,
body: PutActionsSetAllowedActionsRepository
) -> Result<(), ActionsSetAllowedActionsRepositoryError>
Set allowed actions for a repository
Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions
must be configured to selected
. For more information, see “Set GitHub Actions permissions for a repository.”
If the repository belongs to an organization or enterprise that has selected
actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.
To use the patterns_allowed
setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed
setting only applies to public repositories.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration
repository permission to use this API.
GitHub API docs for set_allowed_actions_repository
pub fn set_allowed_actions_repository(
&self,
owner: &str,
repo: &str,
body: PutActionsSetAllowedActionsRepository
) -> Result<(), ActionsSetAllowedActionsRepositoryError>
pub fn set_allowed_actions_repository(
&self,
owner: &str,
repo: &str,
body: PutActionsSetAllowedActionsRepository
) -> Result<(), ActionsSetAllowedActionsRepositoryError>
Set allowed actions for a repository
Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions
must be configured to selected
. For more information, see “Set GitHub Actions permissions for a repository.”
If the repository belongs to an organization or enterprise that has selected
actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.
To use the patterns_allowed
setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed
setting only applies to public repositories.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration
repository permission to use this API.
GitHub API docs for set_allowed_actions_repository
Set custom labels for a self-hosted runner for an organization
Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for set_custom_labels_for_self_hosted_runner_for_org
Set custom labels for a self-hosted runner for an organization
Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for set_custom_labels_for_self_hosted_runner_for_org
pub async fn set_custom_labels_for_self_hosted_runner_for_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32,
body: PutActionsSetCustomLabelsForSelfHostedRunnerForRepo
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsSetCustomLabelsForSelfHostedRunnerForRepoError>
pub async fn set_custom_labels_for_self_hosted_runner_for_repo_async(
&self,
owner: &str,
repo: &str,
runner_id: i32,
body: PutActionsSetCustomLabelsForSelfHostedRunnerForRepo
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsSetCustomLabelsForSelfHostedRunnerForRepoError>
Set custom labels for a self-hosted runner for a repository
Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint.
GitHub API docs for set_custom_labels_for_self_hosted_runner_for_repo
pub fn set_custom_labels_for_self_hosted_runner_for_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32,
body: PutActionsSetCustomLabelsForSelfHostedRunnerForRepo
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsSetCustomLabelsForSelfHostedRunnerForRepoError>
pub fn set_custom_labels_for_self_hosted_runner_for_repo(
&self,
owner: &str,
repo: &str,
runner_id: i32,
body: PutActionsSetCustomLabelsForSelfHostedRunnerForRepo
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, ActionsSetCustomLabelsForSelfHostedRunnerForRepoError>
Set custom labels for a self-hosted runner for a repository
Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository.
You must authenticate using an access token with the repo
scope to use this
endpoint.
GitHub API docs for set_custom_labels_for_self_hosted_runner_for_repo
pub async fn set_github_actions_permissions_organization_async(
&self,
org: &str,
body: PutActionsSetGithubActionsPermissionsOrganization
) -> Result<(), ActionsSetGithubActionsPermissionsOrganizationError>
pub async fn set_github_actions_permissions_organization_async(
&self,
org: &str,
body: PutActionsSetGithubActionsPermissionsOrganization
) -> Result<(), ActionsSetGithubActionsPermissionsOrganizationError>
Set GitHub Actions permissions for an organization
Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions
to selected
actions, then you cannot override them for the organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for set_github_actions_permissions_organization
Set GitHub Actions permissions for an organization
Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions
to selected
actions, then you cannot override them for the organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for set_github_actions_permissions_organization
pub async fn set_github_actions_permissions_repository_async(
&self,
owner: &str,
repo: &str,
body: PutActionsSetGithubActionsPermissionsRepository
) -> Result<(), ActionsSetGithubActionsPermissionsRepositoryError>
pub async fn set_github_actions_permissions_repository_async(
&self,
owner: &str,
repo: &str,
body: PutActionsSetGithubActionsPermissionsRepository
) -> Result<(), ActionsSetGithubActionsPermissionsRepositoryError>
Set GitHub Actions permissions for a repository
Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.
If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions
to selected
actions, then you cannot override them for the repository.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration
repository permission to use this API.
GitHub API docs for set_github_actions_permissions_repository
pub fn set_github_actions_permissions_repository(
&self,
owner: &str,
repo: &str,
body: PutActionsSetGithubActionsPermissionsRepository
) -> Result<(), ActionsSetGithubActionsPermissionsRepositoryError>
pub fn set_github_actions_permissions_repository(
&self,
owner: &str,
repo: &str,
body: PutActionsSetGithubActionsPermissionsRepository
) -> Result<(), ActionsSetGithubActionsPermissionsRepositoryError>
Set GitHub Actions permissions for a repository
Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.
If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions
to selected
actions, then you cannot override them for the repository.
You must authenticate using an access token with the repo
scope to use this endpoint. GitHub Apps must have the administration
repository permission to use this API.
GitHub API docs for set_github_actions_permissions_repository
pub async fn set_repo_access_to_self_hosted_runner_group_in_org_async(
&self,
org: &str,
runner_group_id: i32,
body: PutActionsSetRepoAccessToSelfHostedRunnerGroupInOrg
) -> Result<(), ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgError>
pub async fn set_repo_access_to_self_hosted_runner_group_in_org_async(
&self,
org: &str,
runner_group_id: i32,
body: PutActionsSetRepoAccessToSelfHostedRunnerGroupInOrg
) -> Result<(), ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgError>
Set repository access for a self-hosted runner group in an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for set_repo_access_to_self_hosted_runner_group_in_org
pub fn set_repo_access_to_self_hosted_runner_group_in_org(
&self,
org: &str,
runner_group_id: i32,
body: PutActionsSetRepoAccessToSelfHostedRunnerGroupInOrg
) -> Result<(), ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgError>
pub fn set_repo_access_to_self_hosted_runner_group_in_org(
&self,
org: &str,
runner_group_id: i32,
body: PutActionsSetRepoAccessToSelfHostedRunnerGroupInOrg
) -> Result<(), ActionsSetRepoAccessToSelfHostedRunnerGroupInOrgError>
Set repository access for a self-hosted runner group in an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for set_repo_access_to_self_hosted_runner_group_in_org
pub async fn set_selected_repos_for_org_secret_async(
&self,
org: &str,
secret_name: &str,
body: PutActionsSetSelectedReposForOrgSecret
) -> Result<(), ActionsSetSelectedReposForOrgSecretError>
pub async fn set_selected_repos_for_org_secret_async(
&self,
org: &str,
secret_name: &str,
body: PutActionsSetSelectedReposForOrgSecret
) -> Result<(), ActionsSetSelectedReposForOrgSecretError>
Set selected repositories for an organization secret
Replaces all repositories for an organization secret when the visibility
for repository access is set to selected
. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for set_selected_repos_for_org_secret
pub fn set_selected_repos_for_org_secret(
&self,
org: &str,
secret_name: &str,
body: PutActionsSetSelectedReposForOrgSecret
) -> Result<(), ActionsSetSelectedReposForOrgSecretError>
pub fn set_selected_repos_for_org_secret(
&self,
org: &str,
secret_name: &str,
body: PutActionsSetSelectedReposForOrgSecret
) -> Result<(), ActionsSetSelectedReposForOrgSecretError>
Set selected repositories for an organization secret
Replaces all repositories for an organization secret when the visibility
for repository access is set to selected
. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the secrets
organization permission to use this endpoint.
GitHub API docs for set_selected_repos_for_org_secret
Set selected repositories enabled for GitHub Actions in an organization
Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an organization.”
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for set_selected_repositories_enabled_github_actions_organization
Set selected repositories enabled for GitHub Actions in an organization
Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an organization.”
You must authenticate using an access token with the admin:org
scope to use this endpoint. GitHub Apps must have the administration
organization permission to use this API.
GitHub API docs for set_selected_repositories_enabled_github_actions_organization
pub async fn set_self_hosted_runners_in_group_for_org_async(
&self,
org: &str,
runner_group_id: i32,
body: PutActionsSetSelfHostedRunnersInGroupForOrg
) -> Result<(), ActionsSetSelfHostedRunnersInGroupForOrgError>
pub async fn set_self_hosted_runners_in_group_for_org_async(
&self,
org: &str,
runner_group_id: i32,
body: PutActionsSetSelfHostedRunnersInGroupForOrg
) -> Result<(), ActionsSetSelfHostedRunnersInGroupForOrgError>
Set self-hosted runners in a group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Replaces the list of self-hosted runners that are part of an organization runner group.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for set_self_hosted_runners_in_group_for_org
pub fn set_self_hosted_runners_in_group_for_org(
&self,
org: &str,
runner_group_id: i32,
body: PutActionsSetSelfHostedRunnersInGroupForOrg
) -> Result<(), ActionsSetSelfHostedRunnersInGroupForOrgError>
pub fn set_self_hosted_runners_in_group_for_org(
&self,
org: &str,
runner_group_id: i32,
body: PutActionsSetSelfHostedRunnersInGroupForOrg
) -> Result<(), ActionsSetSelfHostedRunnersInGroupForOrgError>
Set self-hosted runners in a group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Replaces the list of self-hosted runners that are part of an organization runner group.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for set_self_hosted_runners_in_group_for_org
pub async fn update_self_hosted_runner_group_for_org_async(
&self,
org: &str,
runner_group_id: i32,
body: PatchActionsUpdateSelfHostedRunnerGroupForOrg
) -> Result<RunnerGroupsOrg, ActionsUpdateSelfHostedRunnerGroupForOrgError>
pub async fn update_self_hosted_runner_group_for_org_async(
&self,
org: &str,
runner_group_id: i32,
body: PatchActionsUpdateSelfHostedRunnerGroupForOrg
) -> Result<RunnerGroupsOrg, ActionsUpdateSelfHostedRunnerGroupForOrgError>
Update a self-hosted runner group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Updates the name
and visibility
of a self-hosted runner group in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for update_self_hosted_runner_group_for_org
pub fn update_self_hosted_runner_group_for_org(
&self,
org: &str,
runner_group_id: i32,
body: PatchActionsUpdateSelfHostedRunnerGroupForOrg
) -> Result<RunnerGroupsOrg, ActionsUpdateSelfHostedRunnerGroupForOrgError>
pub fn update_self_hosted_runner_group_for_org(
&self,
org: &str,
runner_group_id: i32,
body: PatchActionsUpdateSelfHostedRunnerGroupForOrg
) -> Result<RunnerGroupsOrg, ActionsUpdateSelfHostedRunnerGroupForOrgError>
Update a self-hosted runner group for an organization
The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see “GitHub’s products.”
Updates the name
and visibility
of a self-hosted runner group in an organization.
You must authenticate using an access token with the admin:org
scope to use this endpoint.
GitHub API docs for update_self_hosted_runner_group_for_org