Set GitHub Actions permissions for a repository

2 parameters · 3 body fields

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

enabledbooleanrequired

Whether GitHub Actions is enabled on the repository.

allowed_actionsstringoptional

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

Allowed:alllocal_onlyselected

sha_pinning_requiredbooleanoptional

Whether actions must be pinned to a full-length commit SHA.

1 status code

204Response

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.permissions.update({
  owner: "octocat",
  repo: "hello-world",
  enabled: true,
  allowedActions: "example",
  shaPinningRequired: "6dcb09b5b5",
});