How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Actions API

Endpoints to manage GitHub Actions using the REST API.

GitHub Actions API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Actions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 137 operations across 85 paths, and defines 53 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.

137 operations 85 paths 53 schemas 23 DELETE66 GET6 PATCH16 POST26 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Actions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 137

Across 85 paths, the API surfaces 137 operations — 23 DELETE, 66 GET, 6 PATCH, 16 POST, 26 PUT. Each is listed below with its method, path, parameters, and response codes.

Actions 137

Endpoints to manage GitHub Actions using the REST API.

GET
/enterprises/{enterprise}/actions/cache/usage
GitHub Get GitHub Actions Cache Usage for an Enterprise
actions/get-actions-cache-usage-for-enterprise 1 param → 200
GET
/enterprises/{enterprise}/actions/cache/usage-policy
GitHub Get GitHub Actions Cache Usage Policy for an Enterprise
actions/get-actions-cache-usage-policy-for-enterprise 1 param → 200
PATCH
/enterprises/{enterprise}/actions/cache/usage-policy
GitHub Set GitHub Actions Cache Usage Policy for an Enterprise
actions/set-actions-cache-usage-policy-for-enterprise 1 param body → 204
GET
/enterprises/{enterprise}/actions/permissions/workflow
GitHub Get Default Workflow Permissions for an Enterprise
actions/get-github-actions-default-workflow-permissions-enterprise 1 param → 200
PUT
/enterprises/{enterprise}/actions/permissions/workflow
GitHub Set Default Workflow Permissions for an Enterprise
actions/set-github-actions-default-workflow-permissions-enterprise 1 param body → 204
GET
/orgs/{org}/actions/cache/usage
GitHub Get GitHub Actions Cache Usage for an Organization
actions/get-actions-cache-usage-for-org 1 param → 200
GET
/orgs/{org}/actions/cache/usage-by-repository
GitHub List Repositories with GitHub Actions Cache Usage for an Organization
actions/get-actions-cache-usage-by-repo-for-org 3 params → 200
GET
/orgs/{org}/actions/permissions
GitHub Get GitHub Actions Permissions for an Organization
actions/get-github-actions-permissions-organization 1 param → 200
PUT
/orgs/{org}/actions/permissions
GitHub Set GitHub Actions Permissions for an Organization
actions/set-github-actions-permissions-organization 1 param body → 204
GET
/orgs/{org}/actions/permissions/repositories
GitHub List Selected Repositories Enabled for GitHub Actions in an Organization
actions/list-selected-repositories-enabled-github-actions-organization 3 params → 200
PUT
/orgs/{org}/actions/permissions/repositories
GitHub Set Selected Repositories Enabled for GitHub Actions in an Organization
actions/set-selected-repositories-enabled-github-actions-organization 1 param body → 204
PUT
/orgs/{org}/actions/permissions/repositories/{repository_id}
GitHub Enable a Selected Repository for GitHub Actions in an Organization
actions/enable-selected-repository-github-actions-organization 2 params → 204
DELETE
/orgs/{org}/actions/permissions/repositories/{repository_id}
GitHub Disable a Selected Repository for GitHub Actions in an Organization
actions/disable-selected-repository-github-actions-organization 2 params → 204
GET
/orgs/{org}/actions/permissions/selected-actions
GitHub Get Allowed Actions for an Organization
actions/get-allowed-actions-organization 1 param → 200
PUT
/orgs/{org}/actions/permissions/selected-actions
GitHub Set Allowed Actions for an Organization
actions/set-allowed-actions-organization 1 param body → 204
GET
/orgs/{org}/actions/permissions/workflow
GitHub Get Default Workflow Permissions for an Organization
actions/get-github-actions-default-workflow-permissions-organization 1 param → 200
PUT
/orgs/{org}/actions/permissions/workflow
GitHub Set Default Workflow Permissions for an Organization
actions/set-github-actions-default-workflow-permissions-organization 1 param body → 204409
GET
/orgs/{org}/actions/runner-groups
GitHub List Self-hosted Runner Groups for an Organization
actions/list-self-hosted-runner-groups-for-org 4 params → 200
POST
/orgs/{org}/actions/runner-groups
GitHub Create a Self-hosted Runner Group for an Organization
actions/create-self-hosted-runner-group-for-org 1 param body → 201
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}
GitHub Get a Self-hosted Runner Group for an Organization
actions/get-self-hosted-runner-group-for-org 2 params → 200
PATCH
/orgs/{org}/actions/runner-groups/{runner_group_id}
GitHub Update a Self-hosted Runner Group for an Organization
actions/update-self-hosted-runner-group-for-org 2 params body → 200
DELETE
/orgs/{org}/actions/runner-groups/{runner_group_id}
GitHub Delete a Self-hosted Runner Group from an Organization
actions/delete-self-hosted-runner-group-from-org 2 params → 204
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
GitHub List Repository Access to a Self-hosted Runner Group in an Organization
actions/list-repo-access-to-self-hosted-runner-group-in-org 4 params → 200
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
GitHub Set Repository Access for a Self-hosted Runner Group in an Organization
actions/set-repo-access-to-self-hosted-runner-group-in-org 2 params body → 204
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
GitHub Add Repository Access to a Self-hosted Runner Group in an Organization
actions/add-repo-access-to-self-hosted-runner-group-in-org 3 params → 204
DELETE
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
GitHub Remove Repository Access to a Self-hosted Runner Group in an Organization
actions/remove-repo-access-to-self-hosted-runner-group-in-org 3 params → 204
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners
GitHub List Self-hosted Runners in a Group for an Organization
actions/list-self-hosted-runners-in-group-for-org 4 params → 200
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners
GitHub Set Self-hosted Runners in a Group for an Organization
actions/set-self-hosted-runners-in-group-for-org 2 params body → 204
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
GitHub Add a Self-hosted Runner to a Group for an Organization
actions/add-self-hosted-runner-to-group-for-org 3 params → 204
DELETE
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
GitHub Remove a Self-hosted Runner from a Group for an Organization
actions/remove-self-hosted-runner-from-group-for-org 3 params → 204
GET
/orgs/{org}/actions/runners
GitHub List Self-hosted Runners for an Organization
actions/list-self-hosted-runners-for-org 3 params → 200
GET
/orgs/{org}/actions/runners/downloads
GitHub List Runner Applications for an Organization
actions/list-runner-applications-for-org 1 param → 200
POST
/orgs/{org}/actions/runners/registration-token
GitHub Create a Registration Token for an Organization
actions/create-registration-token-for-org 1 param → 201
POST
/orgs/{org}/actions/runners/remove-token
GitHub Create a Remove Token for an Organization
actions/create-remove-token-for-org 1 param → 201
GET
/orgs/{org}/actions/runners/{runner_id}
GitHub Get a Self-hosted Runner for an Organization
actions/get-self-hosted-runner-for-org 2 params → 200
DELETE
/orgs/{org}/actions/runners/{runner_id}
GitHub Delete a Self-hosted Runner from an Organization
actions/delete-self-hosted-runner-from-org 2 params → 204
GET
/orgs/{org}/actions/runners/{runner_id}/labels
GitHub List Labels for a Self-hosted Runner for an Organization
actions/list-labels-for-self-hosted-runner-for-org 2 params → 200404
POST
/orgs/{org}/actions/runners/{runner_id}/labels
GitHub Add Custom Labels to a Self-hosted Runner for an Organization
actions/add-custom-labels-to-self-hosted-runner-for-org 2 params body → 200404422
PUT
/orgs/{org}/actions/runners/{runner_id}/labels
GitHub Set Custom Labels for a Self-hosted Runner for an Organization
actions/set-custom-labels-for-self-hosted-runner-for-org 2 params body → 200404422
DELETE
/orgs/{org}/actions/runners/{runner_id}/labels
GitHub Remove All Custom Labels from a Self-hosted Runner for an Organization
actions/remove-all-custom-labels-from-self-hosted-runner-for-org 2 params → 200404
DELETE
/orgs/{org}/actions/runners/{runner_id}/labels/{name}
GitHub Remove a Custom Label from a Self-hosted Runner for an Organization
actions/remove-custom-label-from-self-hosted-runner-for-org 3 params → 200404422
GET
/orgs/{org}/actions/secrets
GitHub List Organization Secrets
actions/list-org-secrets 3 params → 200
GET
/orgs/{org}/actions/secrets/public-key
GitHub Get an Organization Public Key
actions/get-org-public-key 1 param → 200
GET
/orgs/{org}/actions/secrets/{secret_name}
GitHub Get an Organization Secret
actions/get-org-secret 2 params → 200
PUT
/orgs/{org}/actions/secrets/{secret_name}
GitHub Create or Update an Organization Secret
actions/create-or-update-org-secret 2 params body → 201204
DELETE
/orgs/{org}/actions/secrets/{secret_name}
GitHub Delete an Organization Secret
actions/delete-org-secret 2 params → 204
GET
/orgs/{org}/actions/secrets/{secret_name}/repositories
GitHub List Selected Repositories for an Organization Secret
actions/list-selected-repos-for-org-secret 4 params → 200
PUT
/orgs/{org}/actions/secrets/{secret_name}/repositories
GitHub Set Selected Repositories for an Organization Secret
actions/set-selected-repos-for-org-secret 2 params body → 204
PUT
/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}
GitHub Add Selected Repository to an Organization Secret
actions/add-selected-repo-to-org-secret 3 params → 204409
DELETE
/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}
GitHub Remove Selected Repository from an Organization Secret
actions/remove-selected-repo-from-org-secret 3 params → 204409
GET
/orgs/{org}/actions/variables
GitHub List Organization Variables
actions/list-org-variables 3 params → 200
POST
/orgs/{org}/actions/variables
GitHub Create an Organization Variable
actions/create-org-variable 1 param body → 201
GET
/orgs/{org}/actions/variables/{name}
GitHub Get an Organization Variable
actions/get-org-variable 2 params → 200
PATCH
/orgs/{org}/actions/variables/{name}
GitHub Update an Organization Variable
actions/update-org-variable 2 params body → 204
DELETE
/orgs/{org}/actions/variables/{name}
GitHub Delete an Organization Variable
actions/delete-org-variable 2 params → 204
GET
/orgs/{org}/actions/variables/{name}/repositories
GitHub List Selected Repositories for an Organization Variable
actions/list-selected-repos-for-org-variable 4 params → 200409
PUT
/orgs/{org}/actions/variables/{name}/repositories
GitHub Set Selected Repositories for an Organization Variable
actions/set-selected-repos-for-org-variable 2 params body → 204409
PUT
/orgs/{org}/actions/variables/{name}/repositories/{repository_id}
GitHub Add Selected Repository to an Organization Variable
actions/add-selected-repo-to-org-variable 3 params → 204409
DELETE
/orgs/{org}/actions/variables/{name}/repositories/{repository_id}
GitHub Remove Selected Repository from an Organization Variable
actions/remove-selected-repo-from-org-variable 3 params → 204409
GET
/repos/{owner}/{repo}/actions/artifacts
GitHub List Artifacts for a Repository
actions/list-artifacts-for-repo 5 params → 200
GET
/repos/{owner}/{repo}/actions/artifacts/{artifact_id}
GitHub Get an Artifact
actions/get-artifact 3 params → 200
DELETE
/repos/{owner}/{repo}/actions/artifacts/{artifact_id}
GitHub Delete an Artifact
actions/delete-artifact 3 params → 204
GET
/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}
GitHub Download an Artifact
actions/download-artifact 4 params → 302410
GET
/repos/{owner}/{repo}/actions/cache/usage
GitHub Get GitHub Actions Cache Usage for a Repository
actions/get-actions-cache-usage 2 params → 200
GET
/repos/{owner}/{repo}/actions/cache/usage-policy
GitHub Get GitHub Actions Cache Usage Policy for a Repository
actions/get-actions-cache-usage-policy 2 params → 200
PATCH
/repos/{owner}/{repo}/actions/cache/usage-policy
GitHub Set GitHub Actions Cache Usage Policy for a Repository
actions/set-actions-cache-usage-policy 2 params body → 204
GET
/repos/{owner}/{repo}/actions/caches
GitHub List GitHub Actions Caches for a Repository
actions/get-actions-cache-list 8 params → 200
DELETE
/repos/{owner}/{repo}/actions/caches
GitHub Delete GitHub Actions Caches for a Repository (using a Cache Key)
actions/delete-actions-cache-by-key 4 params → 200
DELETE
/repos/{owner}/{repo}/actions/caches/{cache_id}
GitHub Delete a GitHub Actions Cache for a Repository (using a Cache ID)
actions/delete-actions-cache-by-id 3 params → 204
GET
/repos/{owner}/{repo}/actions/jobs/{job_id}
GitHub Get a Job for a Workflow Run
actions/get-job-for-workflow-run 3 params → 200
GET
/repos/{owner}/{repo}/actions/jobs/{job_id}/logs
GitHub Download Job Logs for a Workflow Run
actions/download-job-logs-for-workflow-run 3 params → 302
POST
/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun
GitHub Re-run a Job from a Workflow Run
actions/re-run-job-for-workflow-run 3 params body → 201403
GET
/repos/{owner}/{repo}/actions/oidc/customization/sub
GitHub Get the Customization Template for an OIDC Subject Claim for a Repository
actions/get-custom-oidc-sub-claim-for-repo 2 params → 200400404
PUT
/repos/{owner}/{repo}/actions/oidc/customization/sub
GitHub Set the Customization Template for an OIDC Subject Claim for a Repository
actions/set-custom-oidc-sub-claim-for-repo 2 params body → 201400404422
GET
/repos/{owner}/{repo}/actions/organization-secrets
GitHub List Repository Organization Secrets
actions/list-repo-organization-secrets 4 params → 200
GET
/repos/{owner}/{repo}/actions/organization-variables
GitHub List Repository Organization Variables
actions/list-repo-organization-variables 4 params → 200
GET
/repos/{owner}/{repo}/actions/permissions
GitHub Get GitHub Actions Permissions for a Repository
actions/get-github-actions-permissions-repository 2 params → 200
PUT
/repos/{owner}/{repo}/actions/permissions
GitHub Set GitHub Actions Permissions for a Repository
actions/set-github-actions-permissions-repository 2 params body → 204
GET
/repos/{owner}/{repo}/actions/permissions/access
GitHub Get the Level of Access for Workflows Outside of the Repository
actions/get-workflow-access-to-repository 2 params → 200
PUT
/repos/{owner}/{repo}/actions/permissions/access
GitHub Set the Level of Access for Workflows Outside of the Repository
actions/set-workflow-access-to-repository 2 params body → 204
GET
/repos/{owner}/{repo}/actions/permissions/selected-actions
GitHub Get Allowed Actions for a Repository
actions/get-allowed-actions-repository 2 params → 200
PUT
/repos/{owner}/{repo}/actions/permissions/selected-actions
GitHub Set Allowed Actions for a Repository
actions/set-allowed-actions-repository 2 params body → 204
GET
/repos/{owner}/{repo}/actions/permissions/workflow
GitHub Get Default Workflow Permissions for a Repository
actions/get-github-actions-default-workflow-permissions-repository 2 params → 200
PUT
/repos/{owner}/{repo}/actions/permissions/workflow
GitHub Set Default Workflow Permissions for a Repository
actions/set-github-actions-default-workflow-permissions-repository 2 params body → 204409
GET
/repos/{owner}/{repo}/actions/runners
GitHub List Self-hosted Runners for a Repository
actions/list-self-hosted-runners-for-repo 4 params → 200
GET
/repos/{owner}/{repo}/actions/runners/downloads
GitHub List Runner Applications for a Repository
actions/list-runner-applications-for-repo 2 params → 200
POST
/repos/{owner}/{repo}/actions/runners/registration-token
GitHub Create a Registration Token for a Repository
actions/create-registration-token-for-repo 2 params → 201
POST
/repos/{owner}/{repo}/actions/runners/remove-token
GitHub Create a Remove Token for a Repository
actions/create-remove-token-for-repo 2 params → 201
GET
/repos/{owner}/{repo}/actions/runners/{runner_id}
GitHub Get a Self-hosted Runner for a Repository
actions/get-self-hosted-runner-for-repo 3 params → 200
DELETE
/repos/{owner}/{repo}/actions/runners/{runner_id}
GitHub Delete a Self-hosted Runner from a Repository
actions/delete-self-hosted-runner-from-repo 3 params → 204
GET
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
GitHub List Labels for a Self-hosted Runner for a Repository
actions/list-labels-for-self-hosted-runner-for-repo 3 params → 200404
POST
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
GitHub Add Custom Labels to a Self-hosted Runner for a Repository
actions/add-custom-labels-to-self-hosted-runner-for-repo 3 params body → 200404422
PUT
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
GitHub Set Custom Labels for a Self-hosted Runner for a Repository
actions/set-custom-labels-for-self-hosted-runner-for-repo 3 params body → 200404422
DELETE
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels
GitHub Remove All Custom Labels from a Self-hosted Runner for a Repository
actions/remove-all-custom-labels-from-self-hosted-runner-for-repo 3 params → 200404
DELETE
/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}
GitHub Remove a Custom Label from a Self-hosted Runner for a Repository
actions/remove-custom-label-from-self-hosted-runner-for-repo 4 params → 200404422
GET
/repos/{owner}/{repo}/actions/runs
GitHub List Workflow Runs for a Repository
actions/list-workflow-runs-for-repo 12 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}
GitHub Get a Workflow Run
actions/get-workflow-run 4 params → 200
DELETE
/repos/{owner}/{repo}/actions/runs/{run_id}
GitHub Delete a Workflow Run
actions/delete-workflow-run 3 params → 204
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/approvals
GitHub Get the Review History for a Workflow Run
actions/get-reviews-for-run 3 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts
GitHub List Workflow Run Artifacts
actions/list-workflow-run-artifacts 6 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}
GitHub Get a Workflow Run Attempt
actions/get-workflow-run-attempt 5 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs
GitHub List Jobs for a Workflow Run Attempt
actions/list-jobs-for-workflow-run-attempt 6 params → 200404
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs
GitHub Download Workflow Run Attempt Logs
actions/download-workflow-run-attempt-logs 4 params → 302
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/cancel
GitHub Cancel a Workflow Run
actions/cancel-workflow-run 3 params → 202409
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/jobs
GitHub List Jobs for a Workflow Run
actions/list-jobs-for-workflow-run 6 params → 200
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/logs
GitHub Download Workflow Run Logs
actions/download-workflow-run-logs 3 params → 302
DELETE
/repos/{owner}/{repo}/actions/runs/{run_id}/logs
GitHub Delete Workflow Run Logs
actions/delete-workflow-run-logs 3 params → 204403500
GET
/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
GitHub Get Pending Deployments for a Workflow Run
actions/get-pending-deployments-for-run 3 params → 200
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments
GitHub Review Pending Deployments for a Workflow Run
actions/review-pending-deployments-for-run 3 params body → 200
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/rerun
GitHub Re-run a Workflow
actions/re-run-workflow 3 params body → 201
POST
/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs
GitHub Re-run Failed Jobs from a Workflow Run
actions/re-run-workflow-failed-jobs 3 params body → 201
GET
/repos/{owner}/{repo}/actions/secrets
GitHub List Repository Secrets
actions/list-repo-secrets 4 params → 200
GET
/repos/{owner}/{repo}/actions/secrets/public-key
GitHub Get a Repository Public Key
actions/get-repo-public-key 2 params → 200
GET
/repos/{owner}/{repo}/actions/secrets/{secret_name}
GitHub Get a Repository Secret
actions/get-repo-secret 3 params → 200
PUT
/repos/{owner}/{repo}/actions/secrets/{secret_name}
GitHub Create or Update a Repository Secret
actions/create-or-update-repo-secret 3 params body → 201204
DELETE
/repos/{owner}/{repo}/actions/secrets/{secret_name}
GitHub Delete a Repository Secret
actions/delete-repo-secret 3 params → 204
GET
/repos/{owner}/{repo}/actions/variables
GitHub List Repository Variables
actions/list-repo-variables 4 params → 200
POST
/repos/{owner}/{repo}/actions/variables
GitHub Create a Repository Variable
actions/create-repo-variable 2 params body → 201
GET
/repos/{owner}/{repo}/actions/variables/{name}
GitHub Get a Repository Variable
actions/get-repo-variable 3 params → 200
PATCH
/repos/{owner}/{repo}/actions/variables/{name}
GitHub Update a Repository Variable
actions/update-repo-variable 3 params body → 204
DELETE
/repos/{owner}/{repo}/actions/variables/{name}
GitHub Delete a Repository Variable
actions/delete-repo-variable 3 params → 204
GET
/repos/{owner}/{repo}/actions/workflows
GitHub List Repository Workflows
actions/list-repo-workflows 4 params → 200
GET
/repos/{owner}/{repo}/actions/workflows/{workflow_id}
GitHub Get a Workflow
actions/get-workflow 3 params → 200
PUT
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable
GitHub Disable a Workflow
actions/disable-workflow 3 params → 204
POST
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches
GitHub Create a Workflow Dispatch Event
actions/create-workflow-dispatch 3 params body → 204
PUT
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable
GitHub Enable a Workflow
actions/enable-workflow 3 params → 204
GET
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs
GitHub List Workflow Runs for a Workflow
actions/list-workflow-runs 13 params → 200
GET
/repos/{owner}/{repo}/environments/{environment_name}/secrets
GitHub List Environment Secrets
actions/list-environment-secrets 5 params → 200
GET
/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key
GitHub Get an Environment Public Key
actions/get-environment-public-key 3 params → 200
GET
/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}
GitHub Get an Environment Secret
actions/get-environment-secret 4 params → 200
PUT
/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}
GitHub Create or Update an Environment Secret
actions/create-or-update-environment-secret 4 params body → 201204
DELETE
/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}
GitHub Delete an Environment Secret
actions/delete-environment-secret 4 params → 204
GET
/repos/{owner}/{repo}/environments/{environment_name}/variables
GitHub List Environment Variables
actions/list-environment-variables 5 params → 200
POST
/repos/{owner}/{repo}/environments/{environment_name}/variables
GitHub Create an Environment Variable
actions/create-environment-variable 3 params body → 201
GET
/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}
GitHub Get an Environment Variable
actions/get-environment-variable 4 params → 200
PATCH
/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}
GitHub Update an Environment Variable
actions/update-environment-variable 4 params body → 204
DELETE
/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}
GitHub Delete an Environment Variable
actions/delete-environment-variable 4 params → 204

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), minimal-repository (87 properties), workflow-run (36 properties), job (23 properties). Each schema is shown below with its type and property counts.

workflow-run
object
An invocation of a workflow
36 properties 26 required
actions-secret
object
Set secrets for GitHub Actions.
3 properties 3 required
allowed-actions
string
The permissions policy that controls the actions that are allowed to run.
actions-organization-permissions
object
4 properties 1 required
selected-actions
object
2 properties 2 required
runner
object
A self hosted runner
7 properties 6 required
runner-label
object
A label for a self hosted runner
3 properties 1 required
environment-approvals
object
An entry in the reviews log for environment deployments
4 properties 4 required
actions-workflow-access-to-repository
object
1 property 1 required
pull-request-minimal
object
5 properties 5 required
actions-cache-usage-by-repository
object
GitHub Actions Cache Usage by repository.
3 properties 3 required
nullable-simple-user
objectnull
A GitHub user.
21 properties 18 required
authentication-token
object
Authentication Token
6 properties 2 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties 11 required
actions-enabled
boolean
Whether GitHub Actions is enabled on the repository.
runner-groups-org
object
12 properties 7 required
scim-error
object
Scim Error
6 properties
actions-can-approve-pull-request-reviews
boolean
Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.
deployment-reviewer-type
string
The type of reviewer.
organization-actions-variable
object
Organization variable for GitHub Actions.
6 properties 5 required
actions-cache-list
object
Repository actions caches
2 properties 2 required
nullable-team-simple
objectnull
Groups of organization members that gives permissions on specified repositories.
12 properties 10 required
empty-object
object
An object without any properties.
nullable-simple-commit
objectnull
A commit.
6 properties 6 required
actions-cache-usage-policy-enterprise
object
GitHub Actions cache usage policy for an enterprise.
2 properties
nullable-license-simple
objectnull
License Simple
6 properties 5 required
actions-set-default-workflow-permissions
object
2 properties
pending-deployment
object
Details of a deployment that is waiting for protection rules to pass
5 properties 5 required
actions-public-key
object
The public key used for setting Actions Secrets.
6 properties 2 required
actions-get-default-workflow-permissions
object
2 properties 2 required
code-of-conduct
object
Code Of Conduct
5 properties 4 required
minimal-repository
object
Minimal Repository
87 properties 46 required
security-and-analysis
objectnull
3 properties
actions-default-workflow-permissions
string
The default workflow permissions granted to the GITHUBTOKEN when running workflows.
referenced-workflow
object
A workflow referenced/reused by the initial caller workflow
3 properties 2 required
enabled-repositories
string
The policy that controls the repositories in the organization that are allowed to run GitHub Actions.
workflow
object
A GitHub Actions workflow
11 properties 10 required
actions-repository-permissions
object
3 properties 1 required
job
object
Information of a job execution in a workflow run
23 properties 21 required
actions-cache-usage-org-enterprise
object
2 properties 2 required
deployment
object
A request for a specific ref(branch,sha,tag) to be deployed
18 properties 14 required
runner-application
object
Runner Application
6 properties 4 required
actions-cache-usage-policy-for-repository
object
GitHub Actions cache usage policy for repository.
1 property 1 required
oidc-custom-sub-repo
object
Actions OIDC subject customization for a repository
2 properties 1 required
validation-error-simple
object
Validation Error Simple
3 properties 2 required
organization-actions-secret
object
Secrets for GitHub Actions for an organization.
5 properties 4 required
simple-user
object
A GitHub user.
21 properties 18 required
nullable-integration
objectnull
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties 11 required
repository
object
A repository on GitHub.
95 properties 73 required
basic-error
object
Basic Error
4 properties
selected-actions-url
string
The API URL to use to get or set the actions that are allowed to run, when allowedactions is set to selected.
actions-variable
object
4 properties 4 required
artifact
object
An artifact
11 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-actions-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Actions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.