Skip to content
forgit api docs

Set private repo fork PR workflow settings for a repository

PUT
/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos

Sets the settings for whether workflows from fork pull requests can run on a private repository.

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

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

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

repo
required
string

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

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
run_workflows_from_fork_pull_requests
required

Whether workflows triggered by pull requests from forks are allowed to run on private repositories.

boolean
send_write_tokens_to_workflows

Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request.

boolean
send_secrets_and_variables

Whether to make secrets and variables available to workflows triggered by pull requests from forks.

boolean
require_approval_for_fork_pr_workflows

Whether workflows triggered by pull requests from forks require approval from a repository administrator to run.

boolean
Examples
Example default 
{
  "run_workflows_from_fork_pull_requests": true,
  "send_write_tokens_to_workflows": false,
  "send_secrets_and_variables": false,
  "require_approval_for_fork_pr_workflows": true
}

Responses

Section titled “ Responses ”

204

Section titled “ 204 ”

Empty response for successful settings update

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Section titled “ 422 ”

Validation failed, or the endpoint has been spammed.

Media type application/json
Validation Error

Validation Error

object
message
required
string
documentation_url
required
string
errors
Array<object>
object
resource
string
field
string
message
string
code
required
string
index
integer
value
One of:
string
nullable
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}