Get private repo fork PR workflow settings for a repository

2 parameters

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.

3 status codes

200Response

run_workflows_from_fork_pull_requestsbooleanrequired

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

send_write_tokens_to_workflowsbooleanrequired

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

send_secrets_and_variablesbooleanrequired

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

require_approval_for_fork_pr_workflowsbooleanrequired

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

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found.

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.forkPrWorkflowsPrivateRepos.list({
  owner: "octocat",
  repo: "hello-world",
});

{
  "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
}

Request

Response

Errors