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

Set default workflow permissions for a repository

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions can submit approving pull request reviews. For more information, see "Setting the permissions of the GITHUB_TOKEN for your repository."

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

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 "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.workflow.update({
  owner: "octocat",
  repo: "hello-world",
  defaultWorkflowPermissions: "example",
  canApprovePullRequestReviews: true,
});

Request

Response

Errors