A API de GitHub Actions permite que você gerencie GitHub Actions usando a API REST. Esta API está disponível para usuários autenticados, OAuth Apps e GitHub Apps. Os tokens de acesso exigem o escopo repo para repositórios privados e o escopo public_repo para repositórios públicos. GitHub Apps exige permissões mencionadas em cada ponto de extremidade. Para obter mais informações, confira "Documentação do GitHub Actions".
The REST API is now versioned. For more information, see "About API versioning."
Ações
Com a API de ações, você pode gerenciar e controlar GitHub Actions para uma organização ou repositório.
- GitHub Actions Artifacts
- List artifacts for a repository
- Get an artifact
- Delete an artifact
- Download an artifact
- List workflow run artifacts
- Cache do GitHub Actions
- Get GitHub Actions cache usage for an organization
- List repositories with GitHub Actions cache usage for an organization
- Get GitHub Actions cache usage for a repository
- List GitHub Actions caches for a repository
- Delete GitHub Actions caches for a repository (using a cache key)
- Delete a GitHub Actions cache for a repository (using a cache ID)
- OIDC do GitHub Actions
- Get the customization template for an OIDC subject claim for an organization
- Set the customization template for an OIDC subject claim for an organization
- Get the customization template for an OIDC subject claim for a repository
- Set the customization template for an OIDC subject claim for a repository
- Permissões de GitHub Actions
- Enable a selected organization for GitHub Actions in an enterprise
- Get GitHub Actions permissions for an organization
- Set GitHub Actions permissions for an organization
- List selected repositories enabled for GitHub Actions in an organization
- Set selected repositories enabled for GitHub Actions in an organization
- Enable a selected repository for GitHub Actions in an organization
- Disable a selected repository for GitHub Actions in an organization
- Get allowed actions and reusable workflows for an organization
- Set allowed actions and reusable workflows for an organization
- Get default workflow permissions for an organization
- Set default workflow permissions for an organization
- Get GitHub Actions permissions for a repository
- Set GitHub Actions permissions for a repository
- Get the level of access for workflows outside of the repository
- Set the level of access for workflows outside of the repository
- Get allowed actions and reusable workflows for a repository
- Set allowed actions and reusable workflows for a repository
- Get default workflow permissions for a repository
- Set default workflow permissions for a repository
- GitHub Actions Required Workflows
- List required workflows
- Create a required workflow
- Get a required workflow
- Update a required workflow
- Delete a required workflow
- List selected repositories for a required workflow
- Sets repositories for a required workflow
- Add a repository to a required workflow
- Remove a selected repository from required workflow
- List repository required workflows
- Get a required workflow entity for a repository
- Get required workflow usage
- Segredos do GitHub Actions
- List organization secrets
- Get an organization public key
- Get an organization secret
- Create or update an organization secret
- Delete an organization secret
- List selected repositories for an organization secret
- Set selected repositories for an organization secret
- Add selected repository to an organization secret
- Remove selected repository from an organization secret
- List repository secrets
- Get a repository public key
- Get a repository secret
- Create or update a repository secret
- Delete a repository secret
- List environment secrets
- Get an environment public key
- Get an environment secret
- Create or update an environment secret
- Delete an environment secret
- Grupos de runner auto-hospedados
- List self-hosted runner groups for an enterprise
- Create a self-hosted runner group for an enterprise
- Get a self-hosted runner group for an enterprise
- Add organization access to a self-hosted runner group in an enterprise
- Remove a self-hosted runner from a group for an enterprise
- List self-hosted runner groups for an organization
- Create a self-hosted runner group for an organization
- Get a self-hosted runner group for an organization
- Update a self-hosted runner group for an organization
- Delete a self-hosted runner group from an organization
- List repository access to a self-hosted runner group in an organization
- Set repository access for a self-hosted runner group in an organization
- Remove repository access to a self-hosted runner group in an organization
- List self-hosted runners in a group for an organization
- Set self-hosted runners in a group for an organization
- Add a self-hosted runner to a group for an organization
- Remove a self-hosted runner from a group for an organization
- Executores auto-hospedados
- Delete a self-hosted runner from an enterprise
- List labels for a self-hosted runner for an enterprise
- Add custom labels to a self-hosted runner for an enterprise
- List self-hosted runners for an organization
- List runner applications for an organization
- Create a registration token for an organization
- Create a remove token for an organization
- Get a self-hosted runner for an organization
- Delete a self-hosted runner from an organization
- List labels for a self-hosted runner for an organization
- Add custom labels to a self-hosted runner for an organization
- Set custom labels for a self-hosted runner for an organization
- Remove all custom labels from a self-hosted runner for an organization
- Remove a custom label from a self-hosted runner for an organization
- List self-hosted runners for a repository
- List runner applications for a repository
- Create a registration token for a repository
- Create a remove token for a repository
- Get a self-hosted runner for a repository
- Delete a self-hosted runner from a repository
- List labels for a self-hosted runner for a repository
- Add custom labels to a self-hosted runner for a repository
- Set custom labels for a self-hosted runner for a repository
- Remove all custom labels from a self-hosted runner for a repository
- Remove a custom label from a self-hosted runner for a repository
- GitHub Actions Variables
- List organization variables
- Create an organization variable
- Get an organization variable
- Update an organization variable
- Delete an organization variable
- List selected repositories for an organization variable
- Set selected repositories for an organization variable
- Add selected repository to an organization variable
- Remove selected repository from an organization variable
- List repository variables
- Create a repository variable
- Get a repository variable
- Update a repository variable
- Delete a repository variable
- List environment variables
- Create an environment variable
- Get an environment variable
- Update an environment variable
- Delete an environment variable
- Trabalhos de fluxo de trabalho
- Get a job for a workflow run
- Download job logs for a workflow run
- List jobs for a workflow run attempt
- List jobs for a workflow run
- Execução de fluxo de trabalho
- Re-run a job from a workflow run
- List workflow runs for a required workflow
- List workflow runs for a repository
- Get a workflow run
- Delete a workflow run
- Get the review history for a workflow run
- Approve a workflow run for a fork pull request
- Get a workflow run attempt
- Download workflow run attempt logs
- Cancel a workflow run
- Download workflow run logs
- Delete workflow run logs
- Get pending deployments for a workflow run
- Review pending deployments for a workflow run
- Re-run a workflow
- Re-run failed jobs from a workflow run
- Get workflow run usage
- List workflow runs for a workflow
- Fluxos de trabalho