APIs.io Engineering Platform Actions API

Endpoints to manage GitHub Actions using the REST API.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 137 operations across 85 paths, and defines 53 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

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

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Actions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform Get default workflow permissions for an enterprise

actions/get-github-actions-default-workflow-permissions-enterprise 1 param → 200

PUT

/enterprises/{enterprise}/actions/permissions/workflow

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform Get GitHub Actions permissions for an organization

actions/get-github-actions-permissions-organization 1 param → 200

PUT

/orgs/{org}/actions/permissions

APIs.io Engineering Platform Set GitHub Actions permissions for an organization

actions/set-github-actions-permissions-organization 1 param body → 204

GET

/orgs/{org}/actions/permissions/repositories

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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

APIs.io Engineering Platform Get allowed actions for an organization

actions/get-allowed-actions-organization 1 param → 200

PUT

/orgs/{org}/actions/permissions/selected-actions

APIs.io Engineering Platform Set allowed actions for an organization

actions/set-allowed-actions-organization 1 param body → 204

GET

/orgs/{org}/actions/permissions/workflow

APIs.io Engineering Platform Get default workflow permissions for an organization

actions/get-github-actions-default-workflow-permissions-organization 1 param → 200

PUT

/orgs/{org}/actions/permissions/workflow

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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

APIs.io Engineering Platform List self-hosted runners for an organization

actions/list-self-hosted-runners-for-org 3 params → 200

GET

/orgs/{org}/actions/runners/downloads

APIs.io Engineering Platform List runner applications for an organization

actions/list-runner-applications-for-org 1 param → 200

POST

/orgs/{org}/actions/runners/registration-token

APIs.io Engineering Platform Create a registration token for an organization

actions/create-registration-token-for-org 1 param → 201

POST

/orgs/{org}/actions/runners/remove-token

APIs.io Engineering Platform Create a remove token for an organization

actions/create-remove-token-for-org 1 param → 201

GET

/orgs/{org}/actions/runners/{runner_id}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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

APIs.io Engineering Platform List organization secrets

actions/list-org-secrets 3 params → 200

GET

/orgs/{org}/actions/secrets/public-key

APIs.io Engineering Platform Get an organization public key

actions/get-org-public-key 1 param → 200

GET

/orgs/{org}/actions/secrets/{secret_name}

APIs.io Engineering Platform Get an organization secret

actions/get-org-secret 2 params → 200

PUT

/orgs/{org}/actions/secrets/{secret_name}

APIs.io Engineering Platform Create or update an organization secret

actions/create-or-update-org-secret 2 params body → 201204

DELETE

/orgs/{org}/actions/secrets/{secret_name}

APIs.io Engineering Platform Delete an organization secret

actions/delete-org-secret 2 params → 204

GET

/orgs/{org}/actions/secrets/{secret_name}/repositories

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform Remove selected repository from an organization secret

actions/remove-selected-repo-from-org-secret 3 params → 204409

GET

/orgs/{org}/actions/variables

APIs.io Engineering Platform List organization variables

actions/list-org-variables 3 params → 200

POST

/orgs/{org}/actions/variables

APIs.io Engineering Platform Create an organization variable

actions/create-org-variable 1 param body → 201

GET

/orgs/{org}/actions/variables/{name}

APIs.io Engineering Platform Get an organization variable

actions/get-org-variable 2 params → 200

PATCH

/orgs/{org}/actions/variables/{name}

APIs.io Engineering Platform Update an organization variable

actions/update-org-variable 2 params body → 204

DELETE

/orgs/{org}/actions/variables/{name}

APIs.io Engineering Platform Delete an organization variable

actions/delete-org-variable 2 params → 204

GET

/orgs/{org}/actions/variables/{name}/repositories

APIs.io Engineering Platform List selected repositories for an organization variable

actions/list-selected-repos-for-org-variable 4 params → 200409

PUT

/orgs/{org}/actions/variables/{name}/repositories

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform Remove selected repository from an organization variable

actions/remove-selected-repo-from-org-variable 3 params → 204409

GET

/repos/{owner}/{repo}/actions/artifacts

APIs.io Engineering Platform List artifacts for a repository

actions/list-artifacts-for-repo 5 params → 200

GET

/repos/{owner}/{repo}/actions/artifacts/{artifact_id}

APIs.io Engineering Platform Get an artifact

actions/get-artifact 3 params → 200

DELETE

/repos/{owner}/{repo}/actions/artifacts/{artifact_id}

APIs.io Engineering Platform Delete an artifact

actions/delete-artifact 3 params → 204

GET

/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}

APIs.io Engineering Platform Download an artifact

actions/download-artifact 4 params → 302410

GET

/repos/{owner}/{repo}/actions/cache/usage

APIs.io Engineering Platform Get GitHub Actions cache usage for a repository

actions/get-actions-cache-usage 2 params → 200

GET

/repos/{owner}/{repo}/actions/cache/usage-policy

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform List GitHub Actions caches for a repository

actions/get-actions-cache-list 8 params → 200

DELETE

/repos/{owner}/{repo}/actions/caches

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform Set the customization template for an OIDC subject claim for a repository

actions/set-custom-oidc-sub-claim-for-repo 2 params body → 201404400422

GET

/repos/{owner}/{repo}/actions/organization-secrets

APIs.io Engineering Platform List repository organization secrets

actions/list-repo-organization-secrets 4 params → 200

GET

/repos/{owner}/{repo}/actions/organization-variables

APIs.io Engineering Platform List repository organization variables

actions/list-repo-organization-variables 4 params → 200

GET

/repos/{owner}/{repo}/actions/permissions

APIs.io Engineering Platform Get GitHub Actions permissions for a repository

actions/get-github-actions-permissions-repository 2 params → 200

PUT

/repos/{owner}/{repo}/actions/permissions

APIs.io Engineering Platform Set GitHub Actions permissions for a repository

actions/set-github-actions-permissions-repository 2 params body → 204

GET

/repos/{owner}/{repo}/actions/permissions/access

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform Get allowed actions for a repository

actions/get-allowed-actions-repository 2 params → 200

PUT

/repos/{owner}/{repo}/actions/permissions/selected-actions

APIs.io Engineering Platform Set allowed actions for a repository

actions/set-allowed-actions-repository 2 params body → 204

GET

/repos/{owner}/{repo}/actions/permissions/workflow

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform List self-hosted runners for a repository

actions/list-self-hosted-runners-for-repo 4 params → 200

GET

/repos/{owner}/{repo}/actions/runners/downloads

APIs.io Engineering Platform List runner applications for a repository

actions/list-runner-applications-for-repo 2 params → 200

POST

/repos/{owner}/{repo}/actions/runners/registration-token

APIs.io Engineering Platform Create a registration token for a repository

actions/create-registration-token-for-repo 2 params → 201

POST

/repos/{owner}/{repo}/actions/runners/remove-token

APIs.io Engineering Platform Create a remove token for a repository

actions/create-remove-token-for-repo 2 params → 201

GET

/repos/{owner}/{repo}/actions/runners/{runner_id}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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}

APIs.io Engineering Platform 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

APIs.io Engineering Platform List workflow runs for a repository

actions/list-workflow-runs-for-repo 12 params → 200

GET

/repos/{owner}/{repo}/actions/runs/{run_id}

APIs.io Engineering Platform Get a workflow run

actions/get-workflow-run 4 params → 200

DELETE

/repos/{owner}/{repo}/actions/runs/{run_id}

APIs.io Engineering Platform Delete a workflow run

actions/delete-workflow-run 3 params → 204

GET

/repos/{owner}/{repo}/actions/runs/{run_id}/approvals

APIs.io Engineering Platform 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

APIs.io Engineering Platform List workflow run artifacts

actions/list-workflow-run-artifacts 6 params → 200

GET

/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform Download workflow run attempt logs

actions/download-workflow-run-attempt-logs 4 params → 302

POST

/repos/{owner}/{repo}/actions/runs/{run_id}/cancel

APIs.io Engineering Platform Cancel a workflow run

actions/cancel-workflow-run 3 params → 202409

GET

/repos/{owner}/{repo}/actions/runs/{run_id}/jobs

APIs.io Engineering Platform List jobs for a workflow run

actions/list-jobs-for-workflow-run 6 params → 200

GET

/repos/{owner}/{repo}/actions/runs/{run_id}/logs

APIs.io Engineering Platform Download workflow run logs

actions/download-workflow-run-logs 3 params → 302

DELETE

/repos/{owner}/{repo}/actions/runs/{run_id}/logs

APIs.io Engineering Platform Delete workflow run logs

actions/delete-workflow-run-logs 3 params → 204403500

GET

/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments

APIs.io Engineering Platform 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

APIs.io Engineering Platform 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

APIs.io Engineering Platform Re-run a workflow

actions/re-run-workflow 3 params body → 201

POST

/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs

APIs.io Engineering Platform Re-run failed jobs from a workflow run

actions/re-run-workflow-failed-jobs 3 params body → 201

GET

/repos/{owner}/{repo}/actions/secrets

APIs.io Engineering Platform List repository secrets

actions/list-repo-secrets 4 params → 200

GET

/repos/{owner}/{repo}/actions/secrets/public-key

APIs.io Engineering Platform Get a repository public key

actions/get-repo-public-key 2 params → 200

GET

/repos/{owner}/{repo}/actions/secrets/{secret_name}

APIs.io Engineering Platform Get a repository secret

actions/get-repo-secret 3 params → 200

PUT

/repos/{owner}/{repo}/actions/secrets/{secret_name}

APIs.io Engineering Platform Create or update a repository secret

actions/create-or-update-repo-secret 3 params body → 201204

DELETE

/repos/{owner}/{repo}/actions/secrets/{secret_name}

APIs.io Engineering Platform Delete a repository secret

actions/delete-repo-secret 3 params → 204

GET

/repos/{owner}/{repo}/actions/variables

APIs.io Engineering Platform List repository variables

actions/list-repo-variables 4 params → 200

POST

/repos/{owner}/{repo}/actions/variables

APIs.io Engineering Platform Create a repository variable

actions/create-repo-variable 2 params body → 201

GET

/repos/{owner}/{repo}/actions/variables/{name}

APIs.io Engineering Platform Get a repository variable

actions/get-repo-variable 3 params → 200

PATCH

/repos/{owner}/{repo}/actions/variables/{name}

APIs.io Engineering Platform Update a repository variable

actions/update-repo-variable 3 params body → 204

DELETE

/repos/{owner}/{repo}/actions/variables/{name}

APIs.io Engineering Platform Delete a repository variable

actions/delete-repo-variable 3 params → 204

GET

/repos/{owner}/{repo}/actions/workflows

APIs.io Engineering Platform List repository workflows

actions/list-repo-workflows 4 params → 200

GET

/repos/{owner}/{repo}/actions/workflows/{workflow_id}

APIs.io Engineering Platform Get a workflow

actions/get-workflow 3 params → 200

PUT

/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable

APIs.io Engineering Platform Disable a workflow

actions/disable-workflow 3 params → 204

POST

/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches

APIs.io Engineering Platform Create a workflow dispatch event

actions/create-workflow-dispatch 3 params body → 204

PUT

/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable

APIs.io Engineering Platform Enable a workflow

actions/enable-workflow 3 params → 204

GET

/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs

APIs.io Engineering Platform List workflow runs for a workflow

actions/list-workflow-runs 13 params → 200

GET

/repos/{owner}/{repo}/environments/{environment_name}/secrets

APIs.io Engineering Platform List environment secrets

actions/list-environment-secrets 5 params → 200

GET

/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key

APIs.io Engineering Platform Get an environment public key

actions/get-environment-public-key 3 params → 200

GET

/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}

APIs.io Engineering Platform Get an environment secret

actions/get-environment-secret 4 params → 200

PUT

/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}

APIs.io Engineering Platform 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}

APIs.io Engineering Platform Delete an environment secret

actions/delete-environment-secret 4 params → 204

GET

/repos/{owner}/{repo}/environments/{environment_name}/variables

APIs.io Engineering Platform List environment variables

actions/list-environment-variables 5 params → 200

POST

/repos/{owner}/{repo}/environments/{environment_name}/variables

APIs.io Engineering Platform Create an environment variable

actions/create-environment-variable 3 params body → 201

GET

/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}

APIs.io Engineering Platform Get an environment variable

actions/get-environment-variable 4 params → 200

PATCH

/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}

APIs.io Engineering Platform Update an environment variable

actions/update-environment-variable 4 params body → 204

DELETE

/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}

APIs.io Engineering Platform 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.

nullable-simple-user

object

A GitHub user.

21 properties 18 required

repository

object

A repository on GitHub.

95 properties 73 required

actions-workflow-access-to-repository

object

1 property 1 required

environment-approvals

object

An entry in the reviews log for environment deployments

4 properties 4 required

runner-label

object

A label for a self hosted runner

3 properties 1 required

nullable-simple-commit

object

A commit.

6 properties 6 required

oidc-custom-sub-repo

object

Actions OIDC subject customization for a repository

2 properties 1 required

team

object

Groups of organization members that gives permissions on specified repositories.

13 properties 11 required

actions-can-approve-pull-request-reviews

boolean

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

runner-application

object

Runner Application

6 properties 4 required

actions-secret

object

Set secrets for GitHub Actions.

3 properties 3 required

actions-organization-permissions

object

4 properties 1 required

security-and-analysis

object

3 properties

actions-set-default-workflow-permissions

object

2 properties

workflow-run

object

An invocation of a workflow

36 properties 26 required

actions-enabled

boolean

Whether GitHub Actions is enabled on the repository.

code-of-conduct

object

Code Of Conduct

5 properties 4 required

basic-error

object

Basic Error

4 properties

artifact

object

An artifact

11 properties 10 required

authentication-token

object

Authentication Token

6 properties 2 required

scim-error

object

Scim Error

6 properties

minimal-repository

object

Minimal Repository

87 properties 46 required

workflow

object

A GitHub Actions workflow

11 properties 10 required

organization-actions-variable

object

Organization variable for GitHub Actions.

6 properties 5 required

deployment

object

A request for a specific ref(branch,sha,tag) to be deployed

18 properties 14 required

job

object

Information of a job execution in a workflow run

23 properties 21 required

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.

validation-error-simple

object

Validation Error Simple

3 properties 2 required

actions-default-workflow-permissions

string

The default workflow permissions granted to the GITHUBTOKEN when running workflows.

allowed-actions

string

The permissions policy that controls the actions that are allowed to run.

deployment-reviewer-type

string

The type of reviewer.

actions-cache-usage-by-repository

object

GitHub Actions Cache Usage by repository.

3 properties 3 required

referenced-workflow

object

A workflow referenced/reused by the initial caller workflow

3 properties 2 required

actions-cache-usage-policy-for-repository

object

GitHub Actions cache usage policy for repository.

1 property 1 required

enabled-repositories

string

The policy that controls the repositories in the organization that are allowed to run GitHub Actions.

actions-repository-permissions

object

3 properties 1 required

pull-request-minimal

object

5 properties 5 required

actions-variable

object

4 properties 4 required

nullable-integration

object

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

runner

object

A self hosted runner

7 properties 6 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

actions-get-default-workflow-permissions

object

2 properties 2 required

actions-cache-usage-policy-enterprise

object

GitHub Actions cache usage policy for an enterprise.

2 properties

runner-groups-org

object

12 properties 7 required

empty-object

object

An object without any properties.

nullable-team-simple

object

Groups of organization members that gives permissions on specified repositories.

12 properties 10 required

actions-public-key

object

The public key used for setting Actions Secrets.

6 properties 2 required

actions-cache-list

object

Repository actions caches

2 properties 2 required

nullable-license-simple

object

License Simple

6 properties 5 required

selected-actions

object

2 properties 2 required

actions-cache-usage-org-enterprise

object

2 properties 2 required

pending-deployment

object

Details of a deployment that is waiting for protection rules to pass

5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Actions

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Actions API

Metadata

Authentication & Security 1

Paths & Operations 137

Schemas 53

Specification

Source

API Details

Provider

Explore more