Set default workflow permissions for a repository | GitHub API (unofficial showcase)

2 parameters · 2 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.

default_workflow_permissionsstringoptional

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

Allowed:readwrite

can_approve_pull_request_reviewsbooleanoptional

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

2 status codes

204Success response

409Conflict response when changing a setting is prevented by the owning organization

Error handling

A 409 is returned: Conflict response when changing a setting is prevented by the owning organization.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.workflow.update({
  owner: "octocat",
  repo: "hello-world",
  defaultWorkflowPermissions: "example",
  canApprovePullRequestReviews: true,
});

Request

Response

Errors